Epok Engine

EPOK RUNTIME

epok::instrument::synth::State::start_validated

Method · 1 overload

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Method

PSX loader has validated the immutable bank and the kernel has validated controls/note data.

Belongs to
epok::instrument::synth::State
Header
instrument_synth.hpp
Overloads
1

Declaration

Declaration
Error start_validated(const BankView& bank, uint16_t zone_index, uint8_t key, uint8_t velocity, const Controls& controls)

PSX loader has validated the immutable bank and the kernel has validated controls/note data.

ParameterTypeMeaning
bankconst BankView &Not documented; consult the linked header.
zone_indexuint16_tNot documented; consult the linked header.
keyuint8_tNot documented; consult the linked header.
velocityuint8_tNot documented; consult the linked header.
controlsconst Controls &Not documented; consult the linked header.

Returns: Error. Consult the linked header for its meaning.

Example sketch

C++ example
#include "instrument_synth.hpp"

// Assume these named values have been initialized with valid data:
// const BankView & bank
// uint16_t zone_index
// uint8_t key
// uint8_t velocity
// const Controls & controls

epok::instrument::synth::State& object = /* obtain a valid instance */;

auto result = object.start_validated(bank, zone_index, key, velocity, controls);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in runtime/instrument_synth.hpp:69

Related members