Struct gstreamer_video::VideoFormatFlags

pub struct VideoFormatFlags { /* fields omitted */ }

The different video flags that a format info can have.

Implementations

impl VideoFormatFlags

pub const YUV: VideoFormatFlags

The video format is YUV, components are numbered 0=Y, 1=U, 2=V.

pub const RGB: VideoFormatFlags

The video format is RGB, components are numbered 0=R, 1=G, 2=B.

pub const GRAY: VideoFormatFlags

The video is gray, there is one gray component with index 0.

pub const ALPHA: VideoFormatFlags

The video format has an alpha components with the number 3.

pub const LE: VideoFormatFlags

The video format has data stored in little endianness.

pub const PALETTE: VideoFormatFlags

The video format has a palette. The palette is stored in the second plane and indexes are stored in the first plane.

pub const COMPLEX: VideoFormatFlags

The video format has a complex layout that can't be described with the usual information in the VideoFormatInfo.

pub const UNPACK: VideoFormatFlags

This format can be used in a GstVideoFormatUnpack and GstVideoFormatPack function.

pub const TILED: VideoFormatFlags

The format is tiled, there is tiling information in the last plane.

pub const fn empty() -> VideoFormatFlags

Returns an empty set of flags

pub const fn all() -> VideoFormatFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<VideoFormatFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> VideoFormatFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> VideoFormatFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: VideoFormatFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: VideoFormatFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: VideoFormatFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: VideoFormatFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: VideoFormatFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: VideoFormatFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for VideoFormatFlags

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

Formats the value using the given formatter.

impl BitAnd<VideoFormatFlags> for VideoFormatFlags

type Output = VideoFormatFlags

The resulting type after applying the & operator.

fn bitand(self, other: VideoFormatFlags) -> VideoFormatFlags

Returns the intersection between the two sets of flags.

impl BitAndAssign<VideoFormatFlags> for VideoFormatFlags

fn bitand_assign(&mut self, other: VideoFormatFlags)

Disables all flags disabled in the set.

impl BitOr<VideoFormatFlags> for VideoFormatFlags

type Output = VideoFormatFlags

The resulting type after applying the | operator.

fn bitor(self, other: VideoFormatFlags) -> VideoFormatFlags

Returns the union of the two sets of flags.

impl BitOrAssign<VideoFormatFlags> for VideoFormatFlags

fn bitor_assign(&mut self, other: VideoFormatFlags)

Adds the set of flags.

impl BitXor<VideoFormatFlags> for VideoFormatFlags

type Output = VideoFormatFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: VideoFormatFlags) -> VideoFormatFlags

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<VideoFormatFlags> for VideoFormatFlags

fn bitxor_assign(&mut self, other: VideoFormatFlags)

Toggles the set of flags.

impl Clone for VideoFormatFlags

fn clone(&self) -> VideoFormatFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for VideoFormatFlags

impl Debug for VideoFormatFlags

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

Formats the value using the given formatter.

impl Eq for VideoFormatFlags

impl Extend<VideoFormatFlags> for VideoFormatFlags

fn extend<T: IntoIterator<Item = VideoFormatFlags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<VideoFormatFlags> for VideoFormatFlags

fn from_iter<T: IntoIterator<Item = VideoFormatFlags>>(
    iterator: T
) -> VideoFormatFlags

Creates a value from an iterator.

impl<'a> FromValue<'a> for VideoFormatFlags

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

Safety

impl<'a> FromValueOptional<'a> for VideoFormatFlags

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

Safety

impl Hash for VideoFormatFlags

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 LowerHex for VideoFormatFlags

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

Formats the value using the given formatter.

impl Not for VideoFormatFlags

type Output = VideoFormatFlags

The resulting type after applying the ! operator.

fn not(self) -> VideoFormatFlags

Returns the complement of this set of flags.

impl Octal for VideoFormatFlags

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

Formats the value using the given formatter.

impl Ord for VideoFormatFlags

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

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

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

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

This method tests for !=.

impl PartialOrd<VideoFormatFlags> for VideoFormatFlags

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

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

fn lt(&self, other: &VideoFormatFlags) -> bool

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

fn le(&self, other: &VideoFormatFlags) -> bool

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

fn gt(&self, other: &VideoFormatFlags) -> bool

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

fn ge(&self, other: &VideoFormatFlags) -> bool

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

impl SetValue for VideoFormatFlags

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

Safety

impl StaticType for VideoFormatFlags

fn static_type() -> Type

Returns the type identifier of Self.

impl StructuralEq for VideoFormatFlags

impl StructuralPartialEq for VideoFormatFlags

impl Sub<VideoFormatFlags> for VideoFormatFlags

type Output = VideoFormatFlags

The resulting type after applying the - operator.

fn sub(self, other: VideoFormatFlags) -> VideoFormatFlags

Returns the set difference of the two sets of flags.

impl SubAssign<VideoFormatFlags> for VideoFormatFlags

fn sub_assign(&mut self, other: VideoFormatFlags)

Disables all flags enabled in the set.

impl UpperHex for VideoFormatFlags

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

Formats the value using the given formatter.