namespaceImages3 functionsUI apps only
Raster images and drawable framebuffers (top-left origin, Y-down). Create a blank image with new, then draw by recording a picture() and replaying it with image:apply — each replay rewrites pixels. For vector shapes that persist as live handles across frames (center-origin, Y-up), use draw.
datumhue.image.new(options: image.NewOptions) -> ImageCreate a blank drawable image. Display it with image:mount().
options image.NewOptions options 2 keys
| Key | Type | Default | Description |
|---|---|---|---|
| width required | number | no default | Image width in pixels. Must be positive. |
| height required | number | no default | Image height in pixels. Must be positive. |
In the guide: Draw shapes and text Pixel art and sprites Troubleshooting
datumhue.image.picture() -> PictureCreate an empty, reusable drawing command list. Record draw operations into it, then replay it onto an image with image:apply(picture). Build it once and apply every frame; call picture:reset() to rebuild dynamic content.
In the guide: Pixel art and sprites
datumhue.image.font() -> AtlasThe built-in bitmap font as an Atlas (8x13 cells, 16x6 grid; cell index = ASCII code - 32). Hand it to picture:set_font(atlas), or draw individual glyphs as sprites with atlas:sprite(code - 32).
In the guide: Pixel art and sprites
| Value | Description |
|---|---|
"copy" | Destination = source (straight copy). |
"alpha" | Standard alpha compositing (source-over). |
"add" | Additive; clamps at white. |
"multiply" | Multiplies channels; darkens. |
"screen" | Inverse multiply; lightens. |
Used by: Picture:blit
| Value | Description |
|---|---|
"nearest" | |
"linear" |
Used by: Image.filter, DrawCanvas.filter
options 4 keys
| Key | Type | Default | Description |
|---|---|---|---|
| color | Color | datumhue.color(1, 1, 1) | Tint multiplied with the texture; white leaves it unchanged. |
| flip_x | boolean | false | Mirror horizontally. |
| flip_y | boolean | false | Mirror vertically. |
| size | Vec2 | the cell or image pixel size | Rendered size in draw units (width, height). |
Used by: Image:sprite, Atlas:sprite, Sprite:with