Epok Engine

EPOK RUNTIME

Sprite Types

sprite_types.hpp · sprites, flipbooks and screen-facing rendering

Module

sprites, flipbooks and screen-facing rendering.

Header
sprite_types.hpp
Include
#include "sprite_types.hpp"
Stability
Epok runtime API

Include this module

C++ include
#include "sprite_types.hpp"

Types

SpriteStruct declared by the sprite-types module for sprites, flipbooks and screen-facing rendering.StructSpriteAnimatorStruct declared by the sprite-types module for sprites, flipbooks and screen-facing rendering.StructSpriteClipStruct declared by the sprite-types module for sprites, flipbooks and screen-facing rendering.StructSpriteFrameStruct declared by the sprite-types module for sprites, flipbooks and screen-facing rendering.StructSpriteOrientationEnum declared by the sprite-types module for sprites, flipbooks and screen-facing rendering.EnumSpriteStatsStruct declared by the sprite-types module for sprites, flipbooks and screen-facing rendering.Struct

Functions and 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

Fields, variables and values

blendExposes `blend` on `epok::Sprite` for sprites, flipbooks and screen-facing rendering.FieldclipExposes `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.FieldclippedExposes `clipped` on `epok::SpriteStats` for sprites, flipbooks and screen-facing rendering.FieldclipsExposes `clips` on `epok::SpriteAnimator` for sprites, flipbooks and screen-facing rendering.FieldcolorExposes `color` on `epok::Sprite` for sprites, flipbooks and screen-facing rendering.FieldcompletedExposes `completed` on `epok::SpriteAnimator` for sprites, flipbooks and screen-facing rendering.FieldculledExposes `culled` on `epok::SpriteStats` for sprites, flipbooks and screen-facing rendering.Fielddepth_biasExposes `depth_bias` on `epok::Sprite` for sprites, flipbooks and screen-facing rendering.FielddroppedExposes `dropped` on `epok::SpriteStats` for sprites, flipbooks and screen-facing rendering.Fielddropped_eventsExposes `dropped_events` on `epok::SpriteAnimator` for sprites, flipbooks and screen-facing rendering.FielddurationExposes `duration` on `epok::SpriteFrame` for sprites, flipbooks and screen-facing rendering.FieldelapsedExposes `elapsed` on `epok::SpriteAnimator` for sprites, flipbooks and screen-facing rendering.FieldenabledExposes `enabled` on `epok::Sprite` for sprites, flipbooks and screen-facing rendering.FieldenabledExposes `enabled` on `epok::SpriteAnimator` for sprites, flipbooks and screen-facing rendering.Fieldestimated_pixelsExposes `estimated_pixels` on `epok::SpriteStats` for sprites, flipbooks and screen-facing rendering.FieldeventExposes `event` on `epok::SpriteFrame` 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.FieldFixedNamed value `Fixed` in `epok::SpriteOrientation`.Enum valueflip_xExposes `flip_x` on `epok::Sprite` for sprites, flipbooks and screen-facing rendering.Fieldflip_yExposes `flip_y` on `epok::Sprite` for sprites, flipbooks and screen-facing rendering.FieldframeExposes `frame` on `epok::SpriteAnimator` for sprites, flipbooks and screen-facing rendering.Fieldframe_countExposes `frame_count` on `epok::SpriteClip` for sprites, flipbooks and screen-facing rendering.FieldframesExposes `frames` on `epok::SpriteClip` for sprites, flipbooks and screen-facing rendering.FieldloopingExposes `looping` on `epok::SpriteClip` for sprites, flipbooks and screen-facing rendering.FieldnameExposes `name` on `epok::SpriteClip` for sprites, flipbooks and screen-facing rendering.FieldorientationExposes `orientation` on `epok::Sprite` for sprites, flipbooks and screen-facing rendering.FieldpivotExposes `pivot` on `epok::Sprite` for sprites, flipbooks and screen-facing rendering.FieldplayingExposes `playing` on `epok::SpriteAnimator` for sprites, flipbooks and screen-facing rendering.FieldregionExposes `region` on `epok::Sprite` for sprites, flipbooks and screen-facing rendering.FieldregionExposes `region` on `epok::SpriteFrame` for sprites, flipbooks and screen-facing rendering.FieldsizeExposes `size` on `epok::Sprite` for sprites, flipbooks and screen-facing rendering.FieldSphericalNamed value `Spherical` in `epok::SpriteOrientation`.Enum valuesprite_statsExposes `sprite_stats` on the `epok` namespace for sprites, flipbooks and screen-facing rendering.VariablesubmittedExposes `submitted` on `epok::SpriteStats` for sprites, flipbooks and screen-facing rendering.FieldtextureExposes `texture` on `epok::Sprite` for sprites, flipbooks and screen-facing rendering.FieldtrianglesExposes `triangles` on `epok::SpriteStats` for sprites, flipbooks and screen-facing rendering.FieldunlitExposes `unlit` on `epok::Sprite` for sprites, flipbooks and screen-facing rendering.FieldUprightNamed value `Upright` in `epok::SpriteOrientation`.Enum value