Jamba C++ API  4.3.0
Parameters::JmbParamDefBuilder< T > Struct Template Reference

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

#include <Parameters.h>

Public Member Functions

JmbParam< T > add () const
 
JmbParamDefBuilderdefaultValue (T const &iDefaultValue)
 
JmbParamDefBuilderdeprecatedSince (int16 iVersion)
 
JmbParamDefBuilderguiOwned ()
 
JmbParamDefBuilderrtOwned ()
 
JmbParamDefBuilderserializer (std::shared_ptr< IParamSerializer< T >> iSerializer)
 
template<typename ParamSerializer , typename... Args>
JmbParamDefBuilderserializer (Args &&...iArgs)
 
JmbParamDefBuildershared (bool iShared=true)
 
JmbParamDefBuildertransient (bool iTransient=true)
 

Public Attributes

fDefaultValue {}
 
int16 fDeprecatedSince {IParamDef::kVersionNotDeprecated}
 
IParamDef::Owner fOwner {IParamDef::Owner::kGUI}
 
ParamID fParamID
 
std::shared_ptr< IParamSerializer< T > > fSerializer {}
 
bool fShared {false}
 
VstString16 fTitle
 
bool fTransient {false}
 

Protected Member Functions

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

Private Attributes

ParametersfParameters
 

Friends

class Parameters
 

Detailed Description

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

Implements the builder pattern for ease of build.

Template Parameters
Tthe underlying type of the param

Constructor & Destructor Documentation

◆ JmbParamDefBuilder()

JmbParamDefBuilder ( Parameters iParameters,
ParamID  iParamID,
VstString16  iTitle 
)
inlineprotected

Member Function Documentation

◆ add()

JmbParam< T > add ( ) const

◆ defaultValue()

JmbParamDefBuilder& defaultValue ( T const &  iDefaultValue)
inline

◆ deprecatedSince()

JmbParamDefBuilder& deprecatedSince ( int16  iVersion)
inline

◆ guiOwned()

JmbParamDefBuilder& guiOwned ( )
inline

◆ rtOwned()

JmbParamDefBuilder& rtOwned ( )
inline

◆ serializer() [1/2]

JmbParamDefBuilder& serializer ( std::shared_ptr< IParamSerializer< T >>  iSerializer)
inline

◆ serializer() [2/2]

JmbParamDefBuilder& serializer ( Args &&...  iArgs)
inline

◆ shared()

JmbParamDefBuilder& shared ( bool  iShared = true)
inline

◆ transient()

JmbParamDefBuilder& transient ( bool  iTransient = true)
inline

Friends And Related Function Documentation

◆ Parameters

friend class Parameters
friend

Member Data Documentation

◆ fDefaultValue

T fDefaultValue {}

◆ fDeprecatedSince

int16 fDeprecatedSince {IParamDef::kVersionNotDeprecated}

◆ fOwner

IParamDef::Owner fOwner {IParamDef::Owner::kGUI}

◆ fParameters

Parameters* fParameters
private

◆ fParamID

ParamID fParamID

◆ fSerializer

std::shared_ptr<IParamSerializer<T> > fSerializer {}

◆ fShared

bool fShared {false}

◆ fTitle

VstString16 fTitle

◆ fTransient

bool fTransient {false}

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