Core API (Render, Input, etc.)

Handle for shapes and sprites in the rendering system.

Used to correctly manage resources via the GC. Not to be created directly.

Core rendering API for sprites, shapes, text, and debug drawing

Provides functionality for rendering images, texts and shapes

Loads an image from a file and returns an image ID

Supports PNG and JPG formats. Use relative paths like "[game]/textures/flower.png"

Creates a procedural image from pixel data and returns an image ID

pixels is a flat list of width*height packed RGBA values (use ImageBuilder.pack())

Loads a shape from a file and returns a shape ID

Supports SVG format

Loads a font into a font atlas and returns a font ID

Font will be rasterized at the specified size

Gets the width in pixels of a loaded image

Gets the height in pixels of a loaded image

Creates a sprite from a section of an image using texture coordinates

Coordinates are normalized (0.0 to 1.0): x0, y0 (top-left), x1, y1 (bottom-right)

Creates a custom mesh shape from vertices, texture coordinates, and indices

Destroys a shape and frees its resources

Sets the offset for subsequent sprite draw calls

All sprites will be offset by (x, y) until new values are set

Draws a sprite with full control over appearance

- spriteId: Valid sprite ID created with createSprite (not an image ID)

- x, y: Position on screen (affected by setOffset)

- z: Sorting depth value

- scale: Scaling factor

- rotation: Rotation angle in radians

- mul: Multiply color (0xRRGGBBAA format)

- add: Additive color (0xRRGGBBAA format)

- flags: Combination of sprite flags (spriteBottom, spriteCenter, etc.)

Draws a shape at a position with transformation

Draws text at a position with styling

Note: Text always renders above sprites currently

Don't apply any flags

Draw the sprite at the bottom

Draw the sprite at the top

Center the sprite on the x-axis

Center the sprite on the y-axis

Flip the sprite on the x-axis

Flip the sprite on the y-axis

Overlay the sprite as overlay (no offset applied)

Center the sprite on the x and y-axis

This is not a sprite but a shape, so handle it differently

Primitive type for line rendering

Primitive type for triangle rendering

Begins a debug primitive batch

Call dbgVertex() to add vertices, then dbgEnd() to finish

Primitive can be lines or triangles

Ends a debug primitive batch and renders it

Number of vertices must match primitive type (divisible by 2 for lines, 3 for triangles)

Adds a vertex to the current debug primitive

Must be called between dbgBegin() and dbgEnd()

Sets the color for the next debug vertices

Color format: 0xRRGGBBAA (e.g., 0xF0C0D0FF)

Draws a debug line from (x0, y0) to (x1, y1)

Draws debug text on screen with specified size

Uses built-in debug font

Draws a debug line between two vector points

Draws a filled debug rectangle

Draws a filled debug square centered at position

Draws a filled debug circle (disk)

divs controls the number of triangular segments

Draws a debug circle outline

divs controls the number of line segments

Draws a debug arc (partial circle outline)

angle is in radians, divs controls line segment count

Draws a filled debug pie/wedge shape

angle is in radians, divs controls triangle count

Adds a vector point as a debug vertex

Draws a sprite at position with default settings

Equivalent to: sprite(spriteId, x, y, 0.0, 1.0, 0.0, 0xFFFFFFFF, 0x00000000, spriteBottom)

Draws a sprite at position with z-sorting

Draws a sprite at position with z-sorting and custom flags

Creates a sprite from a grid/sprite sheet by column and row

Creates a sprite from a grid/sprite sheet by index

Index starts at 0 from top-left, going row by row

File I/O operations

Reads the contents of a file as a string

Writes text content to a file

Checks if a file exists at the given path

Fast JSON parsing and serialization (C++ implementation)

Much faster than the pure Wren json.wren parser

Loads and parses a JSON file, returns the parsed value (Map, List, String, Num, Bool, or null)

Returns null if the file doesn't exist or parsing fails

Parses a JSON string, returns the parsed value

Returns null if parsing fails

Saves a value to a JSON file with pretty formatting

Returns true on success, false on failure

Note: Map serialization has limited support

Converts a value to a JSON string with pretty formatting

Note: Map serialization has limited support

Data class for touch input information

Input handling for keyboard, mouse, gamepad, and touch

Gets the current value of a gamepad axis (-1.0 to 1.0)

Gets axis value once when it crosses threshold (prevents repeating)

Checks if a gamepad button is currently pressed

Checks if a gamepad button was just pressed (doesn't repeat while held)

Checks if a keyboard key is currently pressed

Checks if a keyboard key was just pressed (doesn't repeat while held)

Gets mouse state information

Checks if a mouse button is currently pressed

Checks if a mouse button was just pressed (doesn't repeat while held)

Gets the current mouse X position in screen coordinates

Gets the current mouse Y position in screen coordinates

Gets the mouse wheel delta for this frame

Gets the number of active touch points

Gets the unique ID for a touch at the given index

Gets the X position for a touch at the given index

Gets the Y position for a touch at the given index

Sets gamepad vibration motors (DualSense, Xbox controllers)

time is in milliseconds

Sets the gamepad lightbar color (DualSense controller)

Colors are 0-255

Resets gamepad lightbar to default color

Gets all touch data as a list of TouchData objects

Gets touch data for a specific touch index

Gets the mouse position as a two-element list [x, y]

Audio playback using FMOD

Loads a sound file into a group and returns a sound ID

Plays a loaded sound and returns a channel ID

Gets the volume level of a sound group (0.0 to 1.0)

Sets the volume level of a sound group (0.0 to 1.0)

Gets the volume level of a specific channel (0.0 to 1.0)

Sets the volume level of a specific channel (0.0 to 1.0)

Gets the volume level of an FMOD bus by name (0.0 to 1.0)

Sets the volume level of an FMOD bus by name (0.0 to 1.0)

Loads an FMOD sound bank

Unloads an FMOD sound bank

Starts an FMOD event and returns an event instance ID

Sets a numeric parameter on an FMOD event instance

Sets a labeled parameter on an FMOD event instance

Load an audio file and return an audio id

Play a loaded audio file with specified volume (0.0 to 1.0)

Play a loaded audio file with default volume (1.0)

Set the volume of a playing channel (0.0 to 1.0)

Get the volume of a playing channel

Stop a playing channel

Stop all playing channels

Check if a channel is currently playing

Gets a number value from the game scope

Gets a color value from the game scope

Gets a boolean value from the game scope

Gets a number value from a specific data scope

Gets a color value from a specific data scope

Gets a boolean value from a specific data scope

Gets a string value from a specific data scope

Sets a number value in a specific data scope

Sets a color value in a specific data scope

Sets a boolean value in a specific data scope

Sets a string value in a specific data scope

Saves all data of a specific data scope to its own file

Platform and device information

Gets the current platform identifier

Checks if the application can be closed (always false on consoles)

Requests the application to close

CPU profiling utilities

Begins a named profiler section

Ends a named profiler section

ImGui-based inspector utilities for entity debugging

Displays text in the inspector

Starts a collapsible tree node, returns true if open

Ends a tree node (must be called if treeNode returned true)

Draws a horizontal separator line

Draws a horizontal separator line with text in the middle

Places the next widget on the same line

Increases indent level

Decreases indent level

Adds vertical spacing

Selectable item for lists, returns true if clicked

Input field for float values, returns new value

Drag widget for float values, returns new value

Checkbox for boolean values, returns new value

Creates a collapsing header section (cleaner than treeNode for headers)

Returns true if the section is open/expanded

Begins a child window region with optional border

width and height: size in pixels (0 = auto-size)

border: whether to draw a border around the child

Ends the current child window region

Must be called after beginChild

Private: Drag widget for 2D float vector (x, y as separate params)

Returns a list [x, y] with the new values

Drag widget for 2D vector, returns new Vec2 value

Works with xs_math Vec2 objects