Struct ImageTexture

pub struct ImageTexture {
    pub name: Option<String>,
    pub usage: Option<TextureUsage>,
    pub width: u32,
    pub height: u32,
    pub depth: u32,
    pub view_dimension: ViewDimension,
    pub image_format: ImageFormat,
    pub mipmap_count: u32,
    pub image_data: Vec<u8>,
}

A non swizzled version of an Mibl or Mtxt texture.

Fields

name: Option<String>

An optional name assigned to some textures. This will typically be None and can not be used for reliably identifying textures.

usage: Option<TextureUsage>

Hints on how the texture is used. Actual usage is determined by the shader code.

width: u32

The width of the base mip level in pixels.

height: u32

The height of the base mip level in pixels.

depth: u32

The depth of the base mip level in pixels.

view_dimension: ViewDimension

image_format: ImageFormat

mipmap_count: u32

The number of mip levels or 1 if there are no mipmaps.

image_data: Vec<u8>

The combined image surface data in a standard row-major layout. Ordered as Layer 0 Mip 0, Layer 0 Mip 1, ... Layer L-1 Mip M-1 for L layers and M mipmaps similar to DDS files.

Implementations

impl ImageTexture

pub fn from_mibl( mibl: &Mibl, name: Option<String>, usage: Option<TextureUsage>, ) -> Result<Self, CreateImageTextureError>

Deswizzle the data from mibl.

The name is not required but creates more descriptive file names and debug information. The usage improves the accuracy of texture assignments if the shader database is not specified.

pub fn from_mtxt( mtxt: &Mtxt, name: Option<String>, usage: Option<TextureUsage>, ) -> Result<Self, CreateImageTextureError>

Deswizzle the data from mtxt.

The name is not required but creates more descriptive file names and debug information. The usage improves the accuracy of texture assignments if the shader database is not specified.

pub fn to_image(&self) -> Result<RgbaImage, CreateImageError>

Decode the first mip level for all depth slices and array layers to RGBA8.

pub fn layers(&self) -> u32

Return the number of array layers in this surface.

pub fn to_surface(&self) -> Surface<&[u8]>

Create a view of all image data in this texture to use with encode or decode operations.

pub fn to_dds(&self) -> Result<Dds, CreateDdsError>

pub fn from_surface<T: AsRef<[u8]>>( surface: Surface<T>, name: Option<String>, usage: Option<TextureUsage>, ) -> Result<Self, CreateImageTextureError>

pub fn from_dds( dds: &Dds, name: Option<String>, usage: Option<TextureUsage>, ) -> Result<Self, CreateImageTextureError>

pub fn to_mibl(&self) -> Result<Mibl, CreateMiblError>

Trait Implementations

impl Clone for ImageTexture

fn clone(&self) -> ImageTexture

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageTexture

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

Formats the value using the given formatter.

impl PartialEq for ImageTexture

fn eq(&self, other: &ImageTexture) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ImageTexture