7 releases
0.3.3+v4.0.0 | Sep 11, 2021 |
---|---|
0.3.1+v4.0.0 | Aug 5, 2021 |
0.2.44 | Jun 21, 2021 |
0.1.40 | Jun 13, 2021 |
#121 in #texture
46 downloads per month
Used in 3 crates
(2 directly)
13MB
180K
SLoC
libktx-rs
A library for reading, writing and transcoding Khronos Textures (KTX1 and KTX2) in Rust.
This repository contains both high-level Rust bindings and low-level FFI to KhronosGroup/KTX-Software.
Structure
- libktx-rs contains the high-level Rust wrapper.
- libktx-rs-sys contains the low-level C FFI, and it builds KTX-Software from source.
- libktx-rs-macros contains helpers for testing.
Docs
See https://docs.rs/libktx-rs for the latest documentation of the high-level API, and https://docs.rs/libktx-rs-sys for the low-level FFI.
Building and features
Clone this root repository and all git submodule (git clone --recursive https://github.com/UberLambda/libktx-rs
), then run cargo build
.
Image writing
To enable KTX image writing support (which is already enabled in the default feature set), enable the libktx-rs/write
feature.
Image-based tests
To enable image loading tests, clone the libktx-rs-sys/KTX-Software submodule with git LFS support, then enable the libktx-rs-sys/test-images
feature.
rust-bindgen at build time
To have rust-bindgen generate bindings in the build script (instead of using the pre-generated ones),
enable the libktx-rs-sys/run-bindgen
feature.
Docs-only
To skip building or linking KTX-Software altogether, enable the libktx-rs-sys/docs-only
feature.
License
This Rust wrapper, and the KTX-Software library itself, are both licensed under the Apache-2.0 license.
Linux and GCC
Note that the library links to libstdc++, which is licensed under LGPL with the "Runtime Library Exception".
License exception
If the ETC decoder is enabled, the build will contain a proprietary source code file by Ericsson - KTX-Software/lib/etcdec.cxx!
Building this file is optional, and it is disabled by default.
Build libktx-rs-sys with the nonfree-etc-unpack
to enable this feature if you agree with the terms of the license.
See the original LICENSE for more information.