Constructor Detail

• Renderer

  Renderer(RendererType type, Boolean trace)

Method Detail

• getIsPlaying

   final Boolean getIsPlaying()

• setIsPlaying

   final Unit setIsPlaying(Boolean isPlaying)

• getIsAttached

   final Boolean getIsAttached()

• setIsAttached

   final Unit setIsAttached(Boolean isAttached)

• getFrameLock

   final Object getFrameLock()

  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.

• getWidth

   final Float getWidth()

• getHeight

   final Float getHeight()

• getAverageFps

   final Float getAverageFps()

• getType

  @VisibleForTesting(otherwise = 2) final RendererType getType()

• setType

   final Unit setType(RendererType type)

• getTrace

   final Boolean getTrace()

• getHasCppObject

   final Boolean getHasCppObject()

• getRefs

   final AtomicInteger getRefs()

• setRefs

   final Unit setRefs(AtomicInteger refs)

• getCppPointer

   final Long getCppPointer()

• setCppPointer

   final Unit setCppPointer(Long cppPointer)

• getDependencies

   final List<RefCount> getDependencies()

• getRefCount

   Integer getRefCount()

• cppDelete

   Unit cppDelete(Long pointer)

• make

  @CallSuper() Unit make()

• draw

  @WorkerThread() abstract Unit draw()

• advance

  @WorkerThread() abstract Unit advance(Float elapsed)

• start

   final Unit start()

  Starts the renderer and registers for frameCallbacks.

  Goal: When we trigger start, doFrame gets called once per frame until we stop or the animation finishes.

  Gotchas:

  • scheduleFrame triggers callbacks to doFrame which in turn schedules more frames

  • If we call scheduleFrame multiple times we enter multiple parallel animations loops

  • To avoid this we check isPlaying and deregister FrameCallbacks when stop is called by users

• setSurface

  @Deprecated(message = This low-level method can cause crashes and will be removed. Prefer using higher-level APIs., level = DeprecationLevel.WARNING) final Unit setSurface(Surface surface)

  Sets the drawing surface for the renderer.

• stop

  @CallSuper() final Unit stop()

  Calls stopThread and removes any pending FrameCallbacks from the Choreographer.

  Note: this is not safe to call from the animation thread. e.g inside draw/advance callbacks.

• scheduleFrame

   Unit scheduleFrame()

• save

   final Unit save()

• restore

   final Unit restore()

• align

   final Unit align(Fit fit, Alignment alignment, RectF targetBounds, RectF sourceBounds, Float scaleFactor)

• transform

   final Unit transform(Float x, Float sy, Float sx, Float y, Float tx, Float ty)

• scale

   final Unit scale(Float sx, Float sy)

• translate

   final Unit translate(Float dx, Float dy)

• doFrame

  @CallSuper() Unit doFrame(Long frameTimeNanos)

• delete

  @CallSuper() Unit delete()

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

  UI Thread: Immediately marks the Kotlin object as disposed to prevent new operations. cppDelete schedules the actual deletion on the background render thread, ensuring the C++ object is deleted only after all work for this Renderer has completed.

  Background Thread: cleans up resources after all pending work completes via disposeDependencies