Struct ConstantMask 

pub struct ConstantMask(pub u64);

An optional optimization hint on which channels have all samples set to the same value. The first bit (0x1) is the first channel, the second bit is the second channel, and so on.

This can be useful for nodes that use audio buffers as CV (control voltage) ports.

Tuple Fields

0: u64

Implementations

impl ConstantMask

pub const NONE_CONSTANT: Self

A mask with no channels marked as constant

pub const MONO_CONSTANT: Self

A mask with only the first channel marked as constant

pub const STEREO_CONSTANT: Self

A mask with only the first two channels marked as constant

pub const fn new_all_constant(num_channels: usize) -> Self

Construct a new ConstantMask with all channels marked as constant.

num_channels must be less than or equal to 64.

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

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

i must be less than 64.

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

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

num_channels must be less than or equal to 64.

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

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

num_channels must be less than or equal to 64.

pub const fn range_constant(&self, range: Range<usize>) -> bool

Returns true if all channels in the given range are marked as constant, false otherwise.

This range must be in the range [0, 64]

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

Mark/un-mark the given channel as constant.

i must be less than 64.

pub const fn union(self, other: Self) -> Self

pub fn union_with(&mut self, other: Self)

pub fn to_silence_mask<V: AsRef<[f32]>>(self, channels: &[V]) -> SilenceMask

Convert this constant mask into a silence mask.

pub unsafe fn to_silence_mask_unchecked<V: AsRef<[f32]>>( self, channels: &[V], ) -> SilenceMask

Convert this constant mask into a silence mask, assuming that none of the slices in channels are empty.

Safety

All slices in channels must not be empty.

Trait Implementations

impl Clone for ConstantMask

fn clone(&self) -> ConstantMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConstantMask

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

Formats the value using the given formatter.

impl Default for ConstantMask

fn default() -> ConstantMask

Returns the “default value” for a type.

impl Hash for ConstantMask

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ConstantMask

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

impl Eq for ConstantMask

impl StructuralPartialEq for ConstantMask