Struct Periodic

pub struct Periodic<'a> { /* private fields */ }

Implementations

impl<'a> Periodic<'a>

pub fn simple(waveform: Waveform, period: u16, magnitude: i16) -> Periodic<'a>

pub fn custom(data: &'a [i16]) -> Periodic<'a>

pub fn waveform(&self) -> Waveform

pub fn period(&self) -> u16

pub fn magnitude(&self) -> i16

pub fn offset(&self) -> i16

pub fn phase(&self) -> u16

The phase offset in the effect’s Waveform where playback will begin.

pub fn envelope(&self) -> Envelope

pub fn with_envelope(self, env: Envelope) -> Self

pub fn custom_data(&self) -> Option<&'a [i16]>

If this effect has any custom waveform data attached to it, returns a reference to that data.

Also see Periodic::custom for how to create such an effect.

Trait Implementations

impl<'a> Clone for Periodic<'a>

fn clone(&self) -> Periodic<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Periodic<'_>

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

Formats the value using the given formatter.

impl<'a> From<Periodic<'a>> for Effect<'a>

fn from(value: Periodic<'a>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for Periodic<'a>

fn eq(&self, other: &Periodic<'a>) -> 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<'a> Copy for Periodic<'a>

impl<'a> Eq for Periodic<'a>

impl<'a> StructuralPartialEq for Periodic<'a>