Enum SurfaceFormatKind 

pub enum SurfaceFormatKind {
    Bgra8(SurfaceFormat),
    Rgba8(SurfaceFormat),
    Nv12(SurfaceFormat),
    Nv21(SurfaceFormat),
    I420(SurfaceFormat),
    Yv12(SurfaceFormat),
    Nv16(SurfaceFormat),
    Nv61(SurfaceFormat),
    Yu16(SurfaceFormat),
    Yv16(SurfaceFormat),
    Nv24(SurfaceFormat),
    Yuv444(SurfaceFormat),
    Mono8(SurfaceFormat),
    P010(SurfaceFormat),
    P012(SurfaceFormat),
    P016(SurfaceFormat),
    I010(SurfaceFormat),
    I012(SurfaceFormat),
    I016(SurfaceFormat),
    P210(SurfaceFormat),
    P212(SurfaceFormat),
    P216(SurfaceFormat),
    P410(SurfaceFormat),
    P412(SurfaceFormat),
    P416(SurfaceFormat),
    Q410(SurfaceFormat),
    Q416(SurfaceFormat),
}

A format a producer emits: a choice of pre-constructed SurfaceFormats.

See the module documentation. Name one of the constants (NV12 and friends) to get a value; match a variant to tell formats apart.

Variants

Bgra8(SurfaceFormat)

BGRA8: 8-bit blue/green/red/alpha, straight alpha — the common desktop format.

Rgba8(SurfaceFormat)

RGBA8: 8-bit red/green/blue/alpha, straight alpha.

Nv12(SurfaceFormat)

NV12: 4:2:0 semi-planar, Cb then Cr — the universal decoder default.

Nv21(SurfaceFormat)

NV21: NV12 with the chroma components the other way round.

I420(SurfaceFormat)

I420 (YU12): 4:2:0 planar, Cb and Cr in their own planes after luma.

Yv12(SurfaceFormat)

YV12: I420 with the two chroma planes the other way round.

Nv16(SurfaceFormat)

NV16: 4:2:2 semi-planar, Cb then Cr.

Nv61(SurfaceFormat)

NV61: NV16 with the chroma components the other way round.

Yu16(SurfaceFormat)

YU16: 4:2:2 planar, Cb then Cr planes.

Yv16(SurfaceFormat)

YV16: YU16 with the two chroma planes the other way round.

Nv24(SurfaceFormat)

NV24: 4:4:4 semi-planar, Cb then Cr.

Yuv444(SurfaceFormat)

YUV444: 4:4:4 planar.

Mono8(SurfaceFormat)

Mono: a single 8-bit luma plane and no chroma at all.

P010(SurfaceFormat)

P010: 4:2:0 semi-planar, 10 bits in the high bits of a 16-bit word — HEVC Main10, VP9 profile 2 and AV1.

P012(SurfaceFormat)

P012: 4:2:0 semi-planar, 12 bits in a 16-bit word.

P016(SurfaceFormat)

P016: 4:2:0 semi-planar, a full 16-bit sample.

I010(SurfaceFormat)

I010: 4:2:0 planar, 10 bits in a 16-bit word.

I012(SurfaceFormat)

I012: 4:2:0 planar, 12 bits in a 16-bit word.

I016(SurfaceFormat)

I016: 4:2:0 planar, a full 16-bit sample.

P210(SurfaceFormat)

P210: 4:2:2 semi-planar, 10 bits in a 16-bit word.

P212(SurfaceFormat)

P212: 4:2:2 semi-planar, 12 bits in a 16-bit word.

P216(SurfaceFormat)

P216: 4:2:2 semi-planar, a full 16-bit sample.

P410(SurfaceFormat)

P410: 4:4:4 semi-planar, 10 bits in a 16-bit word.

P412(SurfaceFormat)

P412: 4:4:4 semi-planar, 12 bits in a 16-bit word.

P416(SurfaceFormat)

P416: 4:4:4 semi-planar, a full 16-bit sample.

Q410(SurfaceFormat)

Q410: 4:4:4 planar, 10 bits in a 16-bit word.

Q416(SurfaceFormat)

Q416: 4:4:4 planar, a full 16-bit sample.

Implementations

impl SurfaceFormatKind

pub const fn bgra8() -> Self

BGRA8: 8-bit blue/green/red/alpha, straight alpha.

pub const fn rgba8() -> Self

RGBA8: 8-bit red/green/blue/alpha, straight alpha.

pub const fn nv12() -> Self

NV12: 4:2:0 semi-planar, Cb then Cr — the universal decoder default.

pub const fn nv21() -> Self

NV21: NV12 with the chroma components the other way round.

pub const fn i420() -> Self

I420 (YU12): 4:2:0 planar, Cb and Cr in their own planes after luma.

pub const fn yv12() -> Self

YV12: I420 with the two chroma planes the other way round.

pub const fn nv16() -> Self

NV16: 4:2:2 semi-planar, Cb then Cr.

pub const fn nv61() -> Self

NV61: NV16 with the chroma components the other way round.

pub const fn yu16() -> Self

YU16: 4:2:2 planar, Cb then Cr planes.

pub const fn yv16() -> Self

YV16: YU16 with the two chroma planes the other way round.

pub const fn nv24() -> Self

NV24: 4:4:4 semi-planar, Cb then Cr.

pub const fn yuv444() -> Self

YUV444: 4:4:4 planar.

pub const fn mono8() -> Self

Mono: a single 8-bit luma plane and no chroma at all.

pub const fn p010() -> Self

P010: 4:2:0 semi-planar, 10 bits in the high bits of a 16-bit word.

pub const fn p012() -> Self

P012: 4:2:0 semi-planar, 12 bits in a 16-bit word.

pub const fn p016() -> Self

P016: 4:2:0 semi-planar, a full 16-bit sample.

pub const fn i010() -> Self

I010: 4:2:0 planar, 10 bits in a 16-bit word.

pub const fn i012() -> Self

I012: 4:2:0 planar, 12 bits in a 16-bit word.

pub const fn i016() -> Self

I016: 4:2:0 planar, a full 16-bit sample.

pub const fn p210() -> Self

P210: 4:2:2 semi-planar, 10 bits in a 16-bit word.

pub const fn p212() -> Self

P212: 4:2:2 semi-planar, 12 bits in a 16-bit word.

pub const fn p216() -> Self

P216: 4:2:2 semi-planar, a full 16-bit sample.

pub const fn p410() -> Self

P410: 4:4:4 semi-planar, 10 bits in a 16-bit word.

pub const fn p412() -> Self

P412: 4:4:4 semi-planar, 12 bits in a 16-bit word.

pub const fn p416() -> Self

P416: 4:4:4 semi-planar, a full 16-bit sample.

pub const fn q410() -> Self

Q410: 4:4:4 planar, 10 bits in a 16-bit word.

pub const fn q416() -> Self

Q416: 4:4:4 planar, a full 16-bit sample.

pub const fn dimensions(self) -> SurfaceFormat

The pre-constructed shape this kind names.

pub const fn is_yuv(self) -> bool

Whether the colour is YCbCr; see SurfaceFormat::is_yuv.

pub const fn plane_count(self) -> usize

How many planes a buffer of this kind carries; see SurfaceFormat::plane_count.

Trait Implementations

impl Clone for SurfaceFormatKind

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 SurfaceFormatKind

impl Debug for SurfaceFormatKind

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

Formats the value using the given formatter.

impl Display for SurfaceFormatKind

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

The format’s conventional name, for diagnostics — a dropped surface says which format it was.

impl Eq for SurfaceFormatKind

impl PartialEq for SurfaceFormatKind

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SurfaceFormatKind