Struct ffmpeg_rs::util::channel_layout::ChannelLayout
source · [−]pub struct ChannelLayout { /* private fields */ }
Implementations
sourceimpl ChannelLayout
impl ChannelLayout
pub const FRONT_LEFT: Self = _
pub const FRONT_RIGHT: Self = _
pub const FRONT_CENTER: Self = _
pub const LOW_FREQUENCY: Self = _
pub const BACK_LEFT: Self = _
pub const BACK_RIGHT: Self = _
pub const FRONT_LEFT_OF_CENTER: Self = _
pub const FRONT_RIGHT_OF_CENTER: Self = _
pub const BACK_CENTER: Self = _
pub const SIDE_LEFT: Self = _
pub const SIDE_RIGHT: Self = _
pub const TOP_CENTER: Self = _
pub const TOP_FRONT_LEFT: Self = _
pub const TOP_FRONT_CENTER: Self = _
pub const TOP_FRONT_RIGHT: Self = _
pub const TOP_BACK_LEFT: Self = _
pub const TOP_BACK_CENTER: Self = _
pub const TOP_BACK_RIGHT: Self = _
pub const STEREO_LEFT: Self = _
pub const STEREO_RIGHT: Self = _
pub const WIDE_LEFT: Self = _
pub const WIDE_RIGHT: Self = _
pub const SURROUND_DIRECT_LEFT: Self = _
pub const SURROUND_DIRECT_RIGHT: Self = _
pub const LOW_FREQUENCY_2: Self = _
pub const NATIVE: Self = _
pub const MONO: Self = _
pub const STEREO: Self = _
pub const _2POINT1: Self = _
pub const _2_1: Self = _
pub const SURROUND: Self = _
pub const _3POINT1: Self = _
pub const _4POINT0: Self = _
pub const _4POINT1: Self = _
pub const _2_2: Self = _
pub const QUAD: Self = _
pub const _5POINT0: Self = _
pub const _5POINT1: Self = _
pub const _5POINT0_BACK: Self = _
pub const _5POINT1_BACK: Self = _
pub const _6POINT0: Self = _
pub const _6POINT0_FRONT: Self = _
pub const HEXAGONAL: Self = _
pub const _6POINT1: Self = _
pub const _6POINT1_BACK: Self = _
pub const _6POINT1_FRONT: Self = _
pub const _7POINT0: Self = _
pub const _7POINT0_FRONT: Self = _
pub const _7POINT1: Self = _
pub const _7POINT1_WIDE: Self = _
pub const _7POINT1_WIDE_BACK: Self = _
pub const OCTAGONAL: Self = _
pub const HEXADECAGONAL: Self = _
pub const STEREO_DOWNMIX: Self = _
sourcepub const fn bits(&self) -> c_ulonglong
pub const fn bits(&self) -> c_ulonglong
Returns the raw value of the flags currently stored.
sourcepub const fn from_bits(bits: c_ulonglong) -> Option<Self>
pub const fn from_bits(bits: c_ulonglong) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: c_ulonglong) -> Self
pub const fn from_bits_truncate(bits: c_ulonglong) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: c_ulonglong) -> Self
pub const unsafe fn from_bits_unchecked(bits: c_ulonglong) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
sourceimpl ChannelLayout
impl ChannelLayout
Trait Implementations
sourceimpl Binary for ChannelLayout
impl Binary for ChannelLayout
sourceimpl BitAnd<ChannelLayout> for ChannelLayout
impl BitAnd<ChannelLayout> for ChannelLayout
type Output = ChannelLayout
type Output = ChannelLayout
&
operator.sourceimpl BitAndAssign<ChannelLayout> for ChannelLayout
impl BitAndAssign<ChannelLayout> for ChannelLayout
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<ChannelLayout> for ChannelLayout
impl BitOr<ChannelLayout> for ChannelLayout
sourcefn bitor(self, other: ChannelLayout) -> Self
fn bitor(self, other: ChannelLayout) -> Self
Returns the union of the two sets of flags.
type Output = ChannelLayout
type Output = ChannelLayout
|
operator.sourceimpl BitOrAssign<ChannelLayout> for ChannelLayout
impl BitOrAssign<ChannelLayout> for ChannelLayout
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<ChannelLayout> for ChannelLayout
impl BitXor<ChannelLayout> for ChannelLayout
sourcefn bitxor(self, other: Self) -> Self
fn bitxor(self, other: Self) -> Self
Returns the left flags, but with all the right flags toggled.
type Output = ChannelLayout
type Output = ChannelLayout
^
operator.sourceimpl BitXorAssign<ChannelLayout> for ChannelLayout
impl BitXorAssign<ChannelLayout> for ChannelLayout
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for ChannelLayout
impl Clone for ChannelLayout
sourcefn clone(&self) -> ChannelLayout
fn clone(&self) -> ChannelLayout
1.0.0 · sourceconst fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for ChannelLayout
impl Debug for ChannelLayout
sourceimpl Extend<ChannelLayout> for ChannelLayout
impl Extend<ChannelLayout> for ChannelLayout
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)sourceimpl FromIterator<ChannelLayout> for ChannelLayout
impl FromIterator<ChannelLayout> for ChannelLayout
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
sourceimpl Hash for ChannelLayout
impl Hash for ChannelLayout
sourceimpl LowerHex for ChannelLayout
impl LowerHex for ChannelLayout
sourceimpl Not for ChannelLayout
impl Not for ChannelLayout
type Output = ChannelLayout
type Output = ChannelLayout
!
operator.sourceimpl Octal for ChannelLayout
impl Octal for ChannelLayout
sourceimpl Ord for ChannelLayout
impl Ord for ChannelLayout
sourcefn cmp(&self, other: &ChannelLayout) -> Ordering
fn cmp(&self, other: &ChannelLayout) -> Ordering
1.21.0 · sourceconst fn max(self, other: Self) -> Self
const fn max(self, other: Self) -> Self
1.21.0 · sourceconst fn min(self, other: Self) -> Self
const fn min(self, other: Self) -> Self
1.50.0 · sourceconst fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
const fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
sourceimpl PartialEq<ChannelLayout> for ChannelLayout
impl PartialEq<ChannelLayout> for ChannelLayout
sourcefn eq(&self, other: &ChannelLayout) -> bool
fn eq(&self, other: &ChannelLayout) -> bool
sourceimpl PartialOrd<ChannelLayout> for ChannelLayout
impl PartialOrd<ChannelLayout> for ChannelLayout
sourcefn partial_cmp(&self, other: &ChannelLayout) -> Option<Ordering>
fn partial_cmp(&self, other: &ChannelLayout) -> Option<Ordering>
1.0.0 · sourceconst fn le(&self, other: &Rhs) -> bool
const fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresourceimpl Sub<ChannelLayout> for ChannelLayout
impl Sub<ChannelLayout> for ChannelLayout
type Output = ChannelLayout
type Output = ChannelLayout
-
operator.sourceimpl SubAssign<ChannelLayout> for ChannelLayout
impl SubAssign<ChannelLayout> for ChannelLayout
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.