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

FrameRateOptions

open class FrameRateOptions

Use FrameRateOptions to set the desired frame rate and control how quickly the system reacts to GPU load changes. interval: desired frame interval in multiple of the refresh period, set in DisplayInfo (as 1 / DisplayInfo.refreshRate) The parameters below are relevant when some Views are using dynamic resolution scaling: headRoomRatio: additional headroom for the GPU as a ratio of the targetFrameTime. Useful for taking into account constant costs like post-processing or GPU drivers on different platforms. history: History size. higher values, tend to filter more (clamped to 30) scaleRate: rate at which the gpu load is adjusted to reach the target frame rate This value can be computed as 1 / N, where N is the number of frames needed to reach 64% of the target scale factor. Higher values make the dynamic resolution react faster.

See also

View.DynamicResolutionOptions
Renderer.DisplayInfo

Constructors

FrameRateOptions	[main]
constructor()

Properties

Name	Summary
headRoomRatio	[main]
open var headRoomRatio: Float
Additional headroom for the GPU as a ratio of the targetFrameTime.
history	[main]
open var history: Int
History size.
interval	[main]
open var interval: Float
Desired frame interval in unit of 1 / DisplayInfo.refreshRate.
scaleRate	[main]
open var scaleRate: Float
Rate at which the scale will change to reach the target frame rate.