Struct PulseDrumGrid 

pub struct PulseDrumGrid { /* private fields */ }

A step-based drum arrangement rendered into a tunes composition track.

Implementations

impl PulseDrumGrid

pub fn new() -> Self

Creates a 16-step drum grid named drums with eighth-note steps.

pub fn with_track(self, track_name: impl Into<String>) -> Self

Sets the output track name.

pub fn with_steps(self, steps: usize) -> PulseResult<Self>

Sets the number of steps in the grid.

Errors

Returns an error when steps is zero.

pub fn with_step_duration(self, duration: f32) -> PulseResult<Self>

Sets the duration of one grid step in beats.

Errors

Returns an error when duration is zero, negative, or not finite.

pub fn sound( self, drum: impl Into<String>, pattern: Vec<usize>, ) -> PulseResult<Self>

Adds a drum alias and zero-based step pattern.

Errors

Returns an error when drum is not in the drum catalog.

pub fn accent(self, pattern: Vec<usize>) -> Self

Sets accent steps that raise matching drum hit velocities.

pub fn velocity(self, velocities: Vec<f32>) -> Self

Sets per-step velocity multipliers.

pub fn with_repeat(self, repeats: usize) -> Self

Sets additional grid repetitions after the first pass.

pub fn with_repeat_times(self, repeat_times: usize) -> PulseResult<Self>

Sets how many total times the grid should play.

Errors

Returns an error when repeat_times is zero.

pub fn with_effect(self, effect: PulseEffect) -> Self

Adds a track-level effect to the drum grid.

pub fn with_volume(self, volume: f32) -> PulseResult<Self>

Sets the exported drum track volume.

Errors

Returns an error when volume is outside 0..=2.

pub fn with_pan(self, pan: f32) -> PulseResult<Self>

Sets the exported drum track stereo pan.

Errors

Returns an error when pan is outside -1..=1.

pub fn apply_to_composition( &self, composition: &mut Composition, ) -> PulseResult<()>

Applies the grid to a composition starting at time zero.

Errors

Returns an error when stored grid options are invalid.

pub fn apply_to_composition_at( &self, composition: &mut Composition, start_at: f32, ) -> PulseResult<()>

Applies the grid to a composition at an absolute start offset in beats.

Errors

Returns an error when stored grid options are invalid.

pub fn track_name(&self) -> &str

Returns the output track name.

pub fn steps(&self) -> usize

Returns the number of steps.

pub fn step_duration(&self) -> f32

Returns the duration of one grid step in beats.

pub fn hits(&self) -> &[PulseDrumHit]

Returns all drum hit patterns.

pub fn repeats(&self) -> usize

Returns additional repeat count.

pub fn duration(&self) -> f32

Returns total grid duration in beats after repeats.

pub fn effects(&self) -> &[PulseEffect]

Returns track-level effects in insertion order.

pub fn volume(&self) -> f32

Returns track volume.

pub fn pan(&self) -> f32

Returns track stereo pan.

Trait Implementations

impl Clone for PulseDrumGrid

fn clone(&self) -> PulseDrumGrid

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PulseDrumGrid

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

Formats the value using the given formatter.

impl Default for PulseDrumGrid

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for PulseDrumGrid

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

impl UserData for PulseDrumGrid

fn add_methods<M: UserDataMethods<Self>>(methods: &mut M)

Adds custom methods and operators specific to this userdata.

fn add_fields<F>(fields: &mut F)

where F: UserDataFields<Self>,

Adds custom fields specific to this userdata.

fn register(registry: &mut UserDataRegistry<Self>)

Registers this type for use in Lua.