Struct ParamGestureBeginEvent 

pub struct ParamGestureBeginEvent { /* private fields */ }

Indicates that the user started adjusting a knob or parameter value.

For the event to raise when the user finishes this adjustment, see ParamGestureEndEvent.

Implementations

impl ParamGestureBeginEvent

pub const fn new(time: u32, param_id: ClapId) -> ParamGestureBeginEvent

Creates a new ParamGestureBeginEvent from a time stamp and a parameter ID.

pub const fn param_id(&self) -> Option<ClapId>

Returns the parameter ID this event targets.

This returns None if the parameter ID is invalid.

pub fn set_param_id(&mut self, param_id: ClapId)

Sets the parameter ID this event targets.

pub const fn with_param_id(self, param_id: ClapId) -> ParamGestureBeginEvent

Builds a ParamGestureBeginEvent with the given parameter ID target, and returns it.

This is useful to use in a builder-style pattern.

Trait Implementations

impl AsRef<UnknownEvent> for ParamGestureBeginEvent

fn as_ref(&self) -> &UnknownEvent

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ParamGestureBeginEvent

fn clone(&self) -> ParamGestureBeginEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ParamGestureBeginEvent

impl Debug for ParamGestureBeginEvent

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

Formats the value using the given formatter.

impl Event for ParamGestureBeginEvent

const TYPE_ID: u16 = CLAP_EVENT_PARAM_GESTURE_BEGIN

The raw event type identifier for this event type.

type EventSpace<'a> = CoreEventSpace<'a>

The event space this event type is a part of.

fn flags(&self) -> EventFlags

Returns the EventFlags of this event.

fn set_flags(&mut self, flags: EventFlags)

Sets the EventFlags of this event.

fn with_flags(self, flags: EventFlags) -> Self

Builds an event with the given EventFlags, and returns it.

fn time(&self) -> u32

Returns the time stamp of this event, in samples.

fn set_time(&mut self, time: u32)

Sets the time stamp of this event, in samples.

fn with_time(self, time: u32) -> Self

Builds an event with the given time stamp, and returns it.

fn header(&self) -> &EventHeader<Self>

Returns a shared, immutable reference to this event’s header.

fn header_mut(&mut self) -> &mut EventHeader<Self>

Returns an exclusive, mutable reference to this event’s header.

fn as_unknown(&self) -> &UnknownEvent

Returns this event as a type-erased UnknownEvent.

fn raw_header(&self) -> &clap_event_header

Returns a shared, immutable reference to the raw, C-FFI compatible representation of this header’s event.

unsafe fn raw_header_mut(&mut self) -> &mut clap_event_header

Returns an exclusive, mutable reference to the raw, C-FFI compatible representation of this header’s event.

impl PartialEq for ParamGestureBeginEvent

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

Equality operator ==.

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

Inequality operator !=.