Enum TexFormat 

pub enum TexFormat {
    R8Unorm,
    R8Snorm,
    A8Unorm,
    Rg8Unorm,
    Rg8Snorm,
    Rgba8Unorm,
    Rgba8Snorm,
    Bgra8Unorm,
    Bgrx8Unorm,
    B5g6r5Unorm,
    B5g5r5a1Unorm,
    B4g4r4a4Unorm,
    Rgb10a2Unorm,
    R16Unorm,
    R16Float,
    Rg16Unorm,
    Rg16Snorm,
    Rg16Float,
    Rgba16Unorm,
    Rgba16Float,
    R32Float,
    Rg32Float,
    Rgba32Float,
    Bc1,
    Bc2,
    Bc3,
    Bc4Unorm,
    Bc4Snorm,
    Bc5Unorm,
    Bc5Snorm,
    Bc6hUfloat,
    Bc6hSfloat,
    Bc7,
    Etc1,
    Etc2Rgb,
    Etc2Rgba,
    Etc2RgbA1,
    EacR11Unorm,
    EacRg11Unorm,
    Astc {
        block_w: u8,
        block_h: u8,
    },
}

How a texture’s bytes are laid out.

Closed on purpose, as SurfaceClass is: a classification of every format (rgba8_exact, a decoder’s table) matches it without a wildcard, so adding a format fails to compile until each one says what it does with it.

Variants

R8Unorm

R8Snorm

A8Unorm

Rg8Unorm

Rg8Snorm

Rgba8Unorm

Rgba8Snorm

Bgra8Unorm

Bgrx8Unorm

B8G8R8X8: alpha byte ignored (decodes to 255).

B5g6r5Unorm

B5G6R5 in a little-endian u16 (blue in the low bits).

B5g5r5a1Unorm

B5G5R5A1 in a little-endian u16 (blue in the low bits, alpha the top bit).

B4g4r4a4Unorm

B4G4R4A4 in a little-endian u16.

Rgb10a2Unorm

R10G10B10A2 in a little-endian u32 (red in the low bits).

R16Unorm

R16Float

Rg16Unorm

Rg16Snorm

Rg16Float

Rgba16Unorm

Rgba16Float

R32Float

Rg32Float

Rgba32Float

Bc1

BC1 (DXT1). 3-colour blocks (c0 <= c1) decode index 3 as transparent black (D3D10).

Bc2

BC2 (DXT3): explicit 4-bit alpha.

Bc3

BC3 (DXT5): interpolated alpha.

Bc4Unorm

Bc4Snorm

Bc5Unorm

Bc5Snorm

Bc6hUfloat

Bc6hSfloat

Bc7

Etc1

Etc2Rgb

Etc2Rgba

Etc2RgbA1

EacR11Unorm

EacRg11Unorm

Astc

ASTC LDR with the given block footprint (4x4 to 12x12).

Fields

block_w: u8

block_h: u8

Implementations

impl TexFormat

pub fn block_dims(self) -> (u32, u32)

Block footprint in pixels: (1, 1) for uncompressed formats.

pub fn block_bytes(self) -> u32

Bytes per block (per pixel for uncompressed formats).

pub fn is_block_compressed(self) -> bool

pub fn level_size(self, width: u32, height: u32) -> usize

Size in bytes of one level of width x height pixels: whole blocks, at least one per axis.

pub fn checked_level_size(self, width: u32, height: u32) -> Option<usize>

TexFormat::level_size, None when it doesn’t fit in a usize (dimensions a file states).

Trait Implementations

impl Clone for TexFormat

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TexFormat

impl Debug for TexFormat

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

Formats the value using the given formatter.

impl Eq for TexFormat

impl Hash for TexFormat

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TexFormat

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for TexFormat

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for TexFormat

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for TexFormat