Epok Engine

EPOK RUNTIME

epok::SpriteAnimator::play

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

Starts play as part of sprites, flipbooks and screen-facing rendering.

Belongs to
epok::SpriteAnimator
Header
sprite_types.hpp
Overloads
1

Declaration

Declaration
bool play(uint16_t index)

Starts play as part of sprites, flipbooks and screen-facing rendering.

ParameterTypeMeaning
indexuint16_tNot documented; consult the linked header.

Returns: bool. Consult the linked header for its meaning.

Example sketch

C++ example
#include "sprite_types.hpp"

// Assume these named values have been initialized with valid data:
// uint16_t index

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

auto result = object.play(index);

Trade-offs and warnings

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

Declared in runtime/sprite_types.hpp:23

Related members