A BindableArtboard is an artboard reference that can be assigned to a ViewModelArtboardProperty. It should only be used for that purpose and cannot be used as a regular Artboard.

BlendState

class BlendState(unsafeCppPointer: Long) : LayerState

BlendStates are a base class for state machine layer states.

BytesRequest

class BytesRequest(url: String, onResponse: (bytes: ByteArray) -> Unit, errorListener: Response.ErrorListener) : Request<ByteArray>

CDNAssetLoader

open class CDNAssetLoader(context: Context) : FileAssetLoader

Loads assets from Rive's CDN when marked as "Hosted" in the Rive editor. Uses the FileAsset.cdnUrl field as the URL.

ContextAssetLoader

abstract class ContextAssetLoader(context: Context) : FileAssetLoader

A FileAssetLoader with access to a Context. Use this if you need context when the asset loader is constructed via reflection in XML.

Direction

enum Direction : Enum<Direction>

EntryState

class EntryState(unsafeCppPointer: Long) : LayerState

EntryStates are a base class for state machine layer states.

EventType

enum EventType : Enum<EventType>

The type of Rive event.

ExitState

class ExitState(unsafeCppPointer: Long) : LayerState

ExitStates are a base class for state machine layer states.

FallbackAssetLoader

class FallbackAssetLoader(context: Context, loadCDNAssets: Boolean = true, loader: FileAssetLoader? = null) : FileAssetLoader

The default asset loader used by RiveAnimationView when loading assets. This allows for setting up cascading asset loaders which may be useful when each represents a different source or policy, e.g. a memory cache, local storage, and network.

File

@OpenForTesting

class File(bytes: ByteArray, val rendererType: RendererType = Rive.defaultRendererType, fileAssetLoader: FileAssetLoader? = null) : NativeObject

Files are created in the Rive editor.

FileAsset

sealed class FileAsset : NativeObject

FileAssetLoader

abstract class FileAssetLoader : NativeObject

Base class for asset loading. Overload loadContents to customize the loading process.

Fit

enum Fit : Enum<Fit>

FontAsset

class FontAsset(address: Long, rendererTypeIdx: Int) : FileAsset

A thin Kotlin wrapper for the underlying C++ font asset. Helpful to distinguish between various FileAsset subclasses.

Helpers

object Helpers

ImageAsset

class ImageAsset(address: Long, rendererTypeIdx: Int) : FileAsset

A thin Kotlin wrapper for the underlying C++ image asset. Helpful to distinguish between various FileAsset subclasses.

ImageDecoder

object ImageDecoder

LayerState

open class LayerState(unsafeCppPointer: Long) : NativeObject

LayerStates are a base class for state machine layer states.

LinearAnimationInstance

class LinearAnimationInstance(unsafeCppPointer: Long, lock: ReentrantLock, var mix: Float = 1.0f) : PlayableInstance, NativeObject

The LinearAnimationInstance is a helper to wrap common operations to play an animation.

Loop

enum Loop : Enum<Loop>

NativeObject

abstract class NativeObject(initialPointer: Long) : RefCount

NativeObject is a Kotlin object that's backed by a C++ counterpart via the JNI. It keeps track of the current pointer value in its local variable unsafeCppPointer.

PlayableInstance

interface PlayableInstance

RefCount

interface RefCount

RendererType

enum RendererType : Enum<RendererType>

Rive

object Rive

RiveAudio

class RiveAudio : NativeObject

A wrapper around a native C++ object representing an audio clip that can be played in Rive.

RiveEvent

open class RiveEvent(unsafeCppPointer: Long, val delay: Float) : NativeObject

A class for Rive events.

RiveEventReport

class RiveEventReport(val unsafeCppPointer: Long, secondsDelay: Float) : NativeObject

A class for reported Rive events to match its C++ counterpart.

RiveFont

class RiveFont : NativeObject

A wrapper around a native C++ object representing a font that can be rendered in Rive.

RiveGeneralEvent

class RiveGeneralEvent(unsafeCppPointer: Long, delay: Float) : RiveEvent

A general Rive event.

RiveOpenURLEvent

class RiveOpenURLEvent(unsafeCppPointer: Long, delay: Float) : RiveEvent

An open URL Rive event.

RiveRenderImage

class RiveRenderImage : NativeObject

A wrapper around a native C++ object representing a raster image that can be rendered in Rive.

RiveTextValueRun

open class RiveTextValueRun(unsafeCppPointer: Long) : NativeObject

A class for text run instances.

SMIBoolean

class SMIBoolean(unsafeCppPointer: Long) : SMIInput

A boolean state machine input.

SMIInput

open class SMIInput(unsafeCppPointer: Long) : NativeObject

SMIInputs are a base class for state machine input instances.

SMINumber

class SMINumber(unsafeCppPointer: Long) : SMIInput

A floating point number state machine input.

SMITrigger

class SMITrigger(unsafeCppPointer: Long) : SMIInput

A trigger state machines input.

StateMachineInstance

class StateMachineInstance(unsafeCppPointer: Long, fileLock: ReentrantLock) : PlayableInstance, NativeObject

The StateMachineInstance is a helper to wrap common operations to play a state machine.

ViewModel

@OpenForTesting

class ViewModel : NativeObject

A description of a ViewModel in the Rive file. It can be used to retrieve property definitions at runtime. However, properties cannot be modified - that requires an instance. Use one of the createInstance methods to create an instance with mutable properties from this ViewModel.

ViewModelArtboardProperty

class ViewModelArtboardProperty(unsafeCppPointer: Long, fileLock: ReentrantLock) : ViewModelProperty<Unit>

An artboard property of a ViewModelInstance.

ViewModelBooleanProperty

class ViewModelBooleanProperty(unsafeCppPointer: Long, fileLock: ReentrantLock) : ViewModelProperty<Boolean>

ViewModelColorProperty

class ViewModelColorProperty(unsafeCppPointer: Long, fileLock: ReentrantLock) : ViewModelProperty<Int>

A color property of a ViewModelInstance. Values are represented as integers in 0xAARRGGBB format.

ViewModelEnumProperty

class ViewModelEnumProperty(unsafeCppPointer: Long, fileLock: ReentrantLock) : ViewModelProperty<String>

An enum property of a ViewModelInstance. Values are represented as strings.

ViewModelImageProperty

class ViewModelImageProperty(unsafeCppPointer: Long, fileLock: ReentrantLock) : ViewModelProperty<Unit>

An image property of a ViewModelInstance. Values are RiveRenderImage type, and must be constructed from encoded bytes with RiveRenderImage.make.

ViewModelInstance

@OpenForTesting

class ViewModelInstance : NativeObject

Represents an instantiated set of properties on a ViewModel. With this class you have access to the individual properties to get and set values from bindings.

ViewModelListProperty

class ViewModelListProperty(unsafeCppPointer: Long, fileLock: ReentrantLock) : ViewModelProperty<Unit>

A list property of ViewModelInstances.

ViewModelNumberProperty

class ViewModelNumberProperty(unsafeCppPointer: Long, fileLock: ReentrantLock) : ViewModelProperty<Float>

A number property of a ViewModelInstance. Use value to mutate the property.

ViewModelProperty

abstract class ViewModelProperty<T>(unsafeCppPointer: Long, fileLock: ReentrantLock) : NativeObject

A property of type T of a ViewModelInstance. Use value to mutate the property. use valueFlow to subscribe to changes on the value.

ViewModelStringProperty

class ViewModelStringProperty(unsafeCppPointer: Long, fileLock: ReentrantLock) : ViewModelProperty<String>

ViewModelTriggerProperty

class ViewModelTriggerProperty(unsafeCppPointer: Long, fileLock: ReentrantLock) : ViewModelProperty<ViewModelTriggerProperty.TriggerUnit>

A trigger property of a ViewModelInstance. Use trigger fire the trigger.