Struct gfx_hal::format::FormatDesc

pub struct FormatDesc {
    pub bits: u16,
    pub dim: (u8, u8),
    pub packed: bool,
    pub aspects: Aspects,
}

Description of a format.

Fields

bits: u16

Total number of bits.

• Depth/Stencil formats are opaque formats, where the total number of bits is unknown. A dummy value is used for these formats instead (sum of depth and stencil bits). For copy operations, the number of bits of the corresponding aspect should be used.
• The total number can be larger than the sum of individual format bits (color, alpha, depth and stencil) for packed formats.
• For compressed formats, this denotes the number of bits per block.

dim: (u8, u8)

Dimensions (width, height) of the texel blocks.

packed: bool

The format representation depends on the endianness of the platform.

• On little-endian systems, the actual oreder of components is reverse of what a surface type specifies.

aspects: Aspects

Format aspects

Methods

impl FormatDesc

pub fn is_compressed(&self) -> bool

Check if the format is compressed.

Trait Implementations

impl Copy for FormatDesc

impl Eq for FormatDesc

impl Clone for FormatDesc

fn clone(&self) -> FormatDesc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<FormatDesc> for FormatDesc

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

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

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

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

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

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

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

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

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

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

impl PartialEq<FormatDesc> for FormatDesc

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

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

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

This method tests for !=.

impl Ord for FormatDesc

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl Hash for FormatDesc

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, 

Feeds a slice of this type into the given [Hasher].

impl Debug for FormatDesc

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

Formats the value using the given formatter.