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.
isDiscrete
bool isDiscrete()
Undocumented in source. Be warned that the author may not have intended to support it.
normalizedValueFromString
bool normalizedValueFromString(const(char)[] valueString, double result)
setFromGUI
void setFromGUI(bool newValue)

Sets the parameter value from the UI thread.

setFromGUINormalized
void setFromGUINormalized(double normValue)

Sets the value of the parameter from UI, using a normalized value. Note: If normValue is < 0.5, this is set to false. If normValue is >= 0.5, this is set to true.

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()

Get current value.

valueAtomic
bool valueAtomic()

Get current value but doesn't use locking, using the raw memory order. Which might make it a better fit for the audio thread. The various readParam!T functions use that.²

Inherited Members

From Parameter

addListener
void addListener(IParameterListener listener)

Adds a parameter listener.

removeListener
void removeListener(IParameterListener listener)

Removes a parameter listener.

name
string name()
label
string label()
toNameN
void toNameN(char* p, int bufLength)

Output name as a zero-terminated C string, truncate if needed.

toLabelN
void toLabelN(char* p, int bufLength)

Output label as a zero-terminated C string, truncate if needed.

index
int index()
isAutomatable
bool isAutomatable()
nonAutomatable
Parameter nonAutomatable()

Makes parameter non-automatable.

setFromHost
void setFromHost(double hostValue)

From a normalized double [0..1], set the parameter value. This is a Dplug internal call, not for plug-in code.

getForHost
double getForHost()
toDisplayN
void toDisplayN(char* buffer, size_t numBytes)

Output a string representation of a Parameter.

beginParamEdit
void beginParamEdit()

Warns the host that a parameter will be edited. Should only ever be called from the UI thread.

endParamEdit
void endParamEdit()

Warns the host that a parameter has finished being edited. Should only ever be called from the UI thread.

beginParamHover
void beginParamHover()

Warns the listeners that a parameter is being hovered in the UI. Should only ever be called from the UI thread.

endParamHover
void endParamHover()

Warns the listeners that a parameter has finished being hovered in the UI. Should only ever be called from the UI thread. This doesn't communicate anything to the host.

getNormalized
double getNormalized()
getNormalizedDefault
double getNormalizedDefault()
stringFromNormalizedValue
void stringFromNormalizedValue(double normalizedValue, char* buffer, size_t len)
normalizedValueFromString
bool normalizedValueFromString(const(char)[] valueString, double result)
isDiscrete
bool isDiscrete()
~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). This always adds a terminal zero within numBytes.

notifyListeners
void notifyListeners()
Undocumented in source. Be warned that the author may not have intended to support it.
checkBeingEdited
void checkBeingEdited()
Undocumented in source. Be warned that the author may not have intended to support it.
isEdited
bool isEdited()
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