Epok Engine

EPOK RUNTIME

epok::timeline::Director::poll_diagnostic

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

Polls diagnostic as part of fixed-step simulation time and frame timing.

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

Declaration

Declaration
bool poll_diagnostic(Diagnostic& result)

Polls diagnostic as part of fixed-step simulation time and frame timing.

ParameterTypeMeaning
resultDiagnostic &Not documented; consult the linked header.

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

Example sketch

C++ example
#include "timeline_runtime.hpp"

// Assume these named values have been initialized with valid data:
// Diagnostic & result

epok::timeline::Director& object = /* obtain a valid instance */;

auto result = object.poll_diagnostic(result);

Trade-offs and warnings

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

Declared in runtime/timeline_runtime.hpp:188

Related members