Epok Engine

EPOK RUNTIME

epok::instrument::preparation::initial_pitch

Function · 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.

Function

Exact initial SPU pitch for the common AudioSource pitch of 1.0.

Belongs to
epok::instrument::preparation
Header
instrument_preparation.hpp
Overloads
1

Declaration

Declaration
inline uint16_t initial_pitch(const BankView& bank,uint16_t zone,const synth::State& state)

Exact initial SPU pitch for the common AudioSource pitch of 1.0.

ParameterTypeMeaning
bankconst BankView &Not documented; consult the linked header.
zoneuint16_tNot documented; consult the linked header.
stateconst synth::State &Not documented; consult the linked header.

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

Example sketch

C++ example
#include "instrument_preparation.hpp"

// Assume these named values have been initialized with valid data:
// const BankView & bank
// uint16_t zone
// const synth::State & state

auto result = epok::instrument::preparation::initial_pitch(bank, zone, state);

Trade-offs and warnings

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

Declared in runtime/instrument_preparation.hpp:13

Related members