Struct libktx_rs::texture::Texture

pub struct Texture<'a> { /* fields omitted */ }

A KTX (1 or 2) texture.

This wraps both a sys::ktxTexture handle, and the TextureSource it was created from.

Implementations

impl<'a> Texture<'a>

pub fn new<S>(source: S) -> Result<Self, KtxError> where
    S: TextureSource<'a>, 

Attempts to create a new texture, consuming the given TextureSource.

pub fn write_to<T: TextureSink>(&self, sink: &mut T) -> Result<(), KtxError>

Attempts to write the texture (in its native format, either KTX1 or KTX2) to sink.

pub fn handle(&self) -> *mut ktxTexture

Returns the pointer to the (C-allocated) underlying sys::ktxTexture.

SAFETY: Pointers are harmless. Dereferencing them is not!

pub fn data_size(&self) -> usize

Returns the total size of image data, in bytes.

pub fn data(&self) -> &[u8]

Returns a read-only view on the image data.

pub fn data_mut(&mut self) -> &mut [u8]

Returns a read-write view on the image data.

pub fn row_pitch(&self, level: u32) -> usize

Returns the pitch (in bytes) of an image row at the specified image level.
This is rounded up to 1 if needed.

pub fn element_size(&self) -> usize

Returns the size (in bytes) of an element of the image.

pub fn get_image_offset(
    &self,
    level: u32,
    layer: u32,
    slice: u32
) -> Result<usize, KtxError>

Attempts to return the offset (in bytes) into Self::data for the image at the given mip level, array layer, and slice.
slice is either a cubemap’s face or a 3D texture’s depth slice.

pub fn get_data_size_uncompressed(&self) -> Result<usize, KtxError>

Attempts to return the size (in bytes) of the uncompressed image data.

pub fn get_image_size(&self, level: u32) -> Result<usize, KtxError>

Attempts to return the size (in bytes) of a certain mip level.

pub fn load_image_data(&self) -> Result<(), KtxError>

Attempts to [re]load this image’s data to its internal buffer. Also see Self::data().

Creating the image with [enums::TextureCreateFlags::LOAD_IMAGE_DATA] performs this step automatically on load.

pub fn iterate_levels<F>(&self, callback: F) -> Result<(), KtxError> where
    F: FnMut(i32, i32, i32, i32, i32, &[u8]) -> Result<(), KtxError>, 

Attempts to iterate all mip levels of the image, and all faces of cubemaps. This calls

callback(miplevel: i32, face: i32, width: i32, height: i32, depth: i32, pixel_data: &[u8]) -> Result<(), KtxError>

for each level/face. The image data passed to the callback is immutable. Note that image data should already have been loaded (see Self::load_image_data()).

pub fn iterate_levels_mut<F>(&mut self, callback: F) -> Result<(), KtxError> where
    F: FnMut(i32, i32, i32, i32, i32, &mut [u8]) -> Result<(), KtxError>, 

Attempts to iterate all mip levels of the image, and all faces of cubemaps. This calls

callback(miplevel: i32, face: i32, width: i32, height: i32, depth: i32, pixel_data: &mut [u8]) -> Result<(), KtxError>

for each level/face. The image data passed to the callback is mutable. Note that image data should already have been loaded (see Self::load_image_data()).

pub fn ktx1<'b>(&'b mut self) -> Option<Ktx1<'b, 'a>>

If this Texture really is a KTX1, returns KTX1-specific functionalities for it.

pub fn ktx2<'b>(&'b mut self) -> Option<Ktx2<'b, 'a>>

If this Texture really is a KTX2, returns KTX2-specific functionalities for it.

Trait Implementations

impl<'a> Drop for Texture<'a>

fn drop(&mut self)

Executes the destructor for this type.