Struct Modifier 

pub struct Modifier(pub u64);

A DRM format modifier.

The default is Modifier::LINEAR, matching the C++ Modifier whose member initializer is DRM_FORMAT_MOD_LINEAR.

Tuple Fields

0: u64

Implementations

impl Modifier

pub const fn family(self) -> ModifierFamily

Which family this modifier belongs to.

use drmkit_fmt::{Modifier, ModifierFamily, sand128_col_height};

// A producer's SAND128 with a baked-in column height.
let produced = sand128_col_height(1080);
assert!(matches!(produced.family(), ModifierFamily::BroadcomSand { code: 4 }));

// The base a plane advertises.
assert_eq!(produced.family().base(), Some(sand128_col_height(0)));

// Everything else matches only itself.
assert_eq!(Modifier::LINEAR.family(), ModifierFamily::Exact);
assert_eq!(Modifier::LINEAR.family().base(), None);

impl Modifier

pub const LINEAR: Self

Raw, untiled bytes (DRM_FORMAT_MOD_LINEAR).

pub const INVALID: Self

The legacy “implementation-defined layout” sentinel (DRM_FORMAT_MOD_INVALID).

Treated as interchangeable with Modifier::LINEAR for eligibility, mirroring the pre-FormatTable supports_format_modifier semantics.

pub const fn vendor(self) -> u8

The vendor field (top 8 bits), as fourcc_mod_get_vendor reports it.

pub const fn body(self) -> u64

The 56-bit body below the vendor field.

pub const fn is_linear(self) -> bool

Whether this is Modifier::LINEAR.

pub const fn is_invalid(self) -> bool

Whether this is the Modifier::INVALID sentinel.

Trait Implementations

impl Clone for Modifier

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Modifier

impl Debug for Modifier

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

Formats the value using the given formatter.

impl Default for Modifier

fn default() -> Self

Returns the “default value” for a type.

impl Display for Modifier

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

Renders the human-readable description from crate::describe().

impl Eq for Modifier

impl From<Modifier> for u64

fn from(value: Modifier) -> Self

Converts to this type from the input type.

impl From<u64> for Modifier

fn from(value: u64) -> Self

Converts to this type from the input type.

impl Hash for Modifier

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Modifier

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for Modifier

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Modifier

fn partial_cmp(&self, other: &Self) -> 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 StructuralPartialEq for Modifier