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
VstParamDefBuilder &	converter (std::shared_ptr< IParamConverter< T >> iConverter)
template<typename ParamConverter , typename... Args>
VstParamDefBuilder &	converter (Args &&...iArgs)
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()

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

inlineprotected

Member Function Documentation

add()

VstParam< T > add

(

)

const

converter() [1/2]

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

inline

converter() [2/2]

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

inline

defaultValue()

VstParamDefBuilder& defaultValue ( T const &  iDefaultValue )

inline

deprecatedSince()

VstParamDefBuilder& deprecatedSince ( int16  iVersion )

inline

flags()

VstParamDefBuilder& flags ( int32  iFlags )

inline

guiOwned()

VstParamDefBuilder& guiOwned ( )

inline

precision()

VstParamDefBuilder& precision ( int32  iPrecision )

inline

rtOwned()

VstParamDefBuilder& rtOwned ( )

inline

shortTitle()

VstParamDefBuilder& shortTitle ( VstString16  iShortTitle )

inline

transient()

VstParamDefBuilder& transient ( bool  iTransient = true )

inline

unitID()

VstParamDefBuilder& unitID ( int32  iUnitID )

inline

units()

VstParamDefBuilder& units ( VstString16  iUnits )

inline

Friends And Related Function Documentation

Parameters

friend class Parameters

friend

Member Data Documentation

fConverter

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

fDefaultValue

T fDefaultValue {}

fDeprecatedSince

int16 fDeprecatedSince {IParamDef::kVersionNotDeprecated}

fFlags

int32 fFlags {ParameterInfo::kCanAutomate}

fOwner

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

fParameters

Parameters* fParameters

private

fParamID

ParamID fParamID

fPrecision

int32 fPrecision {4}

fShortTitle

VstString16 fShortTitle {}

fTitle

VstString16 fTitle

fTransient

bool fTransient {false}

fUnitID

UnitID fUnitID {kRootUnitId}

fUnits

VstString16 fUnits {}

---

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

• pongasoft/VST/Parameters.h