Dusk Audio Framework
Loading...
Searching...
No Matches
ParameterEnumerationValues Struct Reference

#include <DafDetails.hpp>

Public Member Functions

constexpr ParameterEnumerationValues () noexcept
constexpr ParameterEnumerationValues (uint8_t c, bool r, ParameterEnumerationValue *v) noexcept

Public Attributes

uint8_t count
bool restrictedMode
ParameterEnumerationValue * values
bool deleteLater

Detailed Description

Details around parameter enumeration values.
Wraps ParameterEnumerationValues and provides a few extra details to the host about these values.

Constructor & Destructor Documentation

◆ ParameterEnumerationValues() [1/2]

ParameterEnumerationValues::ParameterEnumerationValues ( )
inlineconstexprnoexcept

Default constructor, for zero enumeration values.

◆ ParameterEnumerationValues() [2/2]

ParameterEnumerationValues::ParameterEnumerationValues ( uint8_t c,
bool r,
ParameterEnumerationValue * v )
inlineconstexprnoexcept

Constructor using custom values.
When using this constructor the pointer to @values MUST have been statically declared.
It will not be automatically deleted later.

Member Data Documentation

◆ count

uint8_t ParameterEnumerationValues::count

Number of elements allocated in @values.

◆ restrictedMode

bool ParameterEnumerationValues::restrictedMode

Whether 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.
When assigning this pointer manually, it must be allocated on the heap with new ParameterEnumerationValue[count].
The array pointer will be automatically deleted later unless deleteLater is set to false.

◆ deleteLater

bool ParameterEnumerationValues::deleteLater

Whether to take ownership of the values pointer.
Defaults to true unless stated otherwise.


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