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, int16 const iDeprecatedSince)
ParamValue	readFromState (NormalizedState const &iState) const
	Read the value from the (normalized) state.
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.
tresult	writeToState (ParamValue iValue, NormalizedState &oState) const
	Writes the provided value to the (normalized) state.
Public Member Functions inherited from IParamDef
	IParamDef (ParamID const iParamID, VstString16 iTitle, Owner const iOwner, bool const iTransient, int16 const iDeprecatedSince)
bool	isDeprecated () const
	Returns true if the parameter is deprecated (meaning it can only be used to upgrade to latest version).
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 int16	fDeprecatedSince
const Owner	fOwner
const ParamID	fParamID
const VstString16	fTitle
const bool	fTransient

Additional Inherited Members
Public Types inherited from IParamDef
enum class	Owner { kRT , kGUI }
	Who owns the parameter (mostly for state saving purposes). More...
Static Public Attributes inherited from IParamDef
static constexpr int16	kVersionNotDeprecated = -1
	Special version indicating the parameter is not deprecated.

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, int16 const iDeprecatedSince )

inline

Member Function Documentation

readFromState()

ParamValue readFromState ( NormalizedState const & iState ) const

inline

Read the value from the (normalized) state.

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

iNormalizedValue	the (normalized) value to process
iPrecision	if < 0 uses fPrecision otherwise use the one provided

Reimplemented in VstParamDef< T >.

writeToState()

tresult writeToState ( ParamValue iValue, NormalizedState & oState ) const

inline

Writes the provided value to the (normalized) state.

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:

• pongasoft/VST/ParamDef.h