SpriteFrame
Generated from engine/render/sprite_frame.h at f525bc6. The text under each declaration is the header's own comment, word for word. About the reference says how these pages are made.
Audience: game code.
#include "engine/render/sprite_frame.h" · namespace labrador
class SpriteFrame
Section titled “class SpriteFrame”One named rectangle inside a sprite sheet, and the pivot the sheet authored for it.
THERE IS NO rotated HERE. A packer can store a frame turned ninety degrees to pack it tighter, and the sheet schema has a key saying so; engine/assets/sprite_sheet_loader.cpp refuses such a frame by name, which is the whole of the engine's position on packer rotation. A capability the engine does not have has nowhere to be stored, or the next person to want it finds the field already there and fills it in rather than arguing for the feature.
SpriteFrame
Section titled “SpriteFrame”source_rectangle
Section titled “source_rectangle”The frame's rectangle in the sheet's texture, by const reference into this frame, so it lives as long as the frame does.
origin
Section titled “origin”The pivot the sheet authored, in unscaled source texels measured from this frame's top left - the seam's own units for an origin (engine/render/sprite_geometry.h), so nothing converts on the way to a quad. Zero for a frame whose definition does not mention one, which is most of them and is why the default draws from the top left.
It is not a term of the draw on its own: SpriteSheet::draw adds it to whatever origin the caller passed, and that file says why the two compose rather than one replacing the other.
Related types
Section titled “Related types”Named in the public declarations above: RectangleI, Vector2F.
In the samples and tests
Section titled “In the samples and tests”The files that include this header directly. A file can also reach it through another header.
samples/components/animation_preview_test_content.htests/assets/grid_sheet_loader_tests.cpp,sprite_sheet_loader_tests.cpp,sprite_sheet_resource_tests.cpptests/render/null_resource_tests.cpp,null_tests.cpp,render_resources_tests.cpp,sprite_sheet_object_tests.cpp,visual_tests.cpptests/scene/cull_tests.cpp
Explained in
Section titled “Explained in”No guide or concept page links to this header yet.
Documentation for Labrador v0.4.0. Built from Labrador f525bc6 of 2026-11-17.