A parameter suitable for automated boolean values.
- See also
- ParameterBase
#include <parameter.h>
Inheritance diagram for ape::Param< bool >:
Public Types | |
| typedef ParameterBase< bool, Param< bool > > | Base |
| typedef bool | ParameterType |
Public Member Functions | |
| Param (const std::string_view paramName="", const Range parameterRange=Range()) | |
| Param (const std::string_view paramName, const std::string &unit, const Range parameterRange=Range()) | |
 Public Member Functions inherited from ape::ParameterBase< bool, Param< bool > > | |
| int | id () const noexcept |
| A unique identifier for this parameter More... | |
| bool | changed () const noexcept |
| Whether the parameter has changed in this processing frame. Only sensible when called from within Processor::process More... | |
| operator bool () const noexcept | |
| Evaluate the value of the parameter at the start of this processing frame. More... | |
| bool | operator[] (Index idx) const noexcept |
| Alias for at(). More... | |
| bool | at (Index idx) const noexcept |
| Evaluate the value of the parameter at at a specific sample index, where 0 equals the start of the processing frame. More... | |
| Param< bool > & | operator= (bool t) noexcept |
| Assign a value to this parameter. Depending on host support, this might only make sense inside the constructor of a Effect or Generator (so it is a way of setting default / initial value of a parameter). More... | |
| ~ParameterBase () | |
| Delete this parameter instance. More... | |
| auto | getRange () const noexcept |
| Returns the Range this parameter was constructed with. More... | |
Static Public Member Functions | |
| static ParameterType | convert (PFloat value) noexcept |
| static PFloat | representationFor (ParameterType value) noexcept |
| Static Public Member Functions inherited from ape::ParameterBase< bool, Param< bool > > | |
| static bool | convert (PFloat normalized) noexcept |
Convert an engine PFloat to the native Type of this parameter.
| |
| static PFloat | representationFor (bool value) noexcept |
Convert a native Type to an engine PFloat type.
| |
Additional Inherited Members | |
| Protected Member Functions inherited from ape::ParameterBase< bool, Param< bool > > | |
| ParameterBase (const std::string_view paramName="", const Range parameterRange=Range()) | |
| Constructs a named parameter. More... | |
| Protected Attributes inherited from ape::ParameterBase< bool, Param< bool > > | |
| APE_Parameter | param |
| const Range | range |
| std::string | name |
Detailed Description
template<>
class ape::Param< bool >
A parameter suitable for automated boolean values.
- See also
- ParameterBase
Member Typedef Documentation
◆ Base
| typedef ParameterBase<bool, Param<bool> > ape::Param< bool >::Base |
◆ ParameterType
| typedef bool ape::Param< bool >::ParameterType |
Constructor & Destructor Documentation
◆ Param() [1/2]
|
inline |
◆ Param() [2/2]
|
inline |
Member Function Documentation
◆ convert()
|
inlinestaticnoexcept |
◆ representationFor()
|
inlinestaticnoexcept |
The documentation for this class was generated from the following file:
- C:/Code/ape/make/skeleton/includes/parameter.h
