Stay organized with collections
Save and categorize content based on your preferences.
FrameCallback
interface FrameCallback
Implement this interface to receive a callback when a new display frame is being rendered. The callback is invoked on the Looper thread to which the Choreographer is attached.
Summary
| Public methods |
| abstract Unit |
Called when a new display frame is being rendered.
|
Public methods
doFrame
abstract fun doFrame(frameTimeNanos: Long): Unit
Called when a new display frame is being rendered.
This method provides the time in nanoseconds when the frame started being rendered. The frame time provides a stable time base for synchronizing animations and drawing. It should be used instead of SystemClock.uptimeMillis() or System.nanoTime() for animations and drawing in the UI. Using the frame time helps to reduce inter-frame jitter because the frame time is fixed at the time the frame was scheduled to start, regardless of when the animations or drawing callback actually runs. All callbacks that run as part of rendering a frame will observe the same frame time so using the frame time also helps to synchronize effects that are performed by different callbacks.
Please note that the framework already takes care to process animations and drawing using the frame time as a stable time base. Most applications should not need to use the frame time information directly.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# Choreographer.FrameCallback\n\nAdded in [API level 16](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nFrameCallback\n=============\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/android/view/Choreographer.FrameCallback \"View this page in Java\") \n\n```\ninterface FrameCallback\n```\n\n|-----------------------------------------------|\n| [android.view.Choreographer.FrameCallback](#) |\n\nImplement this interface to receive a callback when a new display frame is being rendered. The callback is invoked on the [Looper](../os/Looper.html#) thread to which the [Choreographer](/reference/kotlin/android/view/Choreographer) is attached.\n\nSummary\n-------\n\n| Public methods ||\n|---------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [doFrame](#doFrame(kotlin.Long))`(`frameTimeNanos:` `[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`)` Called when a new display frame is being rendered. |\n\nPublic methods\n--------------\n\n### doFrame\n\nAdded in [API level 16](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun doFrame(frameTimeNanos: Long): Unit\n```\n\nCalled when a new display frame is being rendered.\n\nThis method provides the time in nanoseconds when the frame started being rendered. The frame time provides a stable time base for synchronizing animations and drawing. It should be used instead of [SystemClock.uptimeMillis()](../os/SystemClock.html#uptimeMillis()) or [System.nanoTime()](../../java/lang/System.html#nanoTime()) for animations and drawing in the UI. Using the frame time helps to reduce inter-frame jitter because the frame time is fixed at the time the frame was scheduled to start, regardless of when the animations or drawing callback actually runs. All callbacks that run as part of rendering a frame will observe the same frame time so using the frame time also helps to synchronize effects that are performed by different callbacks.\n\nPlease note that the framework already takes care to process animations and drawing using the frame time as a stable time base. Most applications should not need to use the frame time information directly.\n\n| Parameters ||\n|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `frameTimeNanos` | [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html): The time in nanoseconds when the frame started being rendered, in the [System.nanoTime()](../../java/lang/System.html#nanoTime()) timebase. Divide this value by `1000000` to convert it to the [SystemClock.uptimeMillis()](../os/SystemClock.html#uptimeMillis()) time base. |"]]
