calf_plugins::parameter_properties Struct Reference

Range, default value, flags and names for a parameter. More...

#include <giface.h>

Public Member Functions
float	from_01 (double value01) const
	convert from [0, 1] range to [min, max] (applying scaling)
double	to_01 (float value) const
	convert from [min, max] to [0, 1] range (applying reverse scaling)
std::string	to_string (float value) const
	stringify (in sensible way)
float	string_to_value (const char *string) const
	convert string (from text entry) to value
int	get_char_count () const
	get required width (for reserving GUI space)
float	get_increment () const
	get increment step based on step value (if specified) and other factors

Public Attributes
float	def_value
	default value
float	min
	minimum value
float	max
	maximum value
float	step
	number of steps (for an integer value from 0 to 100 this will be 101; for 0/90/180/270/360 this will be 5), or 0 for continuous
uint32_t	flags
	logical OR of parameter_flags
const char **	choices
	for PF_ENUM: array of text values (from min to max step 1), otherwise NULL
const char *	short_name
	parameter label (for use in LV2 label field etc.)
const char *	name
	parameter human-readable name

Detailed Description

Range, default value, flags and names for a parameter.

Member Function Documentation

from_01()

float parameter_properties::from_01

(

double

value01

)

const

convert from [0, 1] range to [min, max] (applying scaling)

get_char_count()

int parameter_properties::get_char_count

(

)

const

get required width (for reserving GUI space)

get_increment()

float parameter_properties::get_increment

(

)

const

get increment step based on step value (if specified) and other factors

string_to_value()

float parameter_properties::string_to_value

(

const char *

string

)

const

convert string (from text entry) to value

to_01()

double parameter_properties::to_01

(

float

value

)

const

convert from [min, max] to [0, 1] range (applying reverse scaling)

to_string()

std::string parameter_properties::to_string

(

float

value

)

const

stringify (in sensible way)

Member Data Documentation

choices

const char** calf_plugins::parameter_properties::choices

for PF_ENUM: array of text values (from min to max step 1), otherwise NULL

def_value

float calf_plugins::parameter_properties::def_value

default value

flags

uint32_t calf_plugins::parameter_properties::flags

logical OR of parameter_flags

max

float calf_plugins::parameter_properties::max

maximum value

min

float calf_plugins::parameter_properties::min

minimum value

name

const char* calf_plugins::parameter_properties::name

parameter human-readable name

short_name

const char* calf_plugins::parameter_properties::short_name

parameter label (for use in LV2 label field etc.)

step

float calf_plugins::parameter_properties::step

number of steps (for an integer value from 0 to 100 this will be 101; for 0/90/180/270/360 this will be 5), or 0 for continuous

---

The documentation for this struct was generated from the following files:

• /home/runner/work/lmms-fork/lmms-fork/plugins/LadspaEffect/calf/veal/src/calf/giface.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/LadspaEffect/calf/veal/src/giface.cpp