Jamba C++ API  4.0.0
RawVstParamDef Class Reference

Base class for a raw vst parameter definition. More...

#include <ParamDef.h>

Inherits IParamDef.

Inherited by VstParamDef< T >.

Public Member Functions

 RawVstParamDef (ParamID const iParamID, VstString16 iTitle, VstString16 iUnits, ParamValue const iDefaultNormalizedValue, int32 const iStepCount, int32 const iFlags, UnitID const iUnitID, VstString16 iShortTitle, int32 const iPrecision, Owner const iOwner, bool const iTransient)
 
ParamValue readFromStream (IBStreamer &iStreamer) const
 
virtual void toString (ParamValue iNormalizedValue, String128 iString) const
 
virtual std::string toUTF8String (ParamValue iNormalizedValue, int32 iPrecision) const
 Return the value as a utf-8 string. More...
 
- Public Member Functions inherited from IParamDef
 IParamDef (ParamID const iParamID, VstString16 iTitle, Owner const iOwner, bool const iTransient)
 
virtual ~IParamDef ()=default
 

Public Attributes

const ParamValue fDefaultValue
 
const int32 fFlags
 
const int32 fPrecision
 
const VstString16 fShortTitle
 
const int32 fStepCount
 
const UnitID fUnitID
 
const VstString16 fUnits
 
- Public Attributes inherited from IParamDef
const Owner fOwner
 
const ParamID fParamID
 
const VstString16 fTitle
 
const bool fTransient
 

Additional Inherited Members

- Public Types inherited from IParamDef
enum  Owner { kRT, kGUI }
 

Detailed Description

Base class for a raw vst parameter definition.

Constructor & Destructor Documentation

◆ RawVstParamDef()

RawVstParamDef ( ParamID const  iParamID,
VstString16  iTitle,
VstString16  iUnits,
ParamValue const  iDefaultNormalizedValue,
int32 const  iStepCount,
int32 const  iFlags,
UnitID const  iUnitID,
VstString16  iShortTitle,
int32 const  iPrecision,
Owner const  iOwner,
bool const  iTransient 
)
inline

Member Function Documentation

◆ readFromStream()

ParamValue readFromStream ( IBStreamer &  iStreamer) const
inline

◆ toString()

virtual void toString ( ParamValue  iNormalizedValue,
String128  iString 
) const
inlinevirtual

Reimplemented in VstParamDef< T >.

◆ toUTF8String()

virtual std::string toUTF8String ( ParamValue  iNormalizedValue,
int32  iPrecision 
) const
inlinevirtual

Return the value as a utf-8 string.

Parameters
iNormalizedValuethe (normalized) value to process
iPrecisionif < 0 uses fPrecision otherwise use the one provided

Reimplemented in VstParamDef< T >.

Member Data Documentation

◆ fDefaultValue

const ParamValue fDefaultValue

◆ fFlags

const int32 fFlags

◆ fPrecision

const int32 fPrecision

◆ fShortTitle

const VstString16 fShortTitle

◆ fStepCount

const int32 fStepCount

◆ fUnitID

const UnitID fUnitID

◆ fUnits

const VstString16 fUnits

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