Rive Android/app.rive.runtime.kotlin.core/ViewModelImageProperty

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.

Unlike other property types, this property can only be set with set. It cannot be read or observed. It's value and valueFlow are not applicable and will always return Unit.

Setting to null will remove the image and release the reference to the image.

Constructors

ViewModelImageProperty

constructor(unsafeCppPointer: Long, fileLock: ReentrantLock)

Properties

cppPointer

var cppPointer: Long

Getter/Setter for the underlying C++ pointer value.

dependencies

val dependencies: MutableList<RefCount>

hasCppObject

val hasCppObject: Boolean

Whether this objects underlying pointer is still valid.

name

val name: String

The name of the property.

refCount

open val refCount: Int

refs

override var refs: AtomicInteger

value

var value: Unit

The current value of the property, whether set by this property or by a data binding update.

valueFlow

val valueFlow: StateFlow<Unit>

A flow of the property's value. Use for observing changes.

Functions

acquire

@Synchronized

open override fun acquire(): Int

Increments the references for this counter. Cannot be used for initialization - use refs.incrementAndGet instead.

cppDelete

open fun cppDelete(pointer: Long)

cppHasChanged

@VisibleForTesting(otherwise = 2)

external fun cppHasChanged(cppPointer: Long): Boolean

cppName

external fun cppName(cppPointer: Long): String

release

open override fun release(): Int

Release this property while holding the current file lock.

set

fun set(image: RiveRenderImage?)

ViewModelImageProperty

See also

Constructors

Properties

Functions