Canvas

A Rive 2-D renderer canvas. Use .image with renderer:drawImage(). Call beginFrame() to get a Renderer, issue draw calls, then endFrame().

Fields

image

Backing image for renderer:drawImage().

width

Width in pixels.

height

Height in pixels.

Methods

resize

resize(width: number, height: number) -> ()

Resize the canvas. Must not be called between beginFrame() and endFrame().

beginFrame

beginFrame(desc: {clearColor: Color?}?) -> Renderer

Begin a Rive frame. Returns a Renderer valid until endFrame(). clearColor is an ARGB integer (e.g. 0xFF000000 = opaque black; default transparent).

endFrame

endFrame() -> ()

Flush draw calls to the backing texture and release the Renderer.