Enum PixelFormatModifier 

#[repr(u64)]
pub enum PixelFormatModifier {
    DoNotCare = 72_057_594_037_927_934,
    Invalid = 72_057_594_037_927_935,
    Linear = 0,
    IntelI915XTiled = 72_057_594_037_927_937,
    IntelI915YTiled = 72_057_594_037_927_938,
    IntelI915YfTiled = 72_057_594_037_927_939,
    IntelI915YTiledCcs = 72_057_594_054_705_154,
    IntelI915YfTiledCcs = 72_057_594_054_705_155,
    ArmAfbc16X16 = 576_460_752_303_423_489,
    ArmAfbc32X8 = 576_460_752_303_423_490,
    ArmLinearTe = 576_460_752_303_427_584,
    ArmAfbc16X16Te = 576_460_752_303_427_585,
    ArmAfbc32X8Te = 576_460_752_303_427_586,
    ArmAfbc16X16YuvTiledHeader = 576_460_752_303_431_697,
    ArmAfbc16X16SplitBlockSparseYuv = 576_460_752_303_423_601,
    ArmAfbc16X16SplitBlockSparseYuvTe = 576_460_752_303_427_697,
    ArmAfbc16X16SplitBlockSparseYuvTiledHeader = 576_460_752_303_431_793,
    ArmAfbc16X16SplitBlockSparseYuvTeTiledHeader = 576_460_752_303_435_889,
    GoogleGoldfishOptimal = 7_421_932_185_906_577_409,
    UnknownOrdinal_(u64),
}

The upper 8 bits are a vendor code. The lower 56 bits are vendor-defined.

The defined PixelFormatModifier values are specific, complete, and valid values (except for INVALID and DO_NOT_CARE which have their own meanings).

Some other valid or potentially-valid pixel_format_modifier values are not defined as a PixelFormatModifier value, typically because the value isn’t used in practice (or potentially is newly used but not yet defined in PixelFormatModifier). It is permitted to specify such a value as a PixelFormatModifier value in a pixel_format_modifier field, despite the lack of corresponding defined PixelFormatModifier value. If such a value is used outside test code, please consider adding it as a defined value in PixelFormatModifier. All such values must conform to the upper 8 bits vendor code (don’t define/use values outside the/an appropriate vendor code).

The separately-defined FORMAT_MODIFIER_* uint64 values are vendor-specific bit field values, not complete valid values on their own. These uint64 values can be used to help create or interpret a PixelFormatModifier value in terms of vendor-specific bitfields.

When the pixel_format_modifier is set to a supported value (excluding DO_NOT_CARE, INVALID, LINEAR), the arrangement of pixel data otherwise specified by the pixel_format field is “modified”, typically to allow for some combination of tiling, compression (typically lossless, typically for memory bandwidth reduction not framebuffer size reduction), transaction elimination, dirt tracking, but typically not modifying the bit depth of the pixel_format. In some cases there’s a per-image or per-tile header involved, or similar. The pixel_format field often still needs to be set to a valid supported value that works in combination with the pixel_format_modifier, and that pixel_format value can also contribute to the overall meaning of the ImageFormat. In other words, the “modifier” part of the name is more accurate than “override” would be.

Variants

DoNotCare = 72_057_594_037_927_934

Invalid = 72_057_594_037_927_935

Linear = 0

IntelI915XTiled = 72_057_594_037_927_937

IntelI915YTiled = 72_057_594_037_927_938

IntelI915YfTiled = 72_057_594_037_927_939

IntelI915YTiledCcs = 72_057_594_054_705_154

IntelI915YfTiledCcs = 72_057_594_054_705_155

ArmAfbc16X16 = 576_460_752_303_423_489

ArmAfbc32X8 = 576_460_752_303_423_490

ArmLinearTe = 576_460_752_303_427_584

ArmAfbc16X16Te = 576_460_752_303_427_585

ArmAfbc32X8Te = 576_460_752_303_427_586

ArmAfbc16X16YuvTiledHeader = 576_460_752_303_431_697

ArmAfbc16X16SplitBlockSparseYuv = 576_460_752_303_423_601

ArmAfbc16X16SplitBlockSparseYuvTe = 576_460_752_303_427_697

ArmAfbc16X16SplitBlockSparseYuvTiledHeader = 576_460_752_303_431_793

ArmAfbc16X16SplitBlockSparseYuvTeTiledHeader = 576_460_752_303_435_889

GoogleGoldfishOptimal = 7_421_932_185_906_577_409

UnknownOrdinal_(u64)

Trait Implementations

impl Clone for PixelFormatModifier

fn clone(&self) -> PixelFormatModifier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PixelFormatModifier

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

Formats the value using the given formatter.

impl<'a, ___E> Encode<PixelFormatModifier, ___E> for &'a PixelFormatModifier

where ___E: ?Sized,

fn encode( self, encoder: &mut ___E, out: &mut MaybeUninit<PixelFormatModifier>, _: (), ) -> Result<(), EncodeError>

Encodes this value into an encoder and output.

const COPY_OPTIMIZATION: CopyOptimization<Self, W> = _

Whether the conversion from Self to W is equivalent to copying the raw bytes of Self.

impl<___E> Encode<PixelFormatModifier, ___E> for PixelFormatModifier

where ___E: ?Sized,

fn encode( self, encoder: &mut ___E, out: &mut MaybeUninit<PixelFormatModifier>, _: (), ) -> Result<(), EncodeError>

Encodes this value into an encoder and output.

const COPY_OPTIMIZATION: CopyOptimization<Self, W> = _

Whether the conversion from Self to W is equivalent to copying the raw bytes of Self.

impl From<PixelFormatModifier> for PixelFormatModifier

fn from(wire: PixelFormatModifier) -> PixelFormatModifier

Converts to this type from the input type.

impl From<PixelFormatModifier> for PixelFormatModifier

fn from(natural: PixelFormatModifier) -> PixelFormatModifier

Converts to this type from the input type.

impl From<u64> for PixelFormatModifier

fn from(value: u64) -> PixelFormatModifier

Converts to this type from the input type.

impl FromWire<PixelFormatModifier> for PixelFormatModifier

fn from_wire(wire: PixelFormatModifier) -> PixelFormatModifier

Converts the given owned value to this type.

const COPY_OPTIMIZATION: CopyOptimization<W, Self> = _

Whether the conversion from W to Self is equivalent to copying the raw bytes of W.

impl FromWireRef<PixelFormatModifier> for PixelFormatModifier

fn from_wire_ref(wire: &PixelFormatModifier) -> PixelFormatModifier

Converts the given reference to this type.

impl Hash for PixelFormatModifier

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

where __H: Hasher,

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 PixelFormatModifier

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

impl PartialEq for PixelFormatModifier

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for PixelFormatModifier

fn partial_cmp(&self, other: &PixelFormatModifier) -> 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 Copy for PixelFormatModifier

impl Eq for PixelFormatModifier

impl StructuralPartialEq for PixelFormatModifier