ParameterEnumerationValues Struct Reference

#include <DistrhoPlugin.hpp>

Public Member Functions
	ParameterEnumerationValues () noexcept
	ParameterEnumerationValues (uint32_t c, bool r, ParameterEnumerationValue *v) noexcept

Public Attributes
uint8_t	count
bool	restrictedMode
ParameterEnumerationValue *	values

Detailed Description

Collection of parameter enumeration values.
Handy class to handle the lifetime and count of all enumeration values.

Constructor & Destructor Documentation

ParameterEnumerationValues() [1/2]

ParameterEnumerationValues::ParameterEnumerationValues ( )

inlinenoexcept

Default constructor, for zero enumeration values.

ParameterEnumerationValues() [2/2]

ParameterEnumerationValues::ParameterEnumerationValues ( uint32_t  c, bool  r, ParameterEnumerationValue *  v  )

inlinenoexcept

Constructor using custom values.
The pointer to @values must have been allocated on the heap with new.

Member Data Documentation

count

uint8_t ParameterEnumerationValues::count

Number of elements allocated in @values.

restrictedMode

bool ParameterEnumerationValues::restrictedMode

Wherever the host is to be restricted to only use enumeration values.

Note

This mode is only a hint! Not all hosts and plugin formats support this mode.

values

ParameterEnumerationValue* ParameterEnumerationValues::values

Array of @ParameterEnumerationValue items.
This pointer must be null or have been allocated on the heap with new ParameterEnumerationValue[count].

---

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

• distrho/DistrhoPlugin.hpp