Struct gstreamer_video::VideoBufferFlags

pub struct VideoBufferFlags { /* fields omitted */ }

Additional video buffer flags. These flags can potentially be used on any buffers carrying closed caption data, or video data - even encoded data.

Note that these are only valid for crate::gst::Caps of type: video/… and caption/… They can conflict with other extended buffer flags.

Implementations

impl VideoBufferFlags

pub const INTERLACED: VideoBufferFlags

If the crate::gst::Buffer is interlaced. In mixed interlace-mode, this flags specifies if the frame is interlaced or progressive.

pub const TFF: VideoBufferFlags

If the crate::gst::Buffer is interlaced, then the first field in the video frame is the top field. If unset, the bottom field is first.

pub const RFF: VideoBufferFlags

If the crate::gst::Buffer is interlaced, then the first field (as defined by the [Self::Tff] flag setting) is repeated.

pub const ONEFIELD: VideoBufferFlags

If the crate::gst::Buffer is interlaced, then only the first field (as defined by the [Self::Tff] flag setting) is to be displayed (Since: 1.16).

pub const MULTIPLE_VIEW: VideoBufferFlags

The crate::gst::Buffer contains one or more specific views, such as left or right eye view. This flags is set on any buffer that contains non-mono content - even for streams that contain only a single viewpoint. In mixed mono / non-mono streams, the absence of the flag marks mono buffers.

pub const FIRST_IN_BUNDLE: VideoBufferFlags

When conveying stereo/multiview content with frame-by-frame methods, this flag marks the first buffer in a bundle of frames that belong together.

pub const TOP_FIELD: VideoBufferFlags

This is supported on crate feature v1_16 only.

The video frame has the top field only. This is the same as GST_VIDEO_BUFFER_FLAG_TFF | GST_VIDEO_BUFFER_FLAG_ONEFIELD (Since: 1.16). Use GST_VIDEO_BUFFER_IS_TOP_FIELD() to check for this flag.

pub const BOTTOM_FIELD: VideoBufferFlags

This is supported on crate feature v1_16 only.

The video frame has the bottom field only. This is the same as GST_VIDEO_BUFFER_FLAG_ONEFIELD (GST_VIDEO_BUFFER_FLAG_TFF flag unset) (Since: 1.16). Use GST_VIDEO_BUFFER_IS_BOTTOM_FIELD() to check for this flag.

pub const MARKER: VideoBufferFlags

This is supported on crate feature v1_18 only.

The crate::gst::Buffer contains the end of a video field or frame boundary such as the last subframe or packet (Since: 1.18).

pub const fn empty() -> VideoBufferFlags

Returns an empty set of flags

pub const fn all() -> VideoBufferFlags

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<VideoBufferFlags>

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) -> VideoBufferFlags

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

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

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: VideoBufferFlags) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for VideoBufferFlags

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

Formats the value using the given formatter.

impl BitAnd<VideoBufferFlags> for VideoBufferFlags

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

Returns the intersection between the two sets of flags.

type Output = VideoBufferFlags

The resulting type after applying the & operator.

impl BitAndAssign<VideoBufferFlags> for VideoBufferFlags

fn bitand_assign(&mut self, other: VideoBufferFlags)

Disables all flags disabled in the set.

impl BitOr<VideoBufferFlags> for VideoBufferFlags

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

Returns the union of the two sets of flags.

type Output = VideoBufferFlags

The resulting type after applying the | operator.

impl BitOrAssign<VideoBufferFlags> for VideoBufferFlags

fn bitor_assign(&mut self, other: VideoBufferFlags)

Adds the set of flags.

impl BitXor<VideoBufferFlags> for VideoBufferFlags

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

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

type Output = VideoBufferFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<VideoBufferFlags> for VideoBufferFlags

fn bitxor_assign(&mut self, other: VideoBufferFlags)

Toggles the set of flags.

impl Clone for VideoBufferFlags

fn clone(&self) -> VideoBufferFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VideoBufferFlags

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

Formats the value using the given formatter.

impl Extend<VideoBufferFlags> for VideoBufferFlags

fn extend<T: IntoIterator<Item = VideoBufferFlags>>(&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<VideoBufferFlags> for VideoBufferFlags

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

Creates a value from an iterator.

impl<'a> FromValue<'a> for VideoBufferFlags

type Checker = GenericValueTypeChecker<Self>

Value type checker.

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

Get the contained value from a Value.

impl Hash for VideoBufferFlags

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 VideoBufferFlags

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

Formats the value using the given formatter.

impl Not for VideoBufferFlags

fn not(self) -> VideoBufferFlags

Returns the complement of this set of flags.

type Output = VideoBufferFlags

The resulting type after applying the ! operator.

impl Octal for VideoBufferFlags

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

Formats the value using the given formatter.

impl Ord for VideoBufferFlags

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

Restrict a value to a certain interval.

impl PartialEq<VideoBufferFlags> for VideoBufferFlags

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

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

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

This method tests for !=.

impl PartialOrd<VideoBufferFlags> for VideoBufferFlags

fn partial_cmp(&self, other: &VideoBufferFlags) -> 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 StaticType for VideoBufferFlags

fn static_type() -> Type

Returns the type identifier of Self.

impl Sub<VideoBufferFlags> for VideoBufferFlags

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

Returns the set difference of the two sets of flags.

type Output = VideoBufferFlags

The resulting type after applying the - operator.

impl SubAssign<VideoBufferFlags> for VideoBufferFlags

fn sub_assign(&mut self, other: VideoBufferFlags)

Disables all flags enabled in the set.

impl ToValue for VideoBufferFlags

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifer of self.

impl UpperHex for VideoBufferFlags

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

Formats the value using the given formatter.

impl ValueType for VideoBufferFlags

type Type = Self

Type to get the Type from.

impl Copy for VideoBufferFlags

impl Eq for VideoBufferFlags

impl StructuralEq for VideoBufferFlags

impl StructuralPartialEq for VideoBufferFlags