Struct cubeb_backend::ChannelLayout

pub struct ChannelLayout { /* fields omitted */ }

Some common layout definitions

Methods

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

impl ChannelLayout

pub fn num_channels(&self) -> u32

impl ChannelLayout

pub const FRONT_LEFT: ChannelLayout

pub const FRONT_RIGHT: ChannelLayout

pub const FRONT_CENTER: ChannelLayout

pub const LOW_FREQUENCY: ChannelLayout

pub const BACK_LEFT: ChannelLayout

pub const BACK_RIGHT: ChannelLayout

pub const FRONT_LEFT_OF_CENTER: ChannelLayout

pub const FRONT_RIGHT_OF_CENTER: ChannelLayout

pub const BACK_CENTER: ChannelLayout

pub const SIDE_LEFT: ChannelLayout

pub const SIDE_RIGHT: ChannelLayout

pub const TOP_CENTER: ChannelLayout

pub const TOP_FRONT_LEFT: ChannelLayout

pub const TOP_FRONT_CENTER: ChannelLayout

pub const TOP_FRONT_RIGHT: ChannelLayout

pub const TOP_BACK_LEFT: ChannelLayout

pub const TOP_BACK_CENTER: ChannelLayout

pub const TOP_BACK_RIGHT: ChannelLayout

pub const fn empty() -> ChannelLayout

Returns an empty set of flags

pub const fn all() -> ChannelLayout

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

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl BitOr<ChannelLayout> for ChannelLayout

type Output = ChannelLayout

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl Eq for ChannelLayout

impl Binary for ChannelLayout

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

Formats the value using the given formatter.

impl BitOrAssign<ChannelLayout> for ChannelLayout

fn bitor_assign(&mut self, other: ChannelLayout)

Adds the set of flags.

impl Copy for ChannelLayout

impl SubAssign<ChannelLayout> for ChannelLayout

fn sub_assign(&mut self, other: ChannelLayout)

Disables all flags enabled in the set.

impl FromIterator<ChannelLayout> for ChannelLayout

fn from_iter<T>(iterator: T) -> ChannelLayout where
    T: IntoIterator<Item = ChannelLayout>, 

Creates a value from an iterator.

impl Not for ChannelLayout

type Output = ChannelLayout

The resulting type after applying the ! operator.

fn not(self) -> ChannelLayout

Returns the complement of this set of flags.

impl Clone for ChannelLayout

fn clone(&self) -> ChannelLayout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl BitXor<ChannelLayout> for ChannelLayout

type Output = ChannelLayout

The resulting type after applying the ^ operator.

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

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

impl PartialEq<ChannelLayout> for ChannelLayout

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

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

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

This method tests for !=.

impl BitAndAssign<ChannelLayout> for ChannelLayout

fn bitand_assign(&mut self, other: ChannelLayout)

Disables all flags disabled in the set.

impl Octal for ChannelLayout

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

Formats the value using the given formatter.

impl BitXorAssign<ChannelLayout> for ChannelLayout

fn bitxor_assign(&mut self, other: ChannelLayout)

Toggles the set of flags.

impl PartialOrd<ChannelLayout> for ChannelLayout

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

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

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

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

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

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

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

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

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

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

impl UpperHex for ChannelLayout

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

Formats the value using the given formatter.

impl Extend<ChannelLayout> for ChannelLayout

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

Extends a collection with the contents of an iterator.

impl Sub<ChannelLayout> for ChannelLayout

type Output = ChannelLayout

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl Hash for ChannelLayout

fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

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 Debug for ChannelLayout

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

Formats the value using the given formatter.

impl Ord for ChannelLayout

fn cmp(&self, other: &ChannelLayout) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl Into<u32> for ChannelLayout

fn into(self) -> u32

Performs the conversion.

impl LowerHex for ChannelLayout

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

Formats the value using the given formatter.

impl From<u32> for ChannelLayout

fn from(x: u32) -> ChannelLayout

Performs the conversion.

impl BitAnd<ChannelLayout> for ChannelLayout

type Output = ChannelLayout

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.