API reference

sprite_sheet.h · C++ API

Browse entries grouped by interface file. Expand an entry for declarations, usage and version boundaries.

Read the related guide →

Entries retain declarations and sources. Runtime verification is recorded per entry; internal source candidates are not a promise of SDK delivery.

include/kui/sprite/sprite_sheet.h
SpritePlayer::~SpritePlayer
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
~SpritePlayer();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:133

Report an issue with this entry →
SpritePlayer::currentAnimationName
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
const String& currentAnimationName() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:161

Report an issue with this entry →
SpritePlayer::currentFrame
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
const SpriteFrame* currentFrame() const;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:160

Report an issue with this entry →
SpritePlayer::currentFrameIndex
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
u32 currentFrameIndex() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:158

Report an issue with this entry →
SpritePlayer::isPaused
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
bool isPaused() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:148

Report an issue with this entry →
SpritePlayer::isPlaying
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
bool isPlaying() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:149

Report an issue with this entry →
SpritePlayer::onComplete
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
void onComplete(CompletionCallback cb)

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:169

Report an issue with this entry →
SpritePlayer::pause
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
void pause();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:145

Report an issue with this entry →
SpritePlayer::play
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
bool play(const String& animationName);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:139

Report an issue with this entry →
SpritePlayer::resume
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
void resume();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:147

Report an issue with this entry →
SpritePlayer::setFrame
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
void setFrame(u32 frameIndex);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:151

Report an issue with this entry →
SpritePlayer::setSpeed
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
void setSpeed(f32 speed)

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:163

Report an issue with this entry →
SpritePlayer::setSpriteSheet
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
void setSpriteSheet(const SpriteSheet* sheet);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:135

Report an issue with this entry →
SpritePlayer::speed
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
f32 speed() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:165

Report an issue with this entry →
SpritePlayer::SpritePlayer
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
SpritePlayer();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:132

Report an issue with this entry →
SpritePlayer::spriteSheet
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
const SpriteSheet* spriteSheet() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:137

Report an issue with this entry →
SpritePlayer::stop
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
void stop();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:142

Report an issue with this entry →
SpritePlayer::tick
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
bool tick(u32 deltaMs);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:154

Report an issue with this entry →
SpritePlayer::void
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
using CompletionCallback = std::function<void()>;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:167

Report an issue with this entry →
SpriteSheet::~SpriteSheet
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
~SpriteSheet();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:72

Report an issue with this entry →
SpriteSheet::addAnimation
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
void addAnimation(SpriteAnimation anim);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:91

Report an issue with this entry →
SpriteSheet::addFrame
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
u32 addFrame(SpriteFrame frame);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:83

Report an issue with this entry →
SpriteSheet::animation
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
const SpriteAnimation* animation(const String& name) const;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:93

Report an issue with this entry →
SpriteSheet::animationCount
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
u32 animationCount() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:94

Report an issue with this entry →
SpriteSheet::animations
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
const std::vector<SpriteAnimation>& animations() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:95

Report an issue with this entry →
SpriteSheet::atlasHeight
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
i32 atlasHeight() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:81

Report an issue with this entry →
SpriteSheet::atlasPath
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
const String& atlasPath() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:76

Report an issue with this entry →
SpriteSheet::atlasWidth
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
i32 atlasWidth() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:80

Report an issue with this entry →
SpriteSheet::frame
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
const SpriteFrame* frame(u32 index) const;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:85

Report an issue with this entry →
SpriteSheet::frameByName
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
const SpriteFrame* frameByName(const String& name) const;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:86

Report an issue with this entry →
SpriteSheet::frameCount
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
u32 frameCount() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:87

Report an issue with this entry →
SpriteSheet::frameIndex
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
u32 frameIndex(const String& name) const;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:87

Report an issue with this entry →
SpriteSheet::frames
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
const std::vector<SpriteFrame>& frames() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:89

Report an issue with this entry →
SpriteSheet::fromJSON
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
static SpriteSheet fromJSON(const String& json);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:108

Report an issue with this entry →
SpriteSheet::generateGridFrames
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
void generateGridFrames(i32 cellW, i32 cellH, i32 columns, i32 rows, const String& namePrefix = "frame");

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:97

Report an issue with this entry →
SpriteSheet::isValid
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
bool isValid() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:111

Report an issue with this entry →
SpriteSheet::loadFromJSON
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
bool loadFromJSON(const String& json);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:103

Report an issue with this entry →
SpriteSheet::setAtlasPath
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
void setAtlasPath(const String& path);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:74

Report an issue with this entry →
SpriteSheet::setAtlasSize
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
void setAtlasSize(i32 w, i32 h);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:78

Report an issue with this entry →
SpriteSheet::SpriteSheet
Needs verification3.61.7C++

Installed header declaration in the sprite module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

sprite_sheet.h
SpriteSheet();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/sprite/sprite_sheet.h:71

Report an issue with this entry →
Browse this reference type →