Epok Engine

EPOK RUNTIME

epok::SpriteAnimator

Struct

Struct

Struct declared by the sprite-types module for sprites, flipbooks and screen-facing rendering.

Namespace
epok
Header
sprite_types.hpp
Include
#include "sprite_types.hpp"
Module
sprite-types
Source
runtime/sprite_types.hpp:16

Basic usage

This minimal snippet shows the normal syntax for reaching the type. Open a member below for an operation-specific example.

C++ example
#include "sprite_types.hpp"

epok::SpriteAnimator& value = /* obtain a valid instance from your game */;

Fields and constants

clipExposes `clip` on `epok::SpriteAnimator` for sprites, flipbooks and screen-facing rendering.Fieldclip_countExposes `clip_count` on `epok::SpriteAnimator` for sprites, flipbooks and screen-facing rendering.FieldclipsExposes `clips` on `epok::SpriteAnimator` for sprites, flipbooks and screen-facing rendering.FieldcompletedExposes `completed` on `epok::SpriteAnimator` for sprites, flipbooks and screen-facing rendering.Fielddropped_eventsExposes `dropped_events` on `epok::SpriteAnimator` for sprites, flipbooks and screen-facing rendering.FieldelapsedExposes `elapsed` on `epok::SpriteAnimator` for sprites, flipbooks and screen-facing rendering.FieldenabledExposes `enabled` on `epok::SpriteAnimator` for sprites, flipbooks and screen-facing rendering.Fieldevent_countExposes `event_count` on `epok::SpriteAnimator` for sprites, flipbooks and screen-facing rendering.Fieldevent_readExposes `event_read` on `epok::SpriteAnimator` for sprites, flipbooks and screen-facing rendering.FieldeventsBounded FIFO preserves each crossed-frame event; drop counter is observable.FieldframeExposes `frame` on `epok::SpriteAnimator` for sprites, flipbooks and screen-facing rendering.FieldplayingExposes `playing` on `epok::SpriteAnimator` for sprites, flipbooks and screen-facing rendering.Field

Public methods

advancePerforms `advance` as part of sprites, flipbooks and screen-facing rendering.MethodapplyPerforms `apply` as part of sprites, flipbooks and screen-facing rendering.MethodemitPerforms `emit` as part of sprites, flipbooks and screen-facing rendering.MethodpausePauses pause as part of sprites, flipbooks and screen-facing rendering.MethodplayStarts play as part of sprites, flipbooks and screen-facing rendering.Methodpoll_eventPolls event as part of sprites, flipbooks and screen-facing rendering.MethodresumeResumes resume as part of sprites, flipbooks and screen-facing rendering.Methodtake_completionPerforms `take completion` as part of sprites, flipbooks and screen-facing rendering.Method