Parameters::VstParamDefBuilder< T > Struct Template Reference

Implements the builder pattern for ease of build. More...

#include <Parameters.h>

Public Member Functions
VstParam< T >	add () const
template<typename ParamConverter, typename... Args>
VstParamDefBuilder &	converter (Args &&...iArgs)
VstParamDefBuilder &	converter (std::shared_ptr< IParamConverter< T > > iConverter)
VstParamDefBuilder &	defaultValue (T const &iDefaultValue)
VstParamDefBuilder &	deprecatedSince (int16 iVersion)
VstParamDefBuilder &	flags (int32 iFlags)
VstParamDefBuilder &	guiOwned ()
VstParamDefBuilder &	precision (int32 iPrecision)
VstParamDefBuilder &	rtOwned ()
VstParamDefBuilder &	shortTitle (VstString16 iShortTitle)
VstParamDefBuilder &	transient (bool iTransient=true)
VstParamDefBuilder &	unitID (int32 iUnitID)
VstParamDefBuilder &	units (VstString16 iUnits)

Public Attributes
std::shared_ptr< IParamConverter< T > >	fConverter {}
T	fDefaultValue {}
int16	fDeprecatedSince {IParamDef::kVersionNotDeprecated}
int32	fFlags {ParameterInfo::kCanAutomate}
IParamDef::Owner	fOwner {IParamDef::Owner::kRT}
ParamID	fParamID
int32	fPrecision {4}
VstString16	fShortTitle {}
VstString16	fTitle
bool	fTransient {false}
UnitID	fUnitID {kRootUnitId}
VstString16	fUnits {}

Protected Member Functions
	VstParamDefBuilder (Parameters *iParameters, ParamID iParamID, VstString16 iTitle)

Private Attributes
Parameters *	fParameters

Friends
class	Parameters

Detailed Description

template<typename T>
struct pongasoft::VST::Parameters::VstParamDefBuilder< T >

Implements the builder pattern for ease of build.

Template Parameters

T	the underlying type of the param

Constructor & Destructor Documentation

VstParamDefBuilder()

template<typename T>

VstParamDefBuilder ( Parameters * iParameters, ParamID iParamID, VstString16 iTitle )

inlineprotected

Member Function Documentation

add()

template<typename T>

VstParam< T > add

(

)

const

converter() [1/2]

template<typename T>

template<typename ParamConverter, typename... Args>

VstParamDefBuilder & converter ( Args &&... iArgs )

inline

converter() [2/2]

template<typename T>

VstParamDefBuilder & converter ( std::shared_ptr< IParamConverter< T > > iConverter )

inline

defaultValue()

template<typename T>

VstParamDefBuilder & defaultValue ( T const & iDefaultValue )

inline

deprecatedSince()

template<typename T>

VstParamDefBuilder & deprecatedSince ( int16 iVersion )

inline

flags()

template<typename T>

VstParamDefBuilder & flags ( int32 iFlags )

inline

guiOwned()

template<typename T>

VstParamDefBuilder & guiOwned ( )

inline

precision()

template<typename T>

VstParamDefBuilder & precision ( int32 iPrecision )

inline

rtOwned()

template<typename T>

VstParamDefBuilder & rtOwned ( )

inline

shortTitle()

template<typename T>

VstParamDefBuilder & shortTitle ( VstString16 iShortTitle )

inline

transient()

template<typename T>

VstParamDefBuilder & transient ( bool iTransient = true )

inline

unitID()

template<typename T>

VstParamDefBuilder & unitID ( int32 iUnitID )

inline

units()

template<typename T>

VstParamDefBuilder & units ( VstString16 iUnits )

inline

Friends And Related Symbol Documentation

Parameters

template<typename T>

friend class Parameters

friend

Member Data Documentation

fConverter

template<typename T>

std::shared_ptr<IParamConverter<T> > fConverter {}

fDefaultValue

template<typename T>

T fDefaultValue {}

fDeprecatedSince

template<typename T>

int16 fDeprecatedSince {IParamDef::kVersionNotDeprecated}

fFlags

template<typename T>

int32 fFlags {ParameterInfo::kCanAutomate}

fOwner

template<typename T>

IParamDef::Owner fOwner {IParamDef::Owner::kRT}

fParameters

template<typename T>

Parameters* fParameters

private

fParamID

template<typename T>

ParamID fParamID

fPrecision

template<typename T>

int32 fPrecision {4}

fShortTitle

template<typename T>

VstString16 fShortTitle {}

fTitle

template<typename T>

VstString16 fTitle

fTransient

template<typename T>

bool fTransient {false}

fUnitID

template<typename T>

UnitID fUnitID {kRootUnitId}

fUnits

template<typename T>

VstString16 fUnits {}

---

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

• pongasoft/VST/Parameters.h