audio/control_port.h file

Functions for control ports.

Contents

Classes

struct ControlPortChange
Used for queueing changes to be applied during processing.

Typedefs

using ControlPortChange = struct ControlPortChange
Used for queueing changes to be applied during processing.

Functions

auto control_port_normalized_val_to_real(const Port*const self, float normalized_val) -> NONNULL PURE float
Converts normalized value (0.0 to 1.0) to real value (eg.
auto control_port_real_val_to_normalized(const Port*const self, float real_val) -> NONNULL PURE float
Converts real value (eg.
auto control_port_get_int(Port* self) -> int
Gets the control value for an integer port.
auto control_port_get_int_from_val(float val) -> PURE int
Gets the control value for an integer port.
auto control_port_get_snapped_val(Port* self) -> float
Returns the snapped value (eg, if toggle, returns 0.f or 1.f).
auto control_port_get_snapped_val_from_val(Port* self, float val) -> float
Returns the snapped value (eg, if toggle, returns 0.f or 1.f).
auto control_port_get_val(Port* self) -> PURE float
Get the current real value of the control.
auto control_port_get_normalized_val(Port* self) -> PURE float
Get the current normalized value of the control.
auto control_port_get_unsnapped_val(Port* self) -> PURE float
Get the current real unsnapped value of the control.
auto control_port_get_default_val(Port* self) -> PURE float
Get the default real value of the control.
void control_port_set_real_val(Port* self, float val)
Get the default real value of the control.
void control_port_set_real_val_w_events(Port* self, float val)
Get the default real value of the control and sends UI events.
void control_port_set_toggled(Port* self, bool toggled, bool forward_events)
Wrapper over port_set_control_value() for toggles.
auto control_port_set_val_from_normalized(Port* self, float val, bool automating) -> HOT NONNULL void
Updates the actual value.

Defines

#define control_port_is_val_toggled(val)
Checks if the given value is toggled.
#define control_port_is_toggled(self)
Returns if the control port is toggled.

Typedef documentation

typedef struct ControlPortChange ControlPortChange

Used for queueing changes to be applied during processing.

Used only for non-plugin ports such as BPM and time signature.