Package-level declarations

Types

value class ArtboardHandle(val handle: Long)

A handle to an artboard instance on the CommandServer. Created with CommandQueue.createDefaultArtboard or CommandQueue.createArtboardByName and deleted with CommandQueue.deleteArtboard.

AudioEngine

object AudioEngine

Provides control over the Rive audio engine (powered by https://miniaud.io/).

AudioHandle

@JvmInline

value class AudioHandle(val handle: Long)

A handle to a AudioSource on the CommandServer. Created with CommandQueue.decodeAudio and deleted with CommandQueue.deleteAudio.

CheckableAutoCloseable

interface CheckableAutoCloseable : AutoCloseable

An AutoCloseable that can report whether it has been closed.

CloseableSurface

interface CloseableSurface : AutoCloseable

An owned Android Surface paired with the Android resource that backs it. Used only to create a RiveSurface with CommandQueue.createRiveSurface, which takes ownership, while also encoding resource cleanup.

CloseOnce

class CloseOnce(label: String, onClose: () -> Unit) : CheckableAutoCloseable

Utility to make CheckableAutoCloseable idempotent.

CommandQueue

class CommandQueue : RefCounted

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

CommandQueueBridge

interface CommandQueueBridge

Abstraction of calls to the native command queue.

DefaultViewModelInfo

data class DefaultViewModelInfo(val viewModelName: String, val instanceName: String)

DrawKey

@JvmInline

value class DrawKey(val handle: Long)

A key used to uniquely identify a draw operation in the CommandQueue. This is useful when the same CommandQueue issues multiple draw calls. If the same key is used before the render loop flushes the queue, the previous draw call will be replaced with the new one.

EGLError

object EGLError

Utility to convert EGL error codes to human-readable strings.

FileHandle

@JvmInline

value class FileHandle(val handle: Long)

A handle to a Rive file on the CommandServer. Created with CommandQueue.loadFile and deleted with CommandQueue.deleteFile.

FontHandle

@JvmInline

value class FontHandle(val handle: Long)

A handle to a Font on the CommandServer. Created with CommandQueue.decodeFont and deleted with CommandQueue.deleteFont.

FrameTicker

fun interface FrameTicker

A way of getting frame callbacks every vsync.

ImageHandle

@JvmInline

value class ImageHandle(val handle: Long)

A handle to a RenderImage on the CommandServer. Created with CommandQueue.decodeImage and deleted with CommandQueue.deleteImage.

ImageReaderSurface

class ImageReaderSurface(imageReader: ImageReader) : CloseableSurface

CloseableSurface backed by an ImageReader.

Listeners

data class Listeners(val fileListener: Long, val artboardListener: Long, val stateMachineListener: Long, val viewModelInstanceListener: Long, val imageListener: Long, val audioListener: Long, val fontListener: Long) : AutoCloseable

Holds the native pointers to the listeners used by the CommandQueue. Android uses only one listener of each type to simplify lifetime management. This is as opposed to a listener for each handle.

RCPointer

class RCPointer(cppPointer: Long, val label: String, onDispose: (Long) -> Unit) : RefCounted

A reference-counted pointer to a native C++ object.

RefCounted

interface RefCounted

An interface for reference-counted objects. Can be used with RCPointer by delegation.

RivePropertyUpdate

typealias RivePropertyUpdate<T> = CommandQueue.PropertyUpdate<T>

Additional alias for the interior type RiveWorker.PropertyUpdate due to not being accessible from RiveWorker.

RiveSurface

abstract class RiveSurface : CheckableAutoCloseable

A backend agnostic collection of surface properties needed for rendering.

RiveWorker

typealias RiveWorker = CommandQueue

CommandQueue is named to match the underlying core C++ class, which reflects its algorithm: a queue of commands that are dispatched to a command server which receives them and operates on Rive files.

StateMachineHandle

@JvmInline

value class StateMachineHandle(val handle: Long)

A handle to a state machine instance on the CommandServer. Created with CommandQueue.createDefaultStateMachine or CommandQueue.createStateMachineByName and deleted with CommandQueue.deleteStateMachine.

SurfaceTextureSurface

class SurfaceTextureSurface(surfaceTexture: SurfaceTexture, val width: Int, val height: Int) : CloseableSurface

CloseableSurface backed by a SurfaceTexture.

UniquePointer

data class UniquePointer(cppPointer: Long, val label: String, onDispose: (Long) -> Unit) : CheckableAutoCloseable

A unique pointer to a native C++ object.

ViewModelInstanceHandle

@JvmInline

value class ViewModelInstanceHandle(val handle: Long)

A handle to a view model instance on the CommandServer. Created with CommandQueue.createViewModelInstance and deleted with CommandQueue.deleteViewModelInstance.

Properties

ChoreographerFrameTicker

val ChoreographerFrameTicker: FrameTicker

A FrameTicker that uses Choreographer to get frame callbacks.

COMMAND_QUEUE_TAG

const val COMMAND_QUEUE_TAG: String

ComposeFrameTicker

val ComposeFrameTicker: FrameTicker

A FrameTicker that uses withFrameNanos to get frame callbacks.

Functions

traceSection

inline fun <T> traceSection(sectionName: String, block: () -> T): T

Runs block inside an Android trace section.

withFrameNanosChoreographer

suspend fun <R> withFrameNanosChoreographer(onFrame: (Long) -> R): R

An API compatible version of withFrameNanos from Compose that uses Choreographer.