Struct cubeb_core::ChannelLayout
source · pub struct ChannelLayout { /* private fields */ }
Expand description
Some common layout definitions
Implementations§
source§impl ChannelLayout
impl ChannelLayout
sourcepub const FRONT_LEFT: Self = _
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 = _
sourcepub const fn bits(&self) -> cubeb_channel_layout
pub const fn bits(&self) -> cubeb_channel_layout
Returns the raw value of the flags currently stored.
sourcepub const fn from_bits(bits: cubeb_channel_layout) -> Option<Self>
pub const fn from_bits(bits: cubeb_channel_layout) -> 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: cubeb_channel_layout) -> Self
pub const fn from_bits_truncate(bits: cubeb_channel_layout) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: cubeb_channel_layout) -> Self
pub const unsafe fn from_bits_unchecked(bits: cubeb_channel_layout) -> 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
.
source§impl ChannelLayout
impl ChannelLayout
pub const UNDEFINED: ChannelLayout = _
pub const MONO: ChannelLayout = _
pub const MONO_LFE: ChannelLayout = _
pub const STEREO: ChannelLayout = _
pub const STEREO_LFE: ChannelLayout = _
pub const _3F: ChannelLayout = _
pub const _3F_LFE: ChannelLayout = _
pub const _2F1: ChannelLayout = _
pub const _2F1_LFE: ChannelLayout = _
pub const _3F1: ChannelLayout = _
pub const _3F1_LFE: ChannelLayout = _
pub const _2F2: ChannelLayout = _
pub const _2F2_LFE: ChannelLayout = _
pub const QUAD: ChannelLayout = _
pub const QUAD_LFE: ChannelLayout = _
pub const _3F2: ChannelLayout = _
pub const _3F2_LFE: ChannelLayout = _
pub const _3F2_BACK: ChannelLayout = _
pub const _3F2_LFE_BACK: ChannelLayout = _
pub const _3F3R_LFE: ChannelLayout = _
pub const _3F4_LFE: ChannelLayout = _
source§impl ChannelLayout
impl ChannelLayout
pub fn num_channels(&self) -> u32
Trait Implementations§
source§impl Binary for ChannelLayout
impl Binary for ChannelLayout
source§impl BitAnd for ChannelLayout
impl BitAnd for ChannelLayout
source§impl BitAndAssign for ChannelLayout
impl BitAndAssign for ChannelLayout
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr for ChannelLayout
impl BitOr for ChannelLayout
source§fn 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.source§impl BitOrAssign for ChannelLayout
impl BitOrAssign for ChannelLayout
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for ChannelLayout
impl BitXor for ChannelLayout
source§impl BitXorAssign for ChannelLayout
impl BitXorAssign for ChannelLayout
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for ChannelLayout
impl Clone for ChannelLayout
source§fn clone(&self) -> ChannelLayout
fn clone(&self) -> ChannelLayout
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ChannelLayout
impl Debug for ChannelLayout
source§impl Extend<ChannelLayout> for ChannelLayout
impl Extend<ChannelLayout> for ChannelLayout
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl From<ChannelLayout> for cubeb_channel
impl From<ChannelLayout> for cubeb_channel
source§fn from(x: ChannelLayout) -> Self
fn from(x: ChannelLayout) -> Self
source§impl From<u32> for ChannelLayout
impl From<u32> for ChannelLayout
source§fn from(x: cubeb_channel) -> Self
fn from(x: cubeb_channel) -> Self
source§impl FromIterator<ChannelLayout> for ChannelLayout
impl FromIterator<ChannelLayout> for ChannelLayout
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for ChannelLayout
impl Hash for ChannelLayout
source§impl LowerHex for ChannelLayout
impl LowerHex for ChannelLayout
source§impl Not for ChannelLayout
impl Not for ChannelLayout
source§impl Octal for ChannelLayout
impl Octal for ChannelLayout
source§impl Ord for ChannelLayout
impl Ord for ChannelLayout
source§fn cmp(&self, other: &ChannelLayout) -> Ordering
fn cmp(&self, other: &ChannelLayout) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq for ChannelLayout
impl PartialEq for ChannelLayout
source§fn eq(&self, other: &ChannelLayout) -> bool
fn eq(&self, other: &ChannelLayout) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for ChannelLayout
impl PartialOrd for ChannelLayout
source§fn partial_cmp(&self, other: &ChannelLayout) -> Option<Ordering>
fn partial_cmp(&self, other: &ChannelLayout) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Sub for ChannelLayout
impl Sub for ChannelLayout
source§impl SubAssign for ChannelLayout
impl SubAssign for ChannelLayout
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.