Struct ktx::read::KtxDecoder[−][src]

pub struct KtxDecoder<R> { /* fields omitted */ }

Expand description

KTX texture storage format reader. Useful when reading from a file and/or compressed data. Provides KtxInfo.

Example

use ktx::*;
let mut decoder = ktx::Decoder::new(buf_reader)?;

assert_eq!(decoder.pixel_width(), 260);
let texture_levels: Vec<Vec<u8>> = decoder.read_textures().collect();

Implementations

[src]

impl<R: Read> KtxDecoder<R>

[src]

pub fn new(data: R) -> Result<Self>

Reads KTX header data and returns a KtxDecoder.

[src]

pub fn read_textures(self) -> Textures<R>ⓘ
Notable traits for Textures<R>
`impl<R: Read> Iterator for Textures<R> type Item = Vec<u8>;`

Consumes the KtxDecoder to returns an iterator reading texture levels starting at level 0.

Returns KtxHeader. Useful if this info is desired after consuming the KtxDecoder.

Example

let ktx_header = decoder.header();
assert_eq!(ktx_header.pixel_width(), 260);

Trait Implementations

[src]

impl<R> AsRef<KtxHeader> for KtxDecoder<R>

[src]

fn as_ref(&self) -> &KtxHeader

Performs the conversion.

[src]

impl<R: Clone> Clone for KtxDecoder<R>

[src]

fn clone(&self) -> KtxDecoder<R>

Returns a copy of the value. Read more

1.0.0[src]

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

[src]

impl<R> Debug for KtxDecoder<R>

[src]

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

[src]

impl<R: Copy> Copy for KtxDecoder<R>

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

[src]

impl<T> Any for T where
T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<T> Borrow<T> for T where
T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T, U> Into for T where
U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<T> KtxInfo for T where
T: AsRef<KtxHeader>,

[src]

pub fn big_endian(&Self) -> bool

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

[src]

pub fn gl_type(&Self) -> u32

For compressed textures, glType must equal 0. For uncompressed textures, glType specifies the type parameter passed to glTex{,Sub}Image*D, usually one of the values from table 8.2 of the OpenGL 4.4 specification OPENGL44 (UNSIGNED_BYTE, UNSIGNED_SHORT_5_6_5, etc.) Read more

[src]

pub fn gl_type_size(&Self) -> u32

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

[src]

pub fn gl_format(&Self) -> u32

For compressed textures, glFormat must equal 0. For uncompressed textures, glFormat specifies the format parameter passed to glTex{,Sub}Image*D, usually one of the values from table 8.3 of the OpenGL 4.4 specification OPENGL44 (RGB, RGBA, BGRA, etc.) Read more

[src]

pub fn gl_internal_format(&Self) -> u32

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

[src]

pub fn gl_base_internal_format(&Self) -> u32

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

[src]

pub fn pixel_width(&Self) -> u32

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

[src]

pub fn pixel_height(&Self) -> u32

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

[src]

pub fn pixel_depth(&Self) -> u32

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

[src]

pub fn array_elements(&Self) -> u32

numberOfArrayElements specifies the number of array elements. If the texture is not an array texture, numberOfArrayElements must equal 0. Read more

[src]

pub fn faces(&Self) -> u32

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

[src]

pub fn mipmap_levels(&Self) -> u32

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

[src]

pub fn bytes_of_key_value_data(&Self) -> u32

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

[src]

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

[src]

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

[src]

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

[src]

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

[src]

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct ktx::read::KtxDecoder[−][src]

Example

Implementations

impl<R: Read> KtxDecoder<R>

pub fn new(data: R) -> Result<Self>

pub fn read_textures(self) -> Textures<R>ⓘNotable traits for Textures<R>impl<R: Read> Iterator for Textures<R> type Item = Vec<u8>;

pub fn header(&self) -> KtxHeader

Example

Trait Implementations

impl<R> AsRef<KtxHeader> for KtxDecoder<R>

fn as_ref(&self) -> &KtxHeader

impl<R: Clone> Clone for KtxDecoder<R>

fn clone(&self) -> KtxDecoder<R>

fn clone_from(&mut self, source: &Self)

impl<R> Debug for KtxDecoder<R>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

impl<R: Copy> Copy for KtxDecoder<R>

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

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> KtxInfo for T where T: AsRef<KtxHeader>,

pub fn big_endian(&Self) -> bool

pub fn gl_type(&Self) -> u32

pub fn gl_type_size(&Self) -> u32

pub fn gl_format(&Self) -> u32

pub fn gl_internal_format(&Self) -> u32

pub fn gl_base_internal_format(&Self) -> u32

pub fn pixel_width(&Self) -> u32

pub fn pixel_height(&Self) -> u32

pub fn pixel_depth(&Self) -> u32

pub fn array_elements(&Self) -> u32

pub fn faces(&Self) -> u32

pub fn mipmap_levels(&Self) -> u32

pub fn bytes_of_key_value_data(&Self) -> u32

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn read_textures(self) -> Textures<R>ⓘ
Notable traits for Textures<R>
`impl<R: Read> Iterator for Textures<R> type Item = Vec<u8>;`

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,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> KtxInfo for T where
T: AsRef<KtxHeader>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,