Browse Source

Add more doc comments to ParamQuantity methods.

tags/v2.3.0
Andrew Belt 1 year ago
parent
commit
c93b84aa25
1 changed files with 8 additions and 2 deletions
  1. +8
    -2
      include/engine/ParamQuantity.hpp

+ 8
- 2
include/engine/ParamQuantity.hpp View File

@@ -68,12 +68,18 @@ struct ParamQuantity : Quantity {


Param* getParam(); Param* getParam();


/** Deprecated. Use setValue() instead. */
/** Deprecated. Use setValue() instead, which is identical since Rack 2.3.0. */
DEPRECATED void setSmoothValue(float value); DEPRECATED void setSmoothValue(float value);
/** Deprecated. Use getValue() instead. */
/** Deprecated. Use getValue() instead, which is identical since Rack 2.3.0. */
DEPRECATED float getSmoothValue(); DEPRECATED float getSmoothValue();


/** Sets the Param value immediately without smoothing.
If value is currently being smoothed by the engine, smoothing is canceled.
*/
void setDirectValue(float value); void setDirectValue(float value);
/** Gets the Param value post-smoothing.
If value is currently being smoothed by the engine, the return value is different than getValue().
*/
float getDirectValue(); float getDirectValue();


/** Sets the Param's smoothing target value, or direct value if smoothing is disabled. /** Sets the Param's smoothing target value, or direct value if smoothing is disabled.


Loading…
Cancel
Save