Artboard

An instantiated artboard from a RiveFile.

Can be queried for state machine names, and used to create a Rive composable.

Create an instance of this class using rememberArtboard or Artboard.fromFile. When using the latter, make sure to call close when you are done with the artboard to release its resources.

Parameters

artboardHandle

The handle to the artboard on the command server.

riveWorker

The Rive worker that owns the artboard.

Types

Companion

object Companion

Properties

artboardHandle

val artboardHandle: ArtboardHandle

name

val name: String?

Functions

open override fun close()

getStateMachineNames

suspend fun getStateMachineNames(): List<String>

resetArtboardSize

fun resetArtboardSize()

Resets this artboard to its original dimensions.

resizeArtboard

fun resizeArtboard(surface: RiveSurface, scaleFactor: Float = 1.0f)

Resizes this artboard to match the dimensions of the given surface, divided by the scale factor.