Skip to main content

KnobKind

Enum KnobKind 

Source
pub enum KnobKind {
Show 14 variants Bool { default: bool, }, OptBool { default: Option<bool>, }, I32 { default: i32, min: i32, max: i32, step: i32, }, OptI32 { default: Option<i32>, min: i32, max: i32, step: i32, }, F32 { default: f32, min: f32, max: f32, step: f32, }, OptF32 { default: Option<f32>, min: f32, max: f32, step: f32, }, Text { default: String, }, OptText { default: Option<String>, }, Choice { options: Vec<&'static str>, default: usize, }, Enum { enum_path: &'static str, variants: Vec<&'static str>, default: usize, }, TextRole { default: TextRole, }, SurfaceRole { default: SurfaceRole, }, BorderRole { default: BorderRole, }, TextStyle { default: TextStyleRole, },
}
Expand description

A typed knob declaration. Each kind maps 1:1 to a Signal<T> in KnobValues and to one row in the inspector’s auto-generated form.

Variants§

§

Bool

Fields

§default: bool
§

OptBool

Fields

§default: Option<bool>
§

I32

Fields

§default: i32
§min: i32
§max: i32
§step: i32
§

OptI32

Fields

§default: Option<i32>
§min: i32
§max: i32
§step: i32
§

F32

Fields

§default: f32
§min: f32
§max: f32
§step: f32
§

OptF32

Fields

§default: Option<f32>
§min: f32
§max: f32
§step: f32
§

Text

Fields

§default: String
§

OptText

Fields

§default: Option<String>
§

Choice

Position-based selection over a fixed list of labels.

Fields

§options: Vec<&'static str>
§default: usize
§

Enum

A Rust enum property: like Choice, but carries the enum’s path and variant idents so a design tool can render a dropdown and emit enum_path::variant. Stored at runtime as a usize index (like Choice).

Fields

§enum_path: &'static str
§variants: Vec<&'static str>
§default: usize
§

TextRole

Fields

§default: TextRole
§

SurfaceRole

Fields

§default: SurfaceRole
§

BorderRole

Fields

§default: BorderRole
§

TextStyle

Fields

Implementations§

Source§

impl KnobKind

Source

pub fn enum_info(&self) -> Option<EnumInfo>

For enum-typed knobs (Enum and the four role kinds), the data needed to render a dropdown + emit Path::Variant; None for scalar / text / label-only Choice kinds. The role variant lists come from teksilo_tokens, so they never drift from the actual enums.

Trait Implementations§

Source§

impl Clone for KnobKind

Source§

fn clone(&self) -> KnobKind

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 KnobKind

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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.