Struct ktx::read::KtxDecoder [−][src]
pub struct KtxDecoder<R> { /* fields omitted */ }
Expand description
Implementations
Consumes the KtxDecoder
to returns an iterator reading texture levels starting at level 0.
Trait Implementations
Auto Trait Implementations
impl<R> RefUnwindSafe for KtxDecoder<R> where
R: RefUnwindSafe,
impl<R> Send for KtxDecoder<R> where
R: Send,
impl<R> Sync for KtxDecoder<R> where
R: Sync,
impl<R> Unpin for KtxDecoder<R> where
R: Unpin,
impl<R> UnwindSafe for KtxDecoder<R> where
R: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
endianness contains the number 0x04030201 written as a 32 bit integer. If the file is little endian then this is represented as the bytes 0x01 0x02 0x03 0x04. If the file is big endian then this is represented as the bytes 0x04 0x03 0x02 0x01. When reading endianness as a 32 bit integer produces the value 0x04030201 then the endianness of the file matches the the endianness of the program that is reading the file and no conversion is necessary. When reading endianness as a 32 bit integer produces the value 0x01020304 then the endianness of the file is opposite the endianness of the program that is reading the file, and in that case the program reading the file must endian convert all header bytes and, if glTypeSize > 1, all texture data to the endianness of the program (i.e. a little endian program must convert from big endian, and a big endian program must convert to little endian). Read more
glTypeSize specifies the data type size that should be used when endianness conversion is required for the texture data stored in the file. If glType is not 0, this should be the size in bytes corresponding to glType. For texture data which does not depend on platform endianness, including compressed texture data, glTypeSize must equal 1. Read more
For compressed textures, glInternalFormat must equal the compressed internal format, usually one of the values from table 8.14 of the OpenGL 4.4 specification OPENGL44. For uncompressed textures, glInternalFormat specifies the internalformat parameter passed to glTexStorageD or glTexImageD, usually one of the sized internal formats from tables 8.12 & 8.13 of the OpenGL 4.4 specification OPENGL44. The sized format should be chosen to match the bit depth of the data provided. glInternalFormat is used when loading both compressed and uncompressed textures, except when loading into a context that does not support sized formats, such as an unextended OpenGL ES 2.0 context where the internalformat parameter is required to have the same value as the format parameter. Read more
For both compressed and uncompressed textures, glBaseInternalFormat specifies the base internal format of the texture, usually one of the values from table 8.11 of the OpenGL 4.4 specification OPENGL44 (RGB, RGBA, ALPHA, etc.). For uncompressed textures, this value will be the same as glFormat and is used as the internalformat parameter when loading into a context that does not support sized formats, such as an unextended OpenGL ES 2.0 context. Read more
The width of the texture image for level 0, in pixels. No rounding to block sizes should be applied for block compressed textures. Read more
The height of the texture image for level 0, in pixels. No rounding to block sizes should be applied for block compressed textures. Read more
The depth of the texture image for level 0, in pixels. No rounding to block sizes should be applied for block compressed textures. Read more
numberOfArrayElements specifies the number of array elements. If the texture is not an array texture, numberOfArrayElements must equal 0. Read more
numberOfFaces specifies the number of cubemap faces. For cubemaps and cubemap arrays this should be 6. For non cubemaps this should be 1. Cube map faces are stored in the order: +X, -X, +Y, -Y, +Z, -Z. Read more
numberOfMipmapLevels must equal 1 for non-mipmapped textures. For mipmapped textures, it equals the number of mipmaps. Mipmaps are stored in order from largest size to smallest size. The first mipmap level is always level 0. A KTX file does not need to contain a complete mipmap pyramid. If numberOfMipmapLevels equals 0, it indicates that a full mipmap pyramid should be generated from level 0 at load time (this is usually not allowed for compressed formats). Read more
keyAndValueByteSize is the number of bytes of combined key and value data in one key/value pair following the header. This includes the size of the key, the NUL byte terminating the key, and all the bytes of data in the value. If the value is a UTF-8 string it should be NUL terminated and the keyAndValueByteSize should include the NUL character (but code that reads KTX files must not assume that value fields are NUL terminated). keyAndValueByteSize does not include the bytes in valuePadding. Read more