Epok Engine

EPOK RUNTIME

epok::timeline::Director::snapshot

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

Performs `snapshot` as part of fixed-step simulation time and frame timing.

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

Declaration

const
Declaration
bp::PlaybackSnapshot snapshot(Handle h,uint64_t asset=0,uint64_t marker=0)const

Performs `snapshot` as part of fixed-step simulation time and frame timing.

ParameterTypeMeaning
hHandleNot documented; consult the linked header.
assetuint64_tNot documented; consult the linked header.
markeruint64_tNot documented; consult the linked header.

Returns: bp::PlaybackSnapshot. 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:
// Handle h
// uint64_t asset
// uint64_t marker

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

auto result = object.snapshot(h, asset, marker);

Trade-offs and warnings

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

Declared in runtime/timeline_runtime.hpp:193

Related members