Enum gfx_hal::format::Format

#[repr(u32)]
pub enum Format {
    Rg4Unorm,
    Rgba4Unorm,
    Bgra4Unorm,
    R5g6b5Unorm,
    B5g6r5Unorm,
    R5g5b5a1Unorm,
    B5g5r5a1Unorm,
    A1r5g5b5Unorm,
    R8Unorm,
    R8Snorm,
    R8Uscaled,
    R8Sscaled,
    R8Uint,
    R8Sint,
    R8Srgb,
    Rg8Unorm,
    Rg8Snorm,
    Rg8Uscaled,
    Rg8Sscaled,
    Rg8Uint,
    Rg8Sint,
    Rg8Srgb,
    Rgb8Unorm,
    Rgb8Snorm,
    Rgb8Uscaled,
    Rgb8Sscaled,
    Rgb8Uint,
    Rgb8Sint,
    Rgb8Srgb,
    Bgr8Unorm,
    Bgr8Snorm,
    Bgr8Uscaled,
    Bgr8Sscaled,
    Bgr8Uint,
    Bgr8Sint,
    Bgr8Srgb,
    Rgba8Unorm,
    Rgba8Snorm,
    Rgba8Uscaled,
    Rgba8Sscaled,
    Rgba8Uint,
    Rgba8Sint,
    Rgba8Srgb,
    Bgra8Unorm,
    Bgra8Snorm,
    Bgra8Uscaled,
    Bgra8Sscaled,
    Bgra8Uint,
    Bgra8Sint,
    Bgra8Srgb,
    Abgr8Unorm,
    Abgr8Snorm,
    Abgr8Uscaled,
    Abgr8Sscaled,
    Abgr8Uint,
    Abgr8Sint,
    Abgr8Srgb,
    A2r10g10b10Unorm,
    A2r10g10b10Snorm,
    A2r10g10b10Uscaled,
    A2r10g10b10Sscaled,
    A2r10g10b10Uint,
    A2r10g10b10Sint,
    A2b10g10r10Unorm,
    A2b10g10r10Snorm,
    A2b10g10r10Uscaled,
    A2b10g10r10Sscaled,
    A2b10g10r10Uint,
    A2b10g10r10Sint,
    R16Unorm,
    R16Snorm,
    R16Uscaled,
    R16Sscaled,
    R16Uint,
    R16Sint,
    R16Sfloat,
    Rg16Unorm,
    Rg16Snorm,
    Rg16Uscaled,
    Rg16Sscaled,
    Rg16Uint,
    Rg16Sint,
    Rg16Sfloat,
    Rgb16Unorm,
    Rgb16Snorm,
    Rgb16Uscaled,
    Rgb16Sscaled,
    Rgb16Uint,
    Rgb16Sint,
    Rgb16Sfloat,
    Rgba16Unorm,
    Rgba16Snorm,
    Rgba16Uscaled,
    Rgba16Sscaled,
    Rgba16Uint,
    Rgba16Sint,
    Rgba16Sfloat,
    R32Uint,
    R32Sint,
    R32Sfloat,
    Rg32Uint,
    Rg32Sint,
    Rg32Sfloat,
    Rgb32Uint,
    Rgb32Sint,
    Rgb32Sfloat,
    Rgba32Uint,
    Rgba32Sint,
    Rgba32Sfloat,
    R64Uint,
    R64Sint,
    R64Sfloat,
    Rg64Uint,
    Rg64Sint,
    Rg64Sfloat,
    Rgb64Uint,
    Rgb64Sint,
    Rgb64Sfloat,
    Rgba64Uint,
    Rgba64Sint,
    Rgba64Sfloat,
    B10g11r11Ufloat,
    E5b9g9r9Ufloat,
    D16Unorm,
    X8D24Unorm,
    D32Sfloat,
    S8Uint,
    D16UnormS8Uint,
    D24UnormS8Uint,
    D32SfloatS8Uint,
    Bc1RgbUnorm,
    Bc1RgbSrgb,
    Bc1RgbaUnorm,
    Bc1RgbaSrgb,
    Bc2Unorm,
    Bc2Srgb,
    Bc3Unorm,
    Bc3Srgb,
    Bc4Unorm,
    Bc4Snorm,
    Bc5Unorm,
    Bc5Snorm,
    Bc6hUfloat,
    Bc6hSfloat,
    Bc7Unorm,
    Bc7Srgb,
    Etc2R8g8b8Unorm,
    Etc2R8g8b8Srgb,
    Etc2R8g8b8a1Unorm,
    Etc2R8g8b8a1Srgb,
    Etc2R8g8b8a8Unorm,
    Etc2R8g8b8a8Srgb,
    EacR11Unorm,
    EacR11Snorm,
    EacR11g11Unorm,
    EacR11g11Snorm,
    Astc4x4Unorm,
    Astc4x4Srgb,
    Astc5x4Unorm,
    Astc5x4Srgb,
    Astc5x5Unorm,
    Astc5x5Srgb,
    Astc6x5Unorm,
    Astc6x5Srgb,
    Astc6x6Unorm,
    Astc6x6Srgb,
    Astc8x5Unorm,
    Astc8x5Srgb,
    Astc8x6Unorm,
    Astc8x6Srgb,
    Astc8x8Unorm,
    Astc8x8Srgb,
    Astc10x5Unorm,
    Astc10x5Srgb,
    Astc10x6Unorm,
    Astc10x6Srgb,
    Astc10x8Unorm,
    Astc10x8Srgb,
    Astc10x10Unorm,
    Astc10x10Srgb,
    Astc12x10Unorm,
    Astc12x10Srgb,
    Astc12x12Unorm,
    Astc12x12Srgb,
    // some variants omitted
}

A format descriptor that describes the channels present in a texture or view, how they are laid out, what size they are, and how the elements of the channels are interpreted (integer, float, etc.)

Variants

Rg4UnormRgba4UnormBgra4UnormR5g6b5UnormB5g6r5UnormR5g5b5a1UnormB5g5r5a1UnormA1r5g5b5UnormR8UnormR8SnormR8UscaledR8SscaledR8UintR8SintR8SrgbRg8UnormRg8SnormRg8UscaledRg8SscaledRg8UintRg8SintRg8SrgbRgb8UnormRgb8SnormRgb8UscaledRgb8SscaledRgb8UintRgb8SintRgb8SrgbBgr8UnormBgr8SnormBgr8UscaledBgr8SscaledBgr8UintBgr8SintBgr8SrgbRgba8UnormRgba8SnormRgba8UscaledRgba8SscaledRgba8UintRgba8SintRgba8SrgbBgra8UnormBgra8SnormBgra8UscaledBgra8SscaledBgra8UintBgra8SintBgra8SrgbAbgr8UnormAbgr8SnormAbgr8UscaledAbgr8SscaledAbgr8UintAbgr8SintAbgr8SrgbA2r10g10b10UnormA2r10g10b10SnormA2r10g10b10UscaledA2r10g10b10SscaledA2r10g10b10UintA2r10g10b10SintA2b10g10r10UnormA2b10g10r10SnormA2b10g10r10UscaledA2b10g10r10SscaledA2b10g10r10UintA2b10g10r10SintR16UnormR16SnormR16UscaledR16SscaledR16UintR16SintR16SfloatRg16UnormRg16SnormRg16UscaledRg16SscaledRg16UintRg16SintRg16SfloatRgb16UnormRgb16SnormRgb16UscaledRgb16SscaledRgb16UintRgb16SintRgb16SfloatRgba16UnormRgba16SnormRgba16UscaledRgba16SscaledRgba16UintRgba16SintRgba16SfloatR32UintR32SintR32SfloatRg32UintRg32SintRg32SfloatRgb32UintRgb32SintRgb32SfloatRgba32UintRgba32SintRgba32SfloatR64UintR64SintR64SfloatRg64UintRg64SintRg64SfloatRgb64UintRgb64SintRgb64SfloatRgba64UintRgba64SintRgba64SfloatB10g11r11UfloatE5b9g9r9UfloatD16UnormX8D24UnormD32SfloatS8UintD16UnormS8UintD24UnormS8UintD32SfloatS8UintBc1RgbUnormBc1RgbSrgbBc1RgbaUnormBc1RgbaSrgbBc2UnormBc2SrgbBc3UnormBc3SrgbBc4UnormBc4SnormBc5UnormBc5SnormBc6hUfloatBc6hSfloatBc7UnormBc7SrgbEtc2R8g8b8UnormEtc2R8g8b8SrgbEtc2R8g8b8a1UnormEtc2R8g8b8a1SrgbEtc2R8g8b8a8UnormEtc2R8g8b8a8SrgbEacR11UnormEacR11SnormEacR11g11UnormEacR11g11SnormAstc4x4UnormAstc4x4SrgbAstc5x4UnormAstc5x4SrgbAstc5x5UnormAstc5x5SrgbAstc6x5UnormAstc6x5SrgbAstc6x6UnormAstc6x6SrgbAstc8x5UnormAstc8x5SrgbAstc8x6UnormAstc8x6SrgbAstc8x8UnormAstc8x8SrgbAstc10x5UnormAstc10x5SrgbAstc10x6UnormAstc10x6SrgbAstc10x8UnormAstc10x8SrgbAstc10x10UnormAstc10x10SrgbAstc12x10UnormAstc12x10SrgbAstc12x12UnormAstc12x12Srgb

Methods

impl Format

pub fn base_format(self) -> BaseFormat

Get base format.

Returns None if format is Undefined.

pub fn surface_desc(&self) -> FormatDesc

A shortcut to obtain surface format description.

pub fn is_color(self) -> bool

Returns if the format has a color aspect.

pub fn is_depth(self) -> bool

Returns if the format has a depth aspect.

pub fn is_stencil(self) -> bool

Returns if the format has a stencil aspect.

Trait Implementations

impl Clone for Format

fn clone(&self) -> Format

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for Format

fn cmp(&self, other: &Format) -> 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 PartialOrd<Format> for Format

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] 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] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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 PartialEq<Format> for Format

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Copy for Format

impl Eq for Format

impl Debug for Format

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

Formats the value using the given formatter.

impl Hash for Format

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].