Epok Engine

EPOK RUNTIME

epok::timeline::poll_marker

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

Sorted tables use (tick, persistent marker ID) at cook time.

Belongs to
epok::timeline
Header
timeline.hpp
Overloads
1

Declaration

Declaration
inline bool poll_marker(const Marker* markers, uint16_t count, uint16_t& cursor, int32_t tick, uint16_t& id)

Sorted tables use (tick, persistent marker ID) at cook time.

ParameterTypeMeaning
markersconst Marker *Not documented; consult the linked header.
countuint16_tNot documented; consult the linked header.
cursoruint16_t &Not documented; consult the linked header.
tickint32_tNot documented; consult the linked header.
iduint16_t &Not documented; consult the linked header.

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

Example sketch

C++ example
#include "timeline.hpp"

// Assume these named values have been initialized with valid data:
// const Marker * markers
// uint16_t count
// uint16_t & cursor
// int32_t tick
// uint16_t & id

auto result = epok::timeline::poll_marker(markers, count, cursor, tick, id);

Trade-offs and warnings

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

Declared in runtime/timeline.hpp:65

Related members