Back to Filament

FrameInfo

docs/android/dokka/filament-android/com.google.android.filament/-renderer/-frame-info/index.md

1.75.04.6 KB
Original Source

//filament-android/com.google.android.filament/Renderer/FrameInfo

FrameInfo

open class FrameInfo

Timing information about a frame.

See also

getFrameInfoHistory(FrameInfo[])

Constructors

FrameInfo[main]
constructor()

Properties

NameSummary
backendBeginFrame[main]
open var backendBeginFrame: Long
Backend thread time of frame start since epoch [ns].
backendEndFrame[main]
open var backendEndFrame: Long
Backend thread time of frame end since epoch [ns].
beginFrame[main]
open var beginFrame: Long
Renderer.beginFrame() time since epoch [ns].
compositionToPresentLatency[main]
open var compositionToPresentLatency: Long
Time between the start of composition and the expected present time [ns].
denoisedGpuFrameDuration[main]
open var denoisedGpuFrameDuration: Long
Denoised frame duration on the GPU in nanoseconds [ns].
displayPresent[main]
open var displayPresent: Long
Actual presentation time of this frame since epoch [ns].
displayPresentInterval[main]
open var displayPresentInterval: Long
Display refresh rate period [ns].
endFrame[main]
open var endFrame: Long
Renderer.endFrame() time since epoch [ns].
expectedPresentLatency[main]
open var expectedPresentLatency: Long
Time between vsync and the system's expected presentation time [ns].
frameId[main]
open var frameId: Int
Monotonically increasing frame identifier.
frameScheduleTime[main]
open var frameScheduleTime: Long
Frame scheduling callback entry time since epoch [ns].
gpuFrameComplete[main]
open var gpuFrameComplete: Long
GPU thread time of frame end since epoch [ns] or 0.
gpuFrameDuration[main]
open var gpuFrameDuration: Long
Frame duration on the GPU in nanoseconds [ns].
INVALID[main]
val INVALID: Long = -1
Value not supported or unavailable.
PENDING[main]
val PENDING: Long = -2
Value not yet available (pending completion).
presentDeadline[main]
open var presentDeadline: Long
Deadline for queuing a frame [ns].
vsync[main]
open var vsync: Long
VSYNC hardware time of this frame since epoch [ns].