Enum gfx_core::format::SurfaceType

#[repr(u8)]
pub enum SurfaceType {
    R4_G4,
    R4_G4_B4_A4,
    R5_G5_B5_A1,
    R5_G6_B5,
    R8,
    R8_G8,
    R8_G8_B8_A8,
    R10_G10_B10_A2,
    R11_G11_B10,
    R16,
    R16_G16,
    R16_G16_B16,
    R16_G16_B16_A16,
    R32,
    R32_G32,
    R32_G32_B32,
    R32_G32_B32_A32,
    B8_G8_R8_A8,
    D16,
    D24,
    D24_S8,
    D32,
    BC1_R8_G8_B8,
    BC3_R8_G8_B8_A8,
}

Type of the allocated texture surface. It is supposed to only carry information about the number of bits per each channel. The actual types are up to the views to decide and interpret. The actual components are up to the swizzle to define.

Variants

R4_G4

R4_G4_B4_A4

R5_G5_B5_A1

R5_G6_B5

R8

R8_G8

R8_G8_B8_A8

R10_G10_B10_A2

R11_G11_B10

R16

R16_G16

R16_G16_B16

R16_G16_B16_A16

R32

R32_G32

R32_G32_B32

R32_G32_B32_A32

B8_G8_R8_A8

D16

D24

D24_S8

D32

BC1_R8_G8_B8

Block Compression 1 also known as DXT1, S3TC. See S3TC wiki.

Currently supported in the gfx_device_gl backend only.

BC3_R8_G8_B8_A8

Block Compression 3 also known as DXT5, S3TC. See S3TC wiki.

Currently supported in the gfx_device_gl backend only.

Implementations

impl SurfaceType

pub fn get_total_bits(&self) -> u8

Return the total number of bits for this format.

pub fn get_alpha_stencil_bits(&self) -> u8

Return the number of bits allocated for alpha and stencil.

Trait Implementations

impl Clone for SurfaceType

fn clone(&self) -> SurfaceType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for SurfaceType

impl Debug for SurfaceType

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

Formats the value using the given formatter.

impl Eq for SurfaceType

impl Hash for SurfaceType

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for SurfaceType

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<SurfaceType> for SurfaceType

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl PartialOrd<SurfaceType> for SurfaceType

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

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

impl StructuralEq for SurfaceType

impl StructuralPartialEq for SurfaceType