IParamDef Class Reference

Base class for all ParamDef. More...

#include <ParamDef.h>

Inherits enable_shared_from_this< IParamDef >.

Inherited by IJmbParamDef, and RawVstParamDef.

Public Types
enum class	Owner { kRT , kGUI }
	Who owns the parameter (mostly for state saving purposes). More...

Public Member Functions
	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 int16	fDeprecatedSince
const Owner	fOwner
const ParamID	fParamID
const VstString16	fTitle
const bool	fTransient

Static Public Attributes
static constexpr int16	kVersionNotDeprecated = -1
	Special version indicating the parameter is not deprecated.

Detailed Description

Base class for all ParamDef.

Member Enumeration Documentation

Owner

enum class Owner

strong

Who owns the parameter (mostly for state saving purposes).

Enumerator
kRT
kGUI

Constructor & Destructor Documentation

IParamDef()

IParamDef ( ParamID const iParamID, VstString16 iTitle, Owner const iOwner, bool const iTransient, int16 const iDeprecatedSince )

inline

~IParamDef()

virtual ~IParamDef ( )

virtualdefault

Member Function Documentation

isDeprecated()

bool isDeprecated ( ) const

inline

Returns true if the parameter is deprecated (meaning it can only be used to upgrade to latest version).

Member Data Documentation

fDeprecatedSince

const int16 fDeprecatedSince

fOwner

const Owner fOwner

fParamID

const ParamID fParamID

fTitle

const VstString16 fTitle

fTransient

const bool fTransient

kVersionNotDeprecated

int16 kVersionNotDeprecated = -1

staticconstexpr

Special version indicating the parameter is not deprecated.

---

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

• pongasoft/VST/ParamDef.h