Epok Engine

EPOK RUNTIME

epok::sequence::Kernel::begin

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

Begins begin as part of PSX kernel ownership, interrupts and low-level services.

Belongs to
epok::sequence::Kernel
Header
sequence_kernel.hpp
Overloads
1

Declaration

Declaration
bool begin(const Event* data, uint32_t size, uint16_t division, uint16_t voices)

Begins begin as part of PSX kernel ownership, interrupts and low-level services.

ParameterTypeMeaning
dataconst Event *Not documented; consult the linked header.
sizeuint32_tNot documented; consult the linked header.
divisionuint16_tNot documented; consult the linked header.
voicesuint16_tNot documented; consult the linked header.

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

Example sketch

C++ example
#include "sequence_kernel.hpp"

// Assume these named values have been initialized with valid data:
// const Event * data
// uint32_t size
// uint16_t division
// uint16_t voices

epok::sequence::Kernel& object = /* obtain a valid instance */;

auto result = object.begin(data, size, division, voices);

Trade-offs and warnings

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

Declared in runtime/sequence_kernel.hpp:92

Related members