Skip to main content
Represents a Rive artboard instance, providing drawing, advancing, interaction handling, and access to named nodes and data.

Fields

frameOrigin

If true, the artboard’s origin is treated as the frame origin.

data

The typed data associated with the artboard.

width

The width of the artboard.

height

The height of the artboard.

Methods

draw

Draws the artboard using the provided renderer.

advance

Advances the artboard by the given time in seconds. Returns true if the artboard should continue receiving advance calls.

instance

Creates a new instance of the artboard with independent state.

bounds

Returns the bounding box of the artboard as two Vec2D values: the minimum point and the maximum point.

node

Returns the node with the given name, or nil if no such node exists.

pointerDown

Pointer event handlers. Each returns a hit-test result, where 0 indicates no hit and non-zero values indicate a hit.

pointerUp

pointerMove

pointerExit

addToPath

Adds the artboard’s geometry to the given path, optionally transformed by the provided matrix.