Struct SilenceMask

pub struct SilenceMask(pub u64);

An optional optimization hint on which channels contain all zeros (silence). The first bit (0x1) is the first channel, the second bit is the second channel, and so on.

Tuple Fields

0: u64

Implementations

impl SilenceMask

pub const NONE_SILENT: Self

A mask with no channels marked as silent

pub const MONO_SILENT: Self

A mask with only the first channel marked as silent

pub const STEREO_SILENT: Self

A mask with only the first two channels marked as silent

pub const fn is_channel_silent(&self, i: usize) -> bool

Returns true if the channel is marked as silent, false otherwise.

i must be less than 64.

pub const fn any_channel_silent(&self, num_channels: usize) -> bool

Returns true if any channel is marked as silent, false otherwise.

num_channels must be less than 64.

pub const fn all_channels_silent(&self, num_channels: usize) -> bool

Returns true if all channels are marked as silent, false otherwise.

num_channels must be less than 64.

pub fn set_channel(&mut self, i: usize, silent: bool)

Mark/un-mark the given channel as silent.

num_channels must be less than 64.

Trait Implementations

impl Clone for SilenceMask

fn clone(&self) -> SilenceMask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SilenceMask

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

Formats the value using the given formatter.

impl Default for SilenceMask

fn default() -> SilenceMask

Returns the “default value” for a type.

impl PartialEq for SilenceMask

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SilenceMask

impl Eq for SilenceMask

impl StructuralPartialEq for SilenceMask