EPOK RUNTIME

epok::Mesh3DComponent::clip_loop_ticks

Method · 1 overload

Method

One loop of a clip, measured in the animator's own two-per-frame ticks.

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

Declaration

const

Declaration

Fixed clip_loop_ticks(uint32_t clip) const

One loop of a clip, measured in the animator's own two-per-frame ticks.

Parameter	Type	Meaning
`clip`	`uint32_t`	Value supplied for clip. Keep referenced or pointed-to data valid for the complete call.

Returns: Fixed. 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 clip

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

auto result = object.clip_loop_ticks(clip);

Why use it

The method is `const`, so it does not mutate the object through this API surface.

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:689

Related members