Rive Android/app.rive.runtime.kotlin.renderers/Renderer

Renderer

abstract class Renderer(var type: RendererType = Rive.defaultRendererType, val trace: Boolean = false) : NativeObject, Choreographer.FrameCallback

Inheritors

RiveArtboardRenderer

Constructors

constructor(type: RendererType = Rive.defaultRendererType, trace: Boolean = false)

Types

object Companion

Properties

val averageFps: Float

var cppPointer: Long

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

val dependencies: MutableList<RefCount>

val frameLock: Any

A lock to synchronize access to the C++ renderer object between the UI thread (which handles lifecycle events like delete()) and the Choreographer thread (which executes doFrame()). This prevents a race condition where the UI thread might nullify the C++ pointer while the worker thread is still using it.

val hasCppObject: Boolean

Whether this objects underlying pointer is still valid.

val height: Float

var isAttached: Boolean

var isPlaying: Boolean

onRenderContextEvent

var onRenderContextEvent: (RenderContextEvent) -> Unit?

Optional callback for EGL context-loss lifecycle events (Lost/Recovered).

open val refCount: Int

override var refs: AtomicInteger

val trace: Boolean

@get:VisibleForTesting(otherwise = 2)

var type: RendererType

val width: Float

Functions

open override fun acquire(): Int

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

abstract fun advance(elapsed: Float)

fun align(fit: Fit, alignment: Alignment, targetBounds: RectF, sourceBounds: RectF, scaleFactor: Float = 1.0f)

open external override fun cppDelete(pointer: Long)

open fun delete()

Schedules the deletion of the underlying C++ object using a two-phase disposal pattern.

open override fun doFrame(frameTimeNanos: Long)

abstract fun draw()

open fun make()

open override fun release(): Int

Decrements the reference counter.

fun save()

fun scale(sx: Float, sy: Float)

open fun scheduleFrame()

Schedule a new frame callback to the Choreographer loop, calling back to doFrame.

fun ~~setSurface~~(surface: Surface)

Sets the drawing surface for the renderer.

fun start()

Starts the renderer and registers for frameCallbacks.

fun stop()

Calls stopThread and removes any pending FrameCallbacks from the Choreographer.

fun transform(x: Float, sy: Float, sx: Float, y: Float, tx: Float, ty: Float)

fun translate(dx: Float, dy: Float)