class `SpriteImageBase`

Base class for both render and main thread counterparts of SpriteImage.

Public

Constructors

SpriteImageBase

SpriteImageBase(const SpriteImageCreateInformation &createInformation)

Methods

~SpriteImageBase

virtual ~SpriteImageBase() noexcept = default

GetAnimationFrame

void GetAnimationFrame(float t, u32 &outRow, u32 &outColumn) const

Returns the row and column of the current animation frame for time .

t: Time to evaluate the animation at.
outRow: Row containing the animation frame at time .
outColumn: Column containing the animation frame at time .

SetAnimation

void SetAnimation(const SpriteSheetGridAnimation &animation)

Sets properties describing sprite animation.

The animation splits the sprite area into a grid of sub-images which can be evaluated over time. In order to view the animation you must also enable playback through setAnimationPlayback().

GetAnimation

const SpriteSheetGridAnimation &GetAnimation() const

SetAnimationPlayback

void SetAnimationPlayback(SpriteAnimationPlayback playback)

Determines if and how should the sprite animation play.

GetAnimationPlayback

SpriteAnimationPlayback GetAnimationPlayback() const

Protected

Methods

MarkRenderProxyDataDirtyInternal

virtual void MarkRenderProxyDataDirtyInternal()

Fields

mInformation

SpriteImageInformation mInformation