Represents the result of an operation - typically loading - that can be in a loading, error, or success state. This includes Rive file loading. The Success result must be unwrapped to the value, e.g. through Kotlin's when/is statements.

RiveCanvasSession

@RequiresApi(value = 29)

class RiveCanvasSession(riveWorker: RiveWorker, artboard: Artboard, stateMachine: StateMachine, viewModelInstance: ViewModelInstance? = null, fit: Fit = RenderingDefaults.defaultFit(), @ColorInt clearColor: Int = RenderingDefaults.CLEAR_COLOR) : AutoCloseable

An entry point for Rive to render to a hardware accelerated Canvas using hardware bitmaps.

RiveDrawToBufferException

class RiveDrawToBufferException(message: String, cause: Throwable? = null) : Exception

Exceptions related to drawing to a buffer.

RiveFile

@Stable

class RiveFile : AutoCloseable

A Rive file which contains one or more artboards, state machines, and view model instances.

RiveFileException

class RiveFileException(message: String, cause: Throwable? = null) : Exception

Exceptions related to Rive file handling.

RiveFileSource

sealed interface RiveFileSource

The source for a RiveFile.

RiveFrameRate

sealed interface RiveFrameRate

Controls how often Rive advances and draws an active animation.

RiveInitializationException

class RiveInitializationException(message: String, cause: Throwable? = null) : Exception

Exceptions related to Rive failing to initialize properly.

RiveLog

object RiveLog

RiveLog allows configuring logging within Rive.

RivePointerInputMode

enum RivePointerInputMode : Enum<RivePointerInputMode>

Controls how a Rive composable participates in Compose pointer input dispatch.

RiveRenderException

class RiveRenderException(message: String, cause: Throwable? = null) : Exception

Exceptions related to Rive rendering.

RiveShutdownException

class RiveShutdownException(message: String, cause: Throwable? = null) : Exception

Exceptions related to Rive failing to shut down properly.

RiveView

class RiveView @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null, defStyle: Int = 0) : FrameLayout

Note: This class is more experimental than others. It is not recommended for use at this time.

SoftwareRenderBuffer

class SoftwareRenderBuffer(val width: Int, val height: Int, riveWorker: RiveWorker) : CheckableAutoCloseable

CPU-backed offscreen render target for snapshot-style rendering.

StateMachine

class StateMachine : AutoCloseable

An instantiated state machine from an Artboard.

ViewModelInstance

class ViewModelInstance : AutoCloseable

A view model instance for data binding which has properties that can be set and observed.

ViewModelInstanceSource

sealed interface ViewModelInstanceSource

The second half of a source for a ViewModelInstance. This represents the specific instance of the view model. This can be either:

ViewModelSource

sealed interface ViewModelSource

One half of a source for a ViewModelInstance. This represents the view model that originates the instance. This can be either Named to refer to a specific view model, or DefaultForArtboard, which will use the default view model for the given Artboard. This is usually the one the designer has intended to be used with the artboard.

Properties

RIVE_WORKER_TAG

const val RIVE_WORKER_TAG: String

Functions

rememberArtboard

@Composable

fun rememberArtboard(file: RiveFile, artboardName: String? = null): Artboard

Creates an Artboard from the given RiveFile.

rememberAudio

@Composable

fun rememberAudio(riveWorker: RiveWorker, bytes: ByteArray): Result<AudioAsset>

Decode audio from the given bytes on the provided RiveWorker. The decoded audio can only be used on the same RiveWorker it was created on.

rememberFont

@Composable

fun rememberFont(riveWorker: RiveWorker, bytes: ByteArray): Result<FontAsset>

Decode a font from the given bytes on the provided RiveWorker. The decoded font can only be used on the same RiveWorker it was created on.

rememberImage

@Composable

fun rememberImage(riveWorker: RiveWorker, bytes: ByteArray): Result<ImageAsset>

Decode an image from the given bytes on the provided RiveWorker. The decoded image can only be used on the same RiveWorker it was created on.

rememberRegisteredAudio

@Composable

fun rememberRegisteredAudio(riveWorker: RiveWorker, key: String, bytes: ByteArray): Result<AudioAsset>

Decode and register audio from the given bytes on the provided riveWorker. The decoded audio can only be used on the same RiveWorker it was created on.

rememberRegisteredFont

@Composable

fun rememberRegisteredFont(riveWorker: RiveWorker, name: String, bytes: ByteArray): Result<FontAsset>

Decode and register a font from the given bytes on the provided RiveWorker. The decoded font can only be used on the same RiveWorker it was created on.

rememberRegisteredImage

@Composable

fun rememberRegisteredImage(riveWorker: RiveWorker, key: String, bytes: ByteArray): Result<ImageAsset>

Decode and register an image from the given bytes on the provided RiveWorker. The decoded image can only be used on the same RiveWorker it was created on.

rememberRiveFile

@Composable

fun rememberRiveFile(source: RiveFileSource, riveWorker: RiveWorker): Result<RiveFile>

Loads a RiveFile from the given source.

rememberRiveWorker

@Composable

fun rememberRiveWorker(autoPoll: Boolean = true, tracingEnabled: Boolean = false, renderBackend: RenderBackend = RenderBackend.OpenGL): RiveWorker

A RiveWorker is the worker that runs Rive in a thread. It holds all of the state, including assets (images, audio, and fonts), RiveFiles, artboards, state machines, and view model instances.

rememberRiveWorkerOrNull

@Composable

fun rememberRiveWorkerOrNull(errorState: MutableState<Throwable?> = mutableStateOf(null), autoPoll: Boolean = true, tracingEnabled: Boolean = false, renderBackend: RenderBackend = RenderBackend.OpenGL): RiveWorker?

A nullable variant of rememberRiveWorker that returns null if the Rive worker cannot be created.

rememberStateMachine

@Composable

fun rememberStateMachine(artboard: Artboard, stateMachineName: String? = null): StateMachine

Creates a StateMachine from the given Artboard.

rememberViewModelInstance

@Composable

fun rememberViewModelInstance(file: RiveFile, source: ViewModelInstanceSource? = null): ViewModelInstance

Creates a ViewModelInstance from the given file and source.

Rive

@Composable

fun Rive(file: RiveFile, modifier: Modifier = Modifier, playing: Boolean = true, artboard: Artboard? = null, stateMachine: StateMachine? = null, viewModelInstance: ViewModelInstance? = null, fit: Fit = RenderingDefaults.defaultFit(), backgroundColor: Int = RenderingDefaults.CLEAR_COLOR, pointerInputMode: RivePointerInputMode = Consume, frameRate: RiveFrameRate = RiveFrameRate.Unbounded, onBitmapAvailable: (GetBitmapFun) -> Unit? = null)

The main composable for rendering a Rive file's artboard and state machine.