livido_parameter_template Struct Reference
[Parameters]

#include <livido.h>

---

Detailed Description

template provided by the plugin to describe its public parameters

This structure holds some variables that are interesting for the user interface, to render triggable realtime by users.

Definition at line 629 of file livido.h.

Data Fields
const char *	name
	name of the parameter
const char *	description
	description of the parameter
const char *	format
	parameter rendering description
const int	type
	the parameter type (i.e LIVIDO_PARAM_SWITCH)
const int	flags
	flags of parameter (i.e #LIVIDO_PARAM_NEEDS_INIT)
const int	decimals
	how many decimals after the floating point
const char *	list_values
	multiple values list or NULL
const char *	def
	default value, rendered conforming to the format
const double	min
	minimum value for numerical parameters
const double	max
	maximum value for numerical parameters
const double	step
	step increment for value in numerical parameters
const char *	hint
	layout hints for the GUI renderer
const void *	extra
	for future expansion
livido_parameter_template *	next
	pointer to the next element in the list, NULL if end
char	reserved [64]
	reserved space for binary compatibility thru versions

---

Field Documentation

const char* livido_parameter_template::description

description of the parameter the description should explain what the parameter does, it can be multilined. Definition at line 635 of file livido.h.

const char* livido_parameter_template::hint

layout hints for the GUI renderer hints are supposed to use some keyword system to describe the way a GUI should be rendered in order to modify the parameter, e.g: layout|p1|fill|p2 special|aspect|1|2 there will be a separate document about the hint system which is being implemented in the livido library Definition at line 661 of file livido.h.

const char* livido_parameter_template::name

name of the parameter name should be short. lowercase. do not put in the words like "plugin" or "filter", but rather the name of the thing Definition at line 632 of file livido.h.

---

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

• livido.h

---