Epok Engine

EPOK RUNTIME

epok::Mesh3DComponent::sample_vertex

Method · 1 overload

Method

Performs `sample vertex` as part of the object model module.

Belongs to
epok::Mesh3DComponent
Header
object_model.hpp
Overloads
1

Declaration

Declaration
VertexSample sample_vertex(uint32_t vertex,PoseKind pose,CoordinateSpace space)

Performs `sample vertex` as part of the object model module.

ParameterTypeMeaning
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.

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

Example

C++ example
#include "object_model.hpp"

// Assume these named values have been initialized with valid data:
// uint32_t vertex
// PoseKind pose
// CoordinateSpace space

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

auto result = object.sample_vertex(vertex, pose, space);

Why use it

It provides direct, allocation-conscious access to the object model module. 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/object_model.hpp:704

Related members