Skip to main content

KnobDef

Struct KnobDef 

Source
pub struct KnobDef {
    pub param_id: u32,
    pub label: &'static str,
    pub widget: Option<WidgetKind>,
    pub span: u32,
    pub param_id_y: Option<u32>,
    pub meter_ids: Option<Vec<u32>>,
}
Expand description

A widget definition for the layout - either explicit type or auto-detected.

Fields§

§param_id: u32§label: &'static str§widget: Option<WidgetKind>

Explicit widget type override. None = auto-detect from param range.

§span: u32

How many grid columns this widget spans. Default = 1.

§param_id_y: Option<u32>

Second parameter ID for XY pad (Y axis). Ignored for other widgets.

§meter_ids: Option<Vec<u32>>

Multiple meter IDs for multi-channel level meter. Ignored for other widgets.

Implementations§

Source§

impl KnobDef

Source

pub fn knob(param_id: impl Into<u32>, label: &'static str) -> Self

Knob (default for continuous params, auto-detected anyway).

Source

pub fn slider(param_id: impl Into<u32>, label: &'static str) -> Self

Horizontal slider.

Source

pub fn toggle(param_id: impl Into<u32>, label: &'static str) -> Self

Toggle button.

Source

pub fn selector(param_id: impl Into<u32>, label: &'static str) -> Self

Selector (click-to-cycle for enum params).

Source

pub fn dropdown(param_id: impl Into<u32>, label: &'static str) -> Self

Dropdown list (click to open a popup showing all options).

Source

pub fn meter(ids: &[u32], label: &'static str) -> Self

Level meter with one or more channels (display-only, reads from Plugin::get_meter()).

Source

pub fn xy_pad( param_x: impl Into<u32>, param_y: impl Into<u32>, label: &'static str, ) -> Self

XY pad controlling two parameters.

Source

pub fn with_span(self, span: u32) -> Self

Set the column span for this widget (default 1).

Trait Implementations§

Source§

impl Clone for KnobDef

Source§

fn clone(&self) -> KnobDef

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KnobDef

Source§

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

Formats the value using the given formatter. Read more

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> 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> 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.