Epok Engine

EPOK RUNTIME

epok::skeletal_sample_vertex_impl

Function · 1 overload

Function

Performs `skeletal sample vertex impl` as part of rigid skeletal animation and pose evaluation.

Belongs to
epok
Header
skeletal.hpp
Overloads
1

Declaration

Declaration
inline VertexSample skeletal_sample_vertex_impl(const ActorData* entity,uint32_t vertex,PoseKind pose,CoordinateSpace space,bool account_request)

Performs `skeletal sample vertex impl` as part of rigid skeletal animation and pose evaluation.

ParameterTypeMeaning
entityconst ActorData *Value supplied for entity. Keep referenced or pointed-to data valid for the complete call.
vertexuint32_tValue supplied for vertex. Keep referenced or pointed-to data valid for the complete call.
posePoseKindValue supplied for pose. Keep referenced or pointed-to data valid for the complete call.
spaceCoordinateSpaceValue supplied for space. Keep referenced or pointed-to data valid for the complete call.
account_requestboolValue supplied for account_request. Keep referenced or pointed-to data valid for the complete call.

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

Example

C++ example
#include "skeletal.hpp"

// Assume these named values have been initialized with valid data:
// const ActorData * entity
// uint32_t vertex
// PoseKind pose
// CoordinateSpace space
// bool account_request

auto result = epok::skeletal_sample_vertex_impl(entity, vertex, pose, space, account_request);

Why use it

It provides direct, allocation-conscious access to rigid skeletal animation and pose evaluation. No exception-based error path is implied by the signature.

Trade-offs and warnings

Pointer/reference arguments are borrowed unless the source contract says otherwise; keep them valid for the complete operation and never assume null is accepted.

Declared in runtime/skeletal.hpp:191

Related members