Enum PixelFormatModifier

pub enum PixelFormatModifier {
    DoNotCare,
    Invalid,
    Linear,
    IntelI915XTiled,
    IntelI915YTiled,
    IntelI915YfTiled,
    IntelI915YTiledCcs,
    IntelI915YfTiledCcs,
    ArmAfbc16X16,
    ArmAfbc32X8,
    ArmLinearTe,
    ArmAfbc16X16Te,
    ArmAfbc32X8Te,
    ArmAfbc16X16YuvTiledHeader,
    ArmAfbc16X16SplitBlockSparseYuv,
    ArmAfbc16X16SplitBlockSparseYuvTe,
    ArmAfbc16X16SplitBlockSparseYuvTiledHeader,
    ArmAfbc16X16SplitBlockSparseYuvTeTiledHeader,
    GoogleGoldfishOptimal,
    // some variants omitted
}

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

Invalid

Linear

IntelI915XTiled

IntelI915YTiled

IntelI915YfTiled

IntelI915YTiledCcs

IntelI915YfTiledCcs

ArmAfbc16X16

ArmAfbc32X8

ArmLinearTe

ArmAfbc16X16Te

ArmAfbc32X8Te

ArmAfbc16X16YuvTiledHeader

ArmAfbc16X16SplitBlockSparseYuv

ArmAfbc16X16SplitBlockSparseYuvTe

ArmAfbc16X16SplitBlockSparseYuvTiledHeader

ArmAfbc16X16SplitBlockSparseYuvTeTiledHeader

GoogleGoldfishOptimal

Implementations

impl PixelFormatModifier

pub fn from_primitive(prim: u64) -> Option<PixelFormatModifier>

pub fn from_primitive_allow_unknown(prim: u64) -> PixelFormatModifier

pub fn unknown() -> PixelFormatModifier

pub const fn into_primitive(self) -> u64

pub fn is_unknown(&self) -> bool

Trait Implementations

impl Clone for PixelFormatModifier

fn clone(&self) -> PixelFormatModifier

Returns a copy 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<D> Decode<PixelFormatModifier, D> for PixelFormatModifier

where D: ResourceDialect,

fn new_empty() -> PixelFormatModifier

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, D>, offset: usize, _depth: Depth, ) -> Result<(), Error>

Decodes an object of type T from the decoder’s buffers into self.

impl<D> Encode<PixelFormatModifier, D> for PixelFormatModifier

where D: ResourceDialect,

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

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 TypeMarker for PixelFormatModifier

type Owned = PixelFormatModifier

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl ValueTypeMarker for PixelFormatModifier

type Borrowed<'a> = PixelFormatModifier

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow( value: &<PixelFormatModifier as TypeMarker>::Owned, ) -> <PixelFormatModifier as ValueTypeMarker>::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Copy for PixelFormatModifier

impl Eq for PixelFormatModifier

impl StructuralPartialEq for PixelFormatModifier