Enum gstreamer_video::VideoFormat

#[non_exhaustive]pub enum VideoFormat {
    Unknown,
    Encoded,
    I420,
    Yv12,
    Yuy2,
    Uyvy,
    Ayuv,
    Rgbx,
    Bgrx,
    Xrgb,
    Xbgr,
    Rgba,
    Bgra,
    Argb,
    Abgr,
    Rgb,
    Bgr,
    Y41b,
    Y42b,
    Yvyu,
    Y444,
    V210,
    V216,
    Nv12,
    Nv21,
    Gray8,
    Gray16Be,
    Gray16Le,
    V308,
    Rgb16,
    Bgr16,
    Rgb15,
    Bgr15,
    Uyvp,
    A420,
    Rgb8p,
    Yuv9,
    Yvu9,
    Iyu1,
    Argb64,
    Ayuv64,
    R210,
    I42010be,
    I42010le,
    I42210be,
    I42210le,
    Y44410be,
    Y44410le,
    Gbr,
    Gbr10be,
    Gbr10le,
    Nv16,
    Nv24,
    Nv1264z32,
    A42010be,
    A42010le,
    A42210be,
    A42210le,
    A44410be,
    A44410le,
    Nv61,
    P01010be,
    P01010le,
    Iyu2,
    Vyuy,
    Gbra,
    Gbra10be,
    Gbra10le,
    Gbr12be,
    Gbr12le,
    Gbra12be,
    Gbra12le,
    I42012be,
    I42012le,
    I42212be,
    I42212le,
    Y44412be,
    Y44412le,
    Gray10Le32,
    Nv1210le32,
    Nv1610le32,
    Nv1210le40,
    Y210,
    Y410,
    Vuya,
    Bgr10a2Le,
    Rgb10a2Le,
    Y44416be,
    Y44416le,
    P016Be,
    P016Le,
    P012Be,
    P012Le,
    Y212Be,
    Y212Le,
    Y412Be,
    Y412Le,
    Nv124l4,
    Nv1232l32,
    // some variants omitted
}

Enum value describing the most common video formats.

See the GStreamer raw video format design document for details about the layout and packing of these formats in memory.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unknown

Unknown or unset video format id

Encoded

Encoded video format. Only ever use that in caps for special video formats in combination with non-system memory GstCapsFeatures where it does not make sense to specify a real video format.

I420

planar 4:2:0 YUV

Yv12

planar 4:2:0 YVU (like I420 but UV planes swapped)

Yuy2

packed 4:2:2 YUV (Y0-U0-Y1-V0 Y2-U2-Y3-V2 Y4 ...)

Uyvy

packed 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...)

Ayuv

packed 4:4:4 YUV with alpha channel (A0-Y0-U0-V0 ...)

Rgbx

sparse rgb packed into 32 bit, space last

Bgrx

sparse reverse rgb packed into 32 bit, space last

Xrgb

sparse rgb packed into 32 bit, space first

Xbgr

sparse reverse rgb packed into 32 bit, space first

Rgba

rgb with alpha channel last

Bgra

reverse rgb with alpha channel last

Argb

rgb with alpha channel first

Abgr

reverse rgb with alpha channel first

Rgb

RGB packed into 24 bits without padding (R-G-B-R-G-B)

Bgr

reverse RGB packed into 24 bits without padding (B-G-R-B-G-R)

Y41b

planar 4:1:1 YUV

Y42b

planar 4:2:2 YUV

Yvyu

packed 4:2:2 YUV (Y0-V0-Y1-U0 Y2-V2-Y3-U2 Y4 ...)

Y444

planar 4:4:4 YUV

V210

packed 4:2:2 10-bit YUV, complex format

V216

packed 4:2:2 16-bit YUV, Y0-U0-Y1-V1 order

Nv12

planar 4:2:0 YUV with interleaved UV plane

Nv21

planar 4:2:0 YUV with interleaved VU plane

Gray8

8-bit grayscale

Gray16Be

16-bit grayscale, most significant byte first

Gray16Le

16-bit grayscale, least significant byte first

V308

packed 4:4:4 YUV (Y-U-V ...)

Rgb16

rgb 5-6-5 bits per component

Bgr16

reverse rgb 5-6-5 bits per component

Rgb15

rgb 5-5-5 bits per component

Bgr15

reverse rgb 5-5-5 bits per component

Uyvp

packed 10-bit 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...)

A420

planar 4:4:2:0 AYUV

Rgb8p

8-bit paletted RGB

Yuv9

planar 4:1:0 YUV

Yvu9

planar 4:1:0 YUV (like YUV9 but UV planes swapped)

Iyu1

packed 4:1:1 YUV (Cb-Y0-Y1-Cr-Y2-Y3 ...)

Argb64

rgb with alpha channel first, 16 bits per channel

Ayuv64

packed 4:4:4 YUV with alpha channel, 16 bits per channel (A0-Y0-U0-V0 ...)

R210

packed 4:4:4 RGB, 10 bits per channel

I42010be

planar 4:2:0 YUV, 10 bits per channel

I42010le

planar 4:2:0 YUV, 10 bits per channel

I42210be

planar 4:2:2 YUV, 10 bits per channel

I42210le

planar 4:2:2 YUV, 10 bits per channel

Y44410be

planar 4:4:4 YUV, 10 bits per channel (Since: 1.2)

Y44410le

planar 4:4:4 YUV, 10 bits per channel (Since: 1.2)

Gbr

planar 4:4:4 RGB, 8 bits per channel (Since: 1.2)

Gbr10be

planar 4:4:4 RGB, 10 bits per channel (Since: 1.2)

Gbr10le

planar 4:4:4 RGB, 10 bits per channel (Since: 1.2)

Nv16

planar 4:2:2 YUV with interleaved UV plane (Since: 1.2)

Nv24

planar 4:4:4 YUV with interleaved UV plane (Since: 1.2)

Nv1264z32

NV12 with 64x32 tiling in zigzag pattern (Since: 1.4)

A42010be

planar 4:4:2:0 YUV, 10 bits per channel (Since: 1.6)

A42010le

planar 4:4:2:0 YUV, 10 bits per channel (Since: 1.6)

A42210be

planar 4:4:2:2 YUV, 10 bits per channel (Since: 1.6)

A42210le

planar 4:4:2:2 YUV, 10 bits per channel (Since: 1.6)

A44410be

planar 4:4:4:4 YUV, 10 bits per channel (Since: 1.6)

A44410le

planar 4:4:4:4 YUV, 10 bits per channel (Since: 1.6)

Nv61

planar 4:2:2 YUV with interleaved VU plane (Since: 1.6)

P01010be

planar 4:2:0 YUV with interleaved UV plane, 10 bits per channel (Since: 1.10)

P01010le

planar 4:2:0 YUV with interleaved UV plane, 10 bits per channel (Since: 1.10)

Iyu2

packed 4:4:4 YUV (U-Y-V ...) (Since: 1.10)

Vyuy

packed 4:2:2 YUV (V0-Y0-U0-Y1 V2-Y2-U2-Y3 V4 ...)

Gbra

planar 4:4:4:4 ARGB, 8 bits per channel (Since: 1.12)

Gbra10be

planar 4:4:4:4 ARGB, 10 bits per channel (Since: 1.12)

Gbra10le

planar 4:4:4:4 ARGB, 10 bits per channel (Since: 1.12)

Gbr12be

planar 4:4:4 RGB, 12 bits per channel (Since: 1.12)

Gbr12le

planar 4:4:4 RGB, 12 bits per channel (Since: 1.12)

Gbra12be

planar 4:4:4:4 ARGB, 12 bits per channel (Since: 1.12)

Gbra12le

planar 4:4:4:4 ARGB, 12 bits per channel (Since: 1.12)

I42012be

planar 4:2:0 YUV, 12 bits per channel (Since: 1.12)

I42012le

planar 4:2:0 YUV, 12 bits per channel (Since: 1.12)

I42212be

planar 4:2:2 YUV, 12 bits per channel (Since: 1.12)

I42212le

planar 4:2:2 YUV, 12 bits per channel (Since: 1.12)

Y44412be

planar 4:4:4 YUV, 12 bits per channel (Since: 1.12)

Y44412le

planar 4:4:4 YUV, 12 bits per channel (Since: 1.12)

Gray10Le32

10-bit grayscale, packed into 32bit words (2 bits padding) (Since: 1.14)

Nv1210le32

10-bit variant of VideoFormat::Nv12, packed into 32bit words (MSB 2 bits padding) (Since: 1.14)

Nv1610le32

10-bit variant of VideoFormat::Nv16, packed into 32bit words (MSB 2 bits padding) (Since: 1.14)

Nv1210le40

Fully packed variant of NV12_10LE32 (Since: 1.16)

Y210

packed 4:2:2 YUV, 10 bits per channel (Since: 1.16)

Y410

packed 4:4:4 YUV, 10 bits per channel(A-V-Y-U...) (Since: 1.16)

Vuya

packed 4:4:4 YUV with alpha channel (V0-U0-Y0-A0...) (Since: 1.16)

Bgr10a2Le

packed 4:4:4 RGB with alpha channel(B-G-R-A), 10 bits for R/G/B channel and MSB 2 bits for alpha channel (Since: 1.16)

Rgb10a2Le

packed 4:4:4 RGB with alpha channel(R-G-B-A), 10 bits for R/G/B channel and MSB 2 bits for alpha channel (Since: 1.18)

Y44416be

planar 4:4:4 YUV, 16 bits per channel (Since: 1.18)

Y44416le

planar 4:4:4 YUV, 16 bits per channel (Since: 1.18)

P016Be

planar 4:2:0 YUV with interleaved UV plane, 16 bits per channel (Since: 1.18)

P016Le

planar 4:2:0 YUV with interleaved UV plane, 16 bits per channel (Since: 1.18)

P012Be

planar 4:2:0 YUV with interleaved UV plane, 12 bits per channel (Since: 1.18)

P012Le

planar 4:2:0 YUV with interleaved UV plane, 12 bits per channel (Since: 1.18)

Y212Be

packed 4:2:2 YUV, 12 bits per channel (Y-U-Y-V) (Since: 1.18)

Y212Le

packed 4:2:2 YUV, 12 bits per channel (Y-U-Y-V) (Since: 1.18)

Y412Be

packed 4:4:4:4 YUV, 12 bits per channel(U-Y-V-A...) (Since: 1.18)

Y412Le

packed 4:4:4:4 YUV, 12 bits per channel(U-Y-V-A...) (Since: 1.18)

Nv124l4

Nv1232l32

Implementations

impl VideoFormat

pub fn from_fourcc(fourcc: u32) -> VideoFormat

pub fn from_masks(
    depth: u32,
    bpp: u32,
    endianness: VideoEndianness,
    red_mask: u32,
    blue_mask: u32,
    green_mask: u32,
    alpha_mask: u32
) -> VideoFormat

pub fn to_str<'a>(self) -> &'a str

pub fn iter_raw() -> VideoFormatIterator

Trait Implementations

impl Clone for VideoFormat

fn clone(&self) -> VideoFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for VideoFormat

impl Debug for VideoFormat

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

Formats the value using the given formatter.

impl Display for VideoFormat

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

Formats the value using the given formatter.

impl Eq for VideoFormat

impl From<VideoFormat> for VideoFormatInfo

fn from(f: VideoFormat) -> Self

Performs the conversion.

impl FromStr for VideoFormat

type Err = BoolError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, BoolError>

Parses a string s to return a value of this type.

impl<'a> FromValue<'a> for VideoFormat

unsafe fn from_value(value: &Value) -> Self

Safety

impl<'a> FromValueOptional<'a> for VideoFormat

unsafe fn from_value_optional(value: &Value) -> Option<Self>

Safety

impl Hash for VideoFormat

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for VideoFormat

fn cmp(&self, other: &VideoFormat) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<VideoFormat> for VideoFormat

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<VideoFormat> for VideoFormat

fn partial_cmp(&self, other: &VideoFormat) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl SetValue for VideoFormat

unsafe fn set_value(value: &mut Value, this: &Self)

Safety

impl StaticType for VideoFormat

fn static_type() -> Type

Returns the type identifier of Self.

impl StructuralEq for VideoFormat

impl StructuralPartialEq for VideoFormat