Crate libktx_sys
source ·Expand description
Rust bindings for libktx
This crate provides Rust bindings for the libktx library.
This crate is currently in very early development and is not yet ready for production use. Each release tracks the latest stable release of libktx at the time of implementation. This may be ameliorated in the future. See Planned Features for a list of features required before I will consider this crate ready for production use.
Building
This crate inherits the dependencies of the libktx library. You will need to have the following installed alongsige the standard Rust toolchain:
- CMake
- LLVM (With the
LIBCLANG_PATHenvironment variable set) - Vulkan SDK (With the
VULKAN_SDKenvironment variable set)
Note: If you wish to change the targetted library verion or regenerate the bindings,
re-enable the bindgen feature in the Cargo.toml file. This will regenerate the
bindings.
Planned Features
- Seperate vulkan and opengl bindings through features
- Stop compiling unused libktx components
- Add proper Build testing for all platforms
- Only expose nessecary parts of the vulkan API
- Fix issues with generated documentation
- Work around need to have the vulkan SDK and LibClang installed
- Avoid regenergating bindings on every build~ (Done)
- Get generated tests working
- Build Postprocressor to clean up generated bindings. (Breaking and 1.0 release)
Crates.io Stewardship Notice
I am aware of the libktx-rs and libktx-rs-sys crates on crate.io. The source code for this library has been archived, and I am considering it abandoned. I’ll be maintaining this as a sys crate alone, with the burden of maintaining the higher level bindings left to the community.
Structs
- @memberof ktxTexture @~English @brief Structure for passing extended parameters to ktxTexture_CompressAstc.
- @memberof ktxTexture2 @~English @brief Structure for passing extended parameters to ktxTexture2_CompressBasisEx().
- @~English @brief Struct describing the logical orientation of an image.
- @~English
- @class ktxTexture @~English @brief Base class representing a texture.
- @class ktxTexture1 @~English @brief Class representing a KTX version 1 format texture.
- < Private data.
- @class ktxTexture2 @~English @brief Class representing a KTX version 2 format texture.
- < Private data.
- @memberof ktxTexture @~English @brief Structure for passing texture information to ktxTexture1_Create() and ktxTexture2_Create().
- @memberof ktxTexture @~English @brief Table of virtual ktxTexture methods.
- @class ktxVulkanDeviceInfo @~English @brief Struct for passing information about the Vulkan device on which to create images to the texture image loading functions.
- @struct ktxVulkanFunctions @~English @brief Struct for applications to pass Vulkan function pointers to the ktxTexture_VkUpload functions via a ktxVulkanDeviceInfo struct.
- @class ktxVulkanTexture @~English @brief Struct for returning information about the Vulkan texture image created by the ktxTexture_VkUpload* functions.