Epok Engine

EPOK RUNTIME

epok::SpriteAnimator::poll_event

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

Polls event as part of sprites, flipbooks and screen-facing rendering.

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

Declaration

Declaration
bool poll_event(uint16_t& event)

Polls event as part of sprites, flipbooks and screen-facing rendering.

ParameterTypeMeaning
eventuint16_t &Not 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 & event

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

auto result = object.poll_event(event);

Trade-offs and warnings

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

Declared in runtime/sprite_types.hpp:22

Related members