ProcessStatus

firewheel_core::node

Enum ProcessStatus 

Source 
pub enum ProcessStatus {
    ClearAllOutputs,
    Bypass,
    OutputsModified,
    OutputsModifiedWithMask(MaskType),
}
Expand description

The status of processing buffers in an audio node.

Variants§

§

ClearAllOutputs

No output buffers were modified. If this is returned, then the engine will automatically clear all output buffers for you as efficiently as possible.

§

Bypass

No output buffers were modified. If this is returned, then the engine will automatically copy the input buffers to their corresponding output buffers for you as efficiently as possible.

§

OutputsModified

All output buffers were filled with data.

WARNING: The node must fill all audio audio output buffers completely with data when returning this process status. Failing to do so will result in audio glitches.

§

OutputsModifiedWithMask(MaskType)

All output buffers were filled with data. Additionally, a constant/silence mask is provided for optimizations.

WARNING: The node must fill all audio audio output buffers completely with data when returning this process status. Failing to do so will result in audio glitches.

WARNING: Incorrectly marking a channel as containing silence/constant values when it doesn’t will result in audio glitches. Please take great care when using this, or use ProcessStatus::OutputsModified instead.

Implementations§

Source§

impl ProcessStatus

Source

pub const fn outputs_modified_with_silence_mask(mask: SilenceMask) -> Self

All output buffers were filled with data. Additionally, a constant/silence mask is provided for optimizations.

WARNING: The node must fill all audio audio output buffers completely with data when returning this process status. Failing to do so will result in audio glitches.

WARNING: Incorrectly marking a channel as containing silence when it doesn’t will result in audio glitches. Please take great care when using this, or use ProcessStatus::OutputsModified instead.

Source

pub const fn outputs_modified_with_constant_mask(mask: ConstantMask) -> Self

All output buffers were filled with data. Additionally, a constant/silence mask is provided for optimizations.

WARNING: The node must fill all audio audio output buffers completely with data when returning this process status. Failing to do so will result in audio glitches.

WARNING: Incorrectly marking a channel as containing constant values when it doesn’t will result in audio glitches. Please take great care when using this, or use ProcessStatus::OutputsModified instead.

Trait Implementations§

Source§

impl Clone for ProcessStatus

Source§

fn clone(&self) -> ProcessStatus

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ProcessStatus

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ProcessStatus

Source§

fn default() -> ProcessStatus

Returns the “default value” for a type. Read more
Source§

impl PartialEq for ProcessStatus

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Copy for ProcessStatus

Source§

impl Eq for ProcessStatus

Source§

impl StructuralPartialEq for ProcessStatus

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DynEq for T
where T: Any + Eq,

Source§

fn dyn_eq(&self, other: &(dyn DynEq + 'static)) -> bool

This method tests for self and other values to be equal. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromWorld for T
where T: Default,

Source§

fn from_world(_world: &mut World) -> T

Creates Self using default().

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoResult<T> for T

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<A> Is for A
where A: Any,

Source§

fn is<T>() -> bool
where T: Any,

Checks if the current type “is” another type, using a TypeId equality comparison. This is most useful in the context of generic logic. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> TypeData for T
where T: 'static + Send + Sync + Clone,

Source§

fn clone_type_data(&self) -> Box<dyn TypeData>

Creates a type-erased clone of this value.
Source§

impl<T> ConditionalSend for T
where T: Send,