Epok Engine

EPOK RUNTIME

epok::timeline::sample

Function · 1 overload

Function

Same signed division toward zero and wide intermediate as bp::Timeline.

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

Declaration

Declaration
inline int32_t sample(Curve curve, int32_t tick)

Same signed division toward zero and wide intermediate as bp::Timeline.

ParameterTypeMeaning
curveCurveValue supplied for curve. Keep referenced or pointed-to data valid for the complete call.
tickint32_tValue supplied for tick. Keep referenced or pointed-to data valid for the complete call.

Returns: int32_t. Check the value before continuing when it represents success, availability or a resource handle.

Example

C++ example
#include "timeline.hpp"

// Assume these named values have been initialized with valid data:
// Curve curve
// int32_t tick

auto result = epok::timeline::sample(curve, tick);

Why use it

It provides direct, allocation-conscious access to fixed-step simulation time and frame timing. No exception-based error path is implied by the signature.

Trade-offs and warnings

Call it only in the lifecycle phase described by the module. Validate indices, capacities and object state before use.

Declared in runtime/timeline.hpp:22

Related members

aabb_may_touchPerforms `aabb may touch` as part of bounded AABB collision queries and movement.Function templateaabb_overlapPerforms `aabb overlap` as part of bounded AABB collision queries and movement.Function templateaabb2d_containsPerforms `aabb2d contains` as part of the world2d module.Functionaabb2d_overlapPerforms `aabb2d overlap` as part of the world2d module.Functionaabb2d_touchPerforms `aabb2d touch` as part of the world2d module.Functionaabb2d_translatedPerforms `aabb2d translated` as part of the world2d module.Functionactivate_texture_bankPerforms `activate texture bank` as part of the epok module.Functionactive_cameraPerforms `active camera` as part of the epok module.Functionactor_for_slotPerforms `actor for slot` as part of the actor tables module.Functionallocate_actor_dataPerforms `allocate actor data` as part of the epok module.Functionattach_componentSpatial attachment between components of the same domain.Functionaudio_initializePerforms `audio initialize` as part of SPU sound playback and voice ownership.Function