DatumHueEnterprise v0.0.24datumhue.com
Contents

namespaceRetained 2D Drawing3 functionsUI apps only

datumhue.draw

Retained-mode 2D vector graphics. Primitives persist across frames; center-origin, Y-up. Positions take a vec3 (z controls depth, -1000..1000) or a vec2 — without an explicit z, primitives auto-stack in creation order (later on top), and an explicit z is authoritative. Colors use Color values. For raster pixels — recorded pictures replayed onto an image's buffer (top-left origin, Y-down) — use image.

Returns handles
DrawCanvas, DrawPrimitive

Functions 3

datumhue.draw.new

functionUI apps only
datumhue.draw.new(opts: draw.NewOptions) -> DrawCanvas

Create a draw canvas (render target). A mount that shows it larger than its size draws it again at that size, up to about four million pixels, so its shapes and text stay sharp. It keeps its own pixels with pixel_perfect, with filter set to nearest, and under the integer and sharp fits.

Example
local canvas = datumhue.draw.new({
    width = 320,
    height = 240,
    background = datumhue.color("#384b55"),
})
canvas:mount({ width = 320, height = 240 })

opts draw.NewOptions options 4 keys

KeyTypeDefaultDescription
widthnumber400Canvas width in pixels.
heightnumber300Canvas height in pixels.
backgroundColordatumhue.color(0, 0, 0, 0)Fill color applied before each frame.
pixel_perfectbooleanfalseKeep one texture pixel per canvas pixel at any display scale, zoom or mount size.

In the guide: Draw and animate Make it interactive Add physics

datumhue.draw.text_span

functionUI apps only
datumhue.draw.text_span(opts: draw.TextSpanOptions) -> DrawPrimitive

Create a detached text span. Attach it through the spans array of canvas:text() or prim:update(); it keeps its own color, size, weight and face there.

Example
local canvas = datumhue.draw.new({ width = 320, height = 240 })
canvas:mount({ width = 320, height = 240 })
local low = datumhue.draw.text_span({
    text = "low",
    color = datumhue.color("#e67e80"),
})
-- Spans follow the text, each in its own color and size.
canvas:text({
    text = "Fuel: ",
    color = datumhue.color("#7fbbb3"),
    spans = { low },
})

opts draw.TextSpanOptions options 5 keys

KeyTypeDefaultDescription
text requiredstringno defaultSpan text.
colorColordatumhue.color(1, 1, 1)Text color.
font_sizenumber | string16Span font size: a number (pixels) or a unit string like "1.5rem"/"50vw"/"4vmin".
font_weightnumber | "thin" | "extralight" | "light" | "regular" | "normal" | "medium" | "semibold" | "bold"the theme's normal text weightSpan weight: a number on the variable weight axis, or a weight name (bold is the heaviest).
font_style"normal" | "italic" | "oblique""normal"Span face: upright, the calligraphic cursive, or a mechanical slant.

datumhue.draw.measure_text

functionUI apps only
datumhue.draw.measure_text(text: string, options?: draw.MeasureTextOptions) -> draw.TextSize

Measure the size text renders at in the draw font, shaped as canvas:text shapes it and with the same size, weight, and face defaults.

Example
local size = datumhue.draw.measure_text("Hello", { font_size = 32 })
print(size.width, size.height) --> 96.0 39.0

options draw.MeasureTextOptions options 4 keys

KeyTypeDefaultDescription
font_sizenumber | string16Font size: a number (px) or a unit string like "1.5rem"/"50vw".
font_weightnumber | "thin" | "extralight" | "light" | "regular" | "normal" | "medium" | "semibold" | "bold"the theme's normal text weightWeight to measure at: a number on the variable weight axis, or a weight name (bold is the heaviest).
font_style"normal" | "italic" | "oblique""normal"Face to measure with: upright, the calligraphic cursive, or a mechanical slant.
max_widthnumberlines do not wrapWrap width in draw units.

returns draw.TextSize record 2 keys

KeyTypeDescription
widthnumberRendered width in draw units.
heightnumberRendered height in draw units.

In the guide: Draw shapes and text

Types 7

draw.CanvasSpriteOptions

options

options 5 keys

KeyTypeDefaultDescription
posVec3datumhue.math.vec3(0, 0, 0)Center position in draw space.
rotationnumber0Rotation in radians, counter-clockwise.
scaleVec2datumhue.math.vec2(1, 1)Per-axis scale.
sizeVec2the sprite's or source's own size; for a render target, its logical sizeRendered size in draw units (width, height), overriding the sprite's or source's own size.
materialShaderthe plain textured quadShader material to render with. 2D surfaces take a Shader; Material handles are 3D-only.

Used by: DrawCanvas:sprite, DrawCanvas:image

draw.DrawShapeOptions

options

options 4 keys

KeyTypeDefaultDescription
colorColordatumhue.color(1, 1, 1)Fill/stroke color.
filledbooleantrueFill the shape rather than stroke it.
stroke_widthnumber2Stroke width in pixels when not filled.
materialShaderthe standard flat materialShader handle to apply.

Extended by: draw.ArcOptions, draw.CircleOptions, draw.EllipseOptions, draw.PolygonOptions, draw.RectOptions, draw.RrectOptions

draw.LineBreak

enum
ValueDescription
"word"
"character"
"word_or_character"
"none"

Nested in: draw.TextOptions

draw.TextAlign

enum
ValueDescription
"left"
"center"
"right"
"justified"

Nested in: draw.TextOptions, draw.UpdateOptions

draw.TextSpan

options

options 5 keys

KeyTypeDefaultDescription
text requiredstringno defaultSpan text.
colorColorthe parent text's colorSpan color.
font_sizenumber | stringthe parent text's sizeSpan font size: a number (px) or a unit string like "1.5rem"/"50vw".
font_weightnumber | "thin" | "extralight" | "light" | "regular" | "normal" | "medium" | "semibold" | "bold"the parent text's weightSpan weight: a number on the variable weight axis, or a weight name (bold is the heaviest).
font_style"normal" | "italic" | "oblique"the parent text's faceSpan face: upright, the calligraphic cursive, or a mechanical slant.

Nested in: draw.TextOptions, draw.UpdateOptions

FontStyle

enum
ValueDescription
"normal"
"italic"
"oblique"

Nested in: chart.MarkUpdateOptions, chart.TextMarkOptions, chart.TitleOptions, draw.MeasureTextOptions, draw.TextOptions, draw.TextSpan, draw.TextSpanOptions, draw.UpdateOptions and 2 more

FontWeight

enum
ValueDescription
"thin"
"extralight"
"light"
"regular"
"normal"
"medium"
"semibold"
"bold"

Nested in: chart.MarkUpdateOptions, chart.TextMarkOptions, chart.TitleOptions, draw.MeasureTextOptions, draw.TextOptions, draw.TextSpan, draw.TextSpanOptions, draw.UpdateOptions and 2 more

datumhue.com

(c) 2026 Shuusei AB. Quote excerpts of this manual, with attribution to DatumHue, in your own documentation, tutorials, course materials, reviews, and other writing or video. Republishing it in whole or in substantial part needs written permission: support@datumhue.com.

Victor Mono is licensed under the SIL Open Font License 1.1
Copyright (c) 2024, Rune Bjørnerås (https://github.com/rubjo)

This Font Software is licensed under the SIL Open Font License, Version 1.1.
This license is copied below, and is also available with a FAQ at:
http://scripts.sil.org/OFL


-----------------------------------------------------------
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
-----------------------------------------------------------

PREAMBLE
The goals of the Open Font License (OFL) are to stimulate worldwide
development of collaborative font projects, to support the font creation
efforts of academic and linguistic communities, and to provide a free and
open framework in which fonts may be shared and improved in partnership
with others.

The OFL allows the licensed fonts to be used, studied, modified and
redistributed freely as long as they are not sold by themselves. The
fonts, including any derivative works, can be bundled, embedded,
redistributed and/or sold with any software provided that any reserved
names are not used by derivative works. The fonts and derivatives,
however, cannot be released under any other type of license. The
requirement for fonts to remain under this license does not apply
to any document created using the fonts or their derivatives.

DEFINITIONS
"Font Software" refers to the set of files released by the Copyright
Holder(s) under this license and clearly marked as such. This may
include source files, build scripts and documentation.

"Reserved Font Name" refers to any names specified as such after the
copyright statement(s).

"Original Version" refers to the collection of Font Software components as
distributed by the Copyright Holder(s).

"Modified Version" refers to any derivative made by adding to, deleting,
or substituting -- in part or in whole -- any of the components of the
Original Version, by changing formats or by porting the Font Software to a
new environment.

"Author" refers to any designer, engineer, programmer, technical
writer or other person who contributed to the Font Software.

PERMISSION & CONDITIONS
Permission is hereby granted, free of charge, to any person obtaining
a copy of the Font Software, to use, study, copy, merge, embed, modify,
redistribute, and sell modified and unmodified copies of the Font
Software, subject to the following conditions:

1) Neither the Font Software nor any of its individual components,
in Original or Modified Versions, may be sold by itself.

2) Original or Modified Versions of the Font Software may be bundled,
redistributed and/or sold with any software, provided that each copy
contains the above copyright notice and this license. These can be
included either as stand-alone text files, human-readable headers or
in the appropriate machine-readable metadata fields within text or
binary files as long as those fields can be easily viewed by the user.

3) No Modified Version of the Font Software may use the Reserved Font
Name(s) unless explicit written permission is granted by the corresponding
Copyright Holder. This restriction only applies to the primary font name as
presented to the users.

4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
Software shall not be used to promote, endorse or advertise any
Modified Version, except to acknowledge the contribution(s) of the
Copyright Holder(s) and the Author(s) or with their explicit written
permission.

5) The Font Software, modified or unmodified, in part or in whole,
must be distributed entirely under this license, and must not be
distributed under any other license. The requirement for fonts to
remain under this license does not apply to any document created
using the Font Software.

TERMINATION
This license becomes null and void if any of the above conditions are
not met.

DISCLAIMER
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
OTHER DEALINGS IN THE FONT SOFTWARE.

Try

    ↑↓ selectEnter openTab filter

    Settings

    Theme
    Text
    Print

    Keyboard shortcuts

    / or Ctrl KSearch
    ↑ ↓ EnterPick a result
    TabNext result filter
    j kNext or previous entry
    [ ]Previous or next page
    yCopy a link to the current entry
    ?These shortcuts
    EscClose

    On this page