struct
SunVox::Controller
- SunVox::Controller
- Struct
- Value
- Object
Overview
High-level wrapper around a module controller inside a SunVox::Module.
Defined in:
module.crConstructors
Instance Method Summary
-
#display_value : Int32
Gets the value as displayed in the SunVox UI (
CtlScale::Displayed). -
#group : Int32
Gets the group number of this controller.
- #index : Int32
-
#max(scaled : CtlScale = CtlScale::Real) : Int32
Gets the maximum value of this controller.
-
#min(scaled : CtlScale = CtlScale::Real) : Int32
Gets the minimum value of this controller.
- #mod : Module
-
#name : String
Gets the name of this controller.
-
#offset : Int32
Gets the display value offset of this controller.
-
#range(scaled : CtlScale = CtlScale::Real) : Range(Int32, Int32)
Gets the valid value range (
min..max) of this controller. -
#real_value : Int32
Gets the raw internal controller value (
CtlScale::Real). -
#scaled_value : Int32
Gets the scaled controller value (
0x0000..0x8000for normal controllers,CtlScale::Scaled). -
#set_value(val : Int32, scaled : CtlScale = CtlScale::Real) : self
Sets the controller value with an explicit scaling mode (
Real,Scaled, orDisplayed). -
#slot : Slot
The slot that owns this controller's module.
-
#type : CtlType
Gets the controller type (
CtlType::NormalorCtlType::Selector). -
#value(scaled : CtlScale = CtlScale::Real) : Int32
Gets the controller value according to
scaled(Real,Scaled, orDisplayed). -
#value=(val : Int32) : Int32
Sets the controller value (using
CtlScale::Realby default).
Constructor Detail
Instance Method Detail
Gets the maximum value of this controller.
Gets the minimum value of this controller.
Gets the valid value range (min..max) of this controller.
Gets the scaled controller value (0x0000..0x8000 for normal controllers, CtlScale::Scaled).
Sets the controller value with an explicit scaling mode (Real, Scaled, or Displayed).
Gets the controller value according to scaled (Real, Scaled, or Displayed).