Poly

Struct Poly 

Source
pub struct Poly<V, const MAX_VOICES: usize = 32> { /* private fields */ }
Expand description

A helper struct for implementing polyphonic synths.

This struct handles common tasks such as routing events to voices, updating note expression curves, and mixing the output of voices.

To use it, you must implement the Voice trait for your synth. Then, use the methods on this struct to implement the required [conformal_component::synth::Synth] trait methods.

Implementations§

Source§

impl<V: Voice, const MAX_VOICES: usize> Poly<V, MAX_VOICES>

Source

pub fn new(environment: &ProcessingEnvironment) -> Self

Creates a new Poly struct.

Source

pub fn handle_events(&mut self, context: &impl HandleEventsContext)

Handles a set of events without rendering audio.

This can be used to implement [conformal_component::synth::Synth::handle_events].

Source

pub fn process( &mut self, context: &impl ProcessContext, shared_data: &V::SharedData<'_>, output: &mut impl BufferMut, )

Renders the audio for the synth.

This can be used to implement [conformal_component::synth::Synth::process]. For any voices with active notes, Voice::process will be called.

Source

pub fn reset(&mut self)

Resets the state of the polyphonic synth.

This can be used to implement [conformal_component::Processor::set_processing].

Trait Implementations§

Source§

impl<V: Debug, const MAX_VOICES: usize> Debug for Poly<V, MAX_VOICES>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<V, const MAX_VOICES: usize> Freeze for Poly<V, MAX_VOICES>

§

impl<V, const MAX_VOICES: usize> RefUnwindSafe for Poly<V, MAX_VOICES>
where V: RefUnwindSafe,

§

impl<V, const MAX_VOICES: usize> Send for Poly<V, MAX_VOICES>
where V: Send,

§

impl<V, const MAX_VOICES: usize> Sync for Poly<V, MAX_VOICES>
where V: Sync,

§

impl<V, const MAX_VOICES: usize> Unpin for Poly<V, MAX_VOICES>
where V: Unpin,

§

impl<V, const MAX_VOICES: usize> UnwindSafe for Poly<V, MAX_VOICES>
where V: UnwindSafe,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. 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.