Enum hapi_rs::parameter::Parameter

pub enum Parameter {
    Float(FloatParameter),
    Int(IntParameter),
    String(StringParameter),
    Button(IntParameter),
    Other(BaseParameter),
}

Enum of different parameter types.

Variants

Float(FloatParameter)

ParmType::Float | ParmType::Color

Int(IntParameter)

ParmType::Int | ParmType::Toggle

String(StringParameter)

ParmType::String | ParmType::Node | ParmType::PathFile | ParmType::PathFileDir | ParmType::PathFileGeo | ParmType::PathFileImage

Button(IntParameter)

ParmType::Int

Other(BaseParameter)

Other ParmType::_

Implementations

impl Parameter

pub fn info(&self) -> &ParmInfo

Information about the parameter

pub fn name(&self) -> Result<String>

Parameter internal name

pub fn label(&self) -> Result<String>

Parameter UI label

pub fn size(&self) -> i32

Number or elements in the parameter

pub fn parent(&self) -> Result<Option<ParmInfo>>

Parameter parent if any (examples are multi-parm or Folder type parameters)

Trait Implementations

impl Debug for Parameter

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

Formats the value using the given formatter.