BoolParameter

A boolean parameter

Constructors

this
this(int index, string name, bool defaultValue)
Undocumented in source.

Members

Functions

defaultValue
bool defaultValue()
getNormalized
double getNormalized()
Undocumented in source. Be warned that the author may not have intended to support it.
getNormalizedDefault
double getNormalizedDefault()
Undocumented in source. Be warned that the author may not have intended to support it.
normalizedValueFromString
bool normalizedValueFromString(string valueString, double result)
setFromGUI
void setFromGUI(bool newValue)

Sets the parameter value from the UI thread.

setNormalized
void setNormalized(double hostValue)
Undocumented in source. Be warned that the author may not have intended to support it.
stringFromNormalizedValue
void stringFromNormalizedValue(double normalizedValue, char* buffer, size_t len)
toStringN
void toStringN(char* buffer, size_t numBytes)
Undocumented in source. Be warned that the author may not have intended to support it.
toggleFromGUI
void toggleFromGUI()

Toggles the parameter value from the UI thread.

value
bool value()

Gets current value.

valueAtomic
bool valueAtomic()

Same as value but doesn't use locking, and doesn't use ordering. Which make it a better fit for the audio thread.

Inherited Members

From Parameter

name
string name()
label
string label()
index
int index()
setFromHost
void setFromHost(double hostValue)

From a normalized double [0..1], set the parameter value.

getForHost
double getForHost()
toDisplayN
void toDisplayN(char* buffer, size_t numBytes)
Undocumented in source. Be warned that the author may not have intended to support it.
addListener
void addListener(IParameterListener listener)

Adds a parameter listener.

removeListener
void removeListener(IParameterListener listener)

Removes a parameter listener.

beginParamEdit
void beginParamEdit()

Warns the host that a parameter will be edited.

endParamEdit
void endParamEdit()

Warns the host that a parameter has finished being edited.

getNormalized
double getNormalized()
getNormalizedDefault
double getNormalizedDefault()
stringFromNormalizedValue
void stringFromNormalizedValue(double normalizedValue, char* buffer, size_t len)
normalizedValueFromString
bool normalizedValueFromString(string valueString, double result)
~this
~this()
Undocumented in source.
setNormalized
void setNormalized(double hostValue)

From a normalized double, set the parameter value. No guarantee at all that getNormalized will return the same, because this value is rounded to fit.

toStringN
void toStringN(char* buffer, size_t numBytes)

Display parameter (without label).

notifyListeners
void notifyListeners()
Undocumented in source. Be warned that the author may not have intended to support it.
setClientReference
void setClientReference(Client client)

Parameters are owned by a client, this is used to make them refer back to it.

Meta