handle2 methods
An image plus a uniform grid of cells, built by Image:atlas. Cells are indexed from 0 in row-major order. Use atlas:sprite(index) to make a drawable appearance.
datumhue.image.font, Image:atlasVoxel:atlas, Picture:set_font, DrawCanvas:tilemapThe examples on this page start from:
local canvas = datumhue.draw.new({ width = 320, height = 240 })
canvas:mount({ width = 320, height = 240 })
-- The built-in font: one cell per character, from the space on.
local atlas = datumhue.image.font()Atlas:sprite(index: number, opts?: image.SpriteOptions) -> SpriteBuild a Sprite appearance for cell index (0-based, row-major).
-- Cell 33 is "A": its character code minus 32.
local letter = atlas:sprite(33, {
color = datumhue.color("#e69875"),
size = datumhue.math.vec2(48, 78),
})
canvas:sprite(letter)opts image.SpriteOptions options 4 keys
In the guide: Pixel art and sprites
Atlas:clips(defs: table<string, scene.ClipDef>) -> SpriteClipsBuild a reusable SpriteClips clip-set from this atlas. defs maps each clip name to its clip definition; frames are 0-based atlas cell indices. Bind it to a sprite with clips:bind(sprite) — one clip-set drives many sprites, each with its own playhead.
local clips = atlas:clips({
-- The cells of "0", "1", "2" and "3", once.
count = { frames = { 16, 17, 18, 19 }, fps = 4, looping = false },
-- "-", "\", "|", "/", over and over.
spin = {
frames = { 13, 60, 92, 15 },
durations = { 0.1, 0.1, 0.1, 0.3 },
markers = { [3] = "upright" },
},
})
print(#clips:names()) --> 2defs scene.ClipDef options 6 keys
| Key | Type | Default | Description |
|---|---|---|---|
| frames required | integer[] | no default | 0-based atlas cell indices in play order. |
| fps | number | 8 | Frames per second. Ignored when durations is given. |
| looping | boolean | true | Whether the clip repeats. |
| direction | "forward" | "reverse" | "ping_pong" | "forward" | Traversal order. |
| durations | number[] | every frame lasts 1 / fps seconds | Per-frame seconds (same length as frames); overrides fps. |
| markers | table<integer, string> | the clip has no markers | 1-based frame position within this clip's frames list → marker name; fires on_marker when the playhead crosses that frame. |