On this page
API type

ui

Draws text, rectangles, lines, and circles over the video output.

Syntax

Atlas Script
ui

Return value

See the remarks for the returned value and runtime behavior.

Remarks

Draws text, rectangles, lines, and circles over the video output. Build strings with string.format, draw text with ui.print(font, x, y, string), and show a status label with ui.status. Coordinates are 0 to 1 fractions of the frame.

Examples

Usage pattern
// ui is available where its documented API returns or accepts this value.
Reference details are generated from the Atlas Script schema in this documentation source snapshot. Confirm release-specific behavior in the Atlas for Windows build you use.