Enum dx::platform::core::PixelFormat

#[non_exhaustive]
#[repr(u32)]
pub enum PixelFormat {
    Any,
    A8,
    Rgb565,
    Rgba4444,
    Rgba5551,
    Yuv,
    G8,
    Rg88,
    Rgb888,
    Bgr888,
    Rgba8888,
    Bgra8888,
    Argb8888,
    Abgr8888,
    Rgba1010102,
    Bgra1010102,
    Argb2101010,
    Abgr2101010,
    Rgba8888Pre,
    Bgra8888Pre,
    Argb8888Pre,
    Abgr8888Pre,
    Rgba4444Pre,
    Rgba5551Pre,
    Rgba1010102Pre,
    Bgra1010102Pre,
    Argb2101010Pre,
    Abgr2101010Pre,
    Depth16,
    Depth32,
    Depth24Stencil8,
}

Pixel formats definitions.

For the formats with a byte per component, the order of the components specify the order in increasing memory addresses. So for example PixelFormat::Rgb888 would have the red component in the lowest address, green in the next address and blue after that regardless of the endianness of the system.

For the formats with non byte aligned components the component order specifies the order within a 16-bit or 32-bit number from most significant bit to least significant. So for PixelFormat::Rgb565, the red component would be in bits 11-15, the green component would be in 6-11 and the blue component would be in 1-5. Therefore the order in memory depends on the endianness of the system.

When uploading a texture PixelFormat::Any can be used as the internal format. will try to pick the best format to use internally and convert the texture data if necessary.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Any

Any format

A8

8 bits alpha mask

Rgb565

RGB, 16 bits

Rgba4444

RGBA, 16 bits

Rgba5551

RGBA, 16 bits

Yuv

Not currently supported

G8

Single luminance component

Rg88

RG, 16 bits. Note that red-green textures are only available if FeatureID::OglFeatureIdTextureRg is advertised. See Texture::set_components for details.

Rgb888

RGB, 24 bits

Bgr888

BGR, 24 bits

Rgba8888

RGBA, 32 bits

Bgra8888

BGRA, 32 bits

Argb8888

ARGB, 32 bits

Abgr8888

ABGR, 32 bits

Rgba1010102

RGBA, 32 bits, 10 bpc

Bgra1010102

BGRA, 32 bits, 10 bpc

Argb2101010

ARGB, 32 bits, 10 bpc

Abgr2101010

ABGR, 32 bits, 10 bpc

Rgba8888Pre

Premultiplied RGBA, 32 bits

Bgra8888Pre

Premultiplied BGRA, 32 bits

Argb8888Pre

Premultiplied ARGB, 32 bits

Abgr8888Pre

Premultiplied ABGR, 32 bits

Rgba4444Pre

Premultiplied RGBA, 16 bits

Rgba5551Pre

Premultiplied RGBA, 16 bits

Rgba1010102Pre

Premultiplied RGBA, 32 bits, 10 bpc

Bgra1010102Pre

Premultiplied BGRA, 32 bits, 10 bpc

Argb2101010Pre

Premultiplied ARGB, 32 bits, 10 bpc

Abgr2101010Pre

Premultiplied ABGR, 32 bits, 10 bpc

Depth16

Depth32

Depth24Stencil8

Implementations

impl PixelFormat

pub fn bytes_per_pixel(&self) -> u32

Trait Implementations

impl Clone for PixelFormat

fn clone(&self) -> PixelFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PixelFormat

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

Formats the value using the given formatter.

impl Default for PixelFormat

fn default() -> Self

Returns the “default value” for a type.

impl Display for PixelFormat

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

Formats the value using the given formatter.

impl Hash for PixelFormat

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 Ord for PixelFormat

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

Restrict a value to a certain interval.

impl PartialEq<PixelFormat> for PixelFormat

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

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

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

This method tests for !=.

impl PartialOrd<PixelFormat> for PixelFormat

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

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

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

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

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

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

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

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

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 Copy for PixelFormat

impl Eq for PixelFormat

impl StructuralEq for PixelFormat

impl StructuralPartialEq for PixelFormat