Struct SurfaceFormat 

pub struct SurfaceFormat { /* private fields */ }

Every dimension of a surface format: the full shape a GPU importer needs to sample a buffer.

Built only here — its fields are private and its constructors are private — so it is always one of the shapes a SurfaceFormatKind admits, and a renderer reads it rather than inventing it.

Implementations

impl SurfaceFormat

pub const fn model(&self) -> ColorModel

How the colour is modelled.

pub const fn subsampling(&self) -> Subsampling

How much colour detail the chroma carries.

pub const fn layout(&self) -> PlaneLayout

How the planes are arranged.

pub const fn rgb_order(&self) -> RgbOrder

The order of an RGB surface’s first two components; meaningless for YCbCr.

pub const fn chroma_order(&self) -> ChromaOrder

The order of the chroma components; meaningless for RGB.

pub const fn depth(&self) -> SampleDepth

The nominal bits of a sample.

pub const fn container(&self) -> SampleContainer

The word a sample is stored in.

pub const fn alpha(&self) -> Alpha

What the alpha component means, where the surface has one.

pub const fn is_yuv(&self) -> bool

Whether the colour is YCbCr, and so needs a matrix before it is RGB.

pub const fn plane_count(&self) -> usize

How many planes a buffer of this shape carries: one for packed and mono, two for semi-planar, three for planar.

Trait Implementations

impl Clone for SurfaceFormat

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 SurfaceFormat

impl Debug for SurfaceFormat

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

Formats the value using the given formatter.

impl Eq for SurfaceFormat

impl PartialEq for SurfaceFormat

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SurfaceFormat