Enum gstreamer_video::VideoFormat[−][src]

#[non_exhaustive]
pub enum VideoFormat {

Show variants    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
This is supported on crate feature v1_10 only.

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

P01010le
This is supported on crate feature v1_10 only.

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

Iyu2
This is supported on crate feature v1_10 only.

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

Vyuy
This is supported on crate feature v1_12 only.

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

Gbra
This is supported on crate feature v1_12 only.

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

Gbra10be
This is supported on crate feature v1_12 only.

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

Gbra10le
This is supported on crate feature v1_12 only.

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

Gbr12be
This is supported on crate feature v1_12 only.

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

Gbr12le
This is supported on crate feature v1_12 only.

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

Gbra12be
This is supported on crate feature v1_12 only.

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

Gbra12le
This is supported on crate feature v1_12 only.

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

I42012be
This is supported on crate feature v1_12 only.

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

I42012le
This is supported on crate feature v1_12 only.

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

I42212be
This is supported on crate feature v1_12 only.

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

I42212le
This is supported on crate feature v1_12 only.

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

Y44412be
This is supported on crate feature v1_12 only.

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

Y44412le
This is supported on crate feature v1_12 only.

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

Gray10Le32
This is supported on crate feature v1_14 only.

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

Nv1210le32
This is supported on crate feature v1_14 only.

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

Nv1610le32
This is supported on crate feature v1_14 only.

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

Nv1210le40
This is supported on crate feature v1_16 only.

Fully packed variant of NV12_10LE32 (Since: 1.16)

Y210
This is supported on crate feature v1_16 only.

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

Y410
This is supported on crate feature v1_16 only.

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

Vuya
This is supported on crate feature v1_16 only.

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

Bgr10a2Le
This is supported on crate feature v1_16 only.

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
This is supported on crate feature v1_18 only.

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
This is supported on crate feature v1_18 only.

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

Y44416le
This is supported on crate feature v1_18 only.

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

P016Be
This is supported on crate feature v1_18 only.

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

P016Le
This is supported on crate feature v1_18 only.

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

P012Be
This is supported on crate feature v1_18 only.

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

P012Le
This is supported on crate feature v1_18 only.

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

Y212Be
This is supported on crate feature v1_18 only.

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

Y212Le
This is supported on crate feature v1_18 only.

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

Y412Be
This is supported on crate feature v1_18 only.

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

Y412Le
This is supported on crate feature v1_18 only.

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

Nv124l4
This is supported on crate feature v1_18 only.

NV12 with 4x4 tiles in linear order.

Nv1232l32
This is supported on crate feature v1_18 only.

NV12 with 32x32 tiles in linear order.

Implementations

impl VideoFormat[src]

pub fn from_fourcc(fourcc: u32) -> VideoFormat[src]

pub fn from_string(format: &str) -> VideoFormat[src]

pub fn to_fourcc(self) -> u32[src]

impl VideoFormat[src]

pub fn from_masks(
    depth: u32,
    bpp: u32,
    endianness: VideoEndianness,
    red_mask: u32,
    blue_mask: u32,
    green_mask: u32,
    alpha_mask: u32
) -> Self[src]

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

pub fn iter_raw() -> VideoFormatIteratorⓘ

Notable traits for VideoFormatIterator

impl Iterator for VideoFormatIterator type Item = VideoFormat;
[src]

Trait Implementations

impl Clone for VideoFormat[src]

fn clone(&self) -> VideoFormat[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for VideoFormat[src]

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

Formats the value using the given formatter. Read more

impl Display for VideoFormat[src]

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

Formats the value using the given formatter. Read more

impl From<VideoFormat> for VideoFormatInfo[src]

fn from(f: VideoFormat) -> Self[src]

Performs the conversion.

impl FromStr for VideoFormat[src]

type Err = BoolError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>[src]

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

impl<'a> FromValue<'a> for VideoFormat[src]

type Checker = GenericValueTypeChecker<Self>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self[src]

Get the contained value from a Value. Read more

impl Hash for VideoFormat[src]

fn hash<__H: Hasher>(&self, state: &mut __H)[src]

Feeds this value into the given Hasher. Read more

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 1.3.0[src]

Feeds a slice of this type into the given Hasher. Read more

impl Ord for VideoFormat[src]

fn cmp(&self, other: &Self) -> Ordering[src]

This method returns an Ordering between self and other. Read more

#[must_use]
fn max(self, other: Self) -> Self1.21.0[src]

Compares and returns the maximum of two values. Read more

#[must_use]
fn min(self, other: Self) -> Self1.21.0[src]

Compares and returns the minimum of two values. Read more

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

Restrict a value to a certain interval. Read more

impl PartialEq<VideoFormat> for VideoFormat[src]

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

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

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

This method tests for !=.

impl PartialOrd<VideoFormat> for VideoFormat[src]

fn partial_cmp(&self, other: &Self) -> Option<Ordering>[src]

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

#[must_use]
fn lt(&self, other: &Rhs) -> bool1.0.0[src]

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

#[must_use]
fn le(&self, other: &Rhs) -> bool1.0.0[src]

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

#[must_use]
fn gt(&self, other: &Rhs) -> bool1.0.0[src]

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

#[must_use]
fn ge(&self, other: &Rhs) -> bool1.0.0[src]

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

impl StaticType for VideoFormat[src]

fn static_type() -> Type[src]

Returns the type identifier of Self.

impl ToValue for VideoFormat[src]

fn to_value(&self) -> Value[src]

Convert a value to a Value.

fn value_type(&self) -> Type[src]

Returns the type identifer of self. Read more

impl ValueType for VideoFormat[src]

type Type = Self

Type to get the Type from. Read more

impl Copy for VideoFormat[src]

impl Eq for VideoFormat[src]

impl StructuralEq for VideoFormat[src]

impl StructuralPartialEq for VideoFormat[src]

Auto Trait Implementations

impl RefUnwindSafe for VideoFormat

impl Send for VideoFormat

impl Sync for VideoFormat

impl Unpin for VideoFormat

impl UnwindSafe for VideoFormat

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

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

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToSendValue for T where
    T: Send + ToValue + ?Sized, [src]

pub fn to_send_value(&self) -> SendValue[src]

Returns a SendValue clone of self.

impl<T> ToString for T where
    T: Display + ?Sized, [src]

pub default fn to_string(&self) -> String[src]

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.