filament/io.github.erkko68.filament/Renderer/FrameRateOptions

FrameRateOptions

actual class FrameRateOptions

Frame rate control and dynamic resolution scaling options.

Controls the desired frame rate and how quickly the system reacts to GPU load changes.

interval: Desired frame interval in multiples of the refresh period (1 / DisplayInfo.refreshRate). Set to 1 to render at the display refresh rate.

The parameters below are relevant when some Views are using dynamic resolution scaling:

headRoomRatio: Additional headroom for the GPU as a ratio of the target frame time. Useful for taking into account constant costs like post-processing or GPU drivers on different platforms. 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. history: History size for filtering GPU load. Higher values tend to filter more. Clamped to 31.

expect class FrameRateOptions

Frame rate control and dynamic resolution scaling options.

Controls the desired frame rate and how quickly the system reacts to GPU load changes.

interval: Desired frame interval in multiples of the refresh period (1 / DisplayInfo.refreshRate). Set to 1 to render at the display refresh rate.

The parameters below are relevant when some Views are using dynamic resolution scaling:

headRoomRatio: Additional headroom for the GPU as a ratio of the target frame time. Useful for taking into account constant costs like post-processing or GPU drivers on different platforms. 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. history: History size for filtering GPU load. Higher values tend to filter more. Clamped to 31.

actual class FrameRateOptions

Frame rate control and dynamic resolution scaling options.

Controls the desired frame rate and how quickly the system reacts to GPU load changes.

interval: Desired frame interval in multiples of the refresh period (1 / DisplayInfo.refreshRate). Set to 1 to render at the display refresh rate.

The parameters below are relevant when some Views are using dynamic resolution scaling:

headRoomRatio: Additional headroom for the GPU as a ratio of the target frame time. Useful for taking into account constant costs like post-processing or GPU drivers on different platforms. 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. history: History size for filtering GPU load. Higher values tend to filter more. Clamped to 31.

actual class FrameRateOptions

Frame rate control and dynamic resolution scaling options.

Controls the desired frame rate and how quickly the system reacts to GPU load changes.

interval: Desired frame interval in multiples of the refresh period (1 / DisplayInfo.refreshRate). Set to 1 to render at the display refresh rate.

The parameters below are relevant when some Views are using dynamic resolution scaling:

headRoomRatio: Additional headroom for the GPU as a ratio of the target frame time. Useful for taking into account constant costs like post-processing or GPU drivers on different platforms. 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. history: History size for filtering GPU load. Higher values tend to filter more. Clamped to 31.

actual class FrameRateOptions

Frame rate control and dynamic resolution scaling options.

Controls the desired frame rate and how quickly the system reacts to GPU load changes.

interval: Desired frame interval in multiples of the refresh period (1 / DisplayInfo.refreshRate). Set to 1 to render at the display refresh rate.

The parameters below are relevant when some Views are using dynamic resolution scaling:

headRoomRatio: Additional headroom for the GPU as a ratio of the target frame time. Useful for taking into account constant costs like post-processing or GPU drivers on different platforms. 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. history: History size for filtering GPU load. Higher values tend to filter more. Clamped to 31.

Constructors

FrameRateOptions

actual constructor()

expect constructor()

constructor()

actual constructor()

actual constructor()

Properties

actual var headRoomRatio: Float

Additional headroom for the GPU as a fraction of target frame time.

expect var headRoomRatio: Float

Additional headroom for the GPU as a fraction of target frame time.

actual var headRoomRatio: Float

Additional headroom for the GPU as a fraction of target frame time.

actual var headRoomRatio: Float

Additional headroom for the GPU as a fraction of target frame time.

actual var headRoomRatio: Float

Additional headroom for the GPU as a fraction of target frame time.

actual var history: Int

History size for load filtering (clamped to 31).

expect var history: Int

History size for load filtering (clamped to 31).

actual var history: Int

History size for load filtering (clamped to 31).

actual var history: Int

History size for load filtering (clamped to 31).

actual var history: Int

History size for load filtering (clamped to 31).

actual var interval: Float

Desired frame interval (1 = render every vsync).

expect var interval: Float

Desired frame interval (1 = render every vsync).

actual var interval: Float

Desired frame interval (1 = render every vsync).

actual var interval: Float

Desired frame interval (1 = render every vsync).

actual var interval: Float

Desired frame interval (1 = render every vsync).

val nativeOptions: Renderer.FrameRateOptions

actual var scaleRate: Float

Rate at which GPU load is adjusted; computed as 1/N frames to reach 64% target.

expect var scaleRate: Float

Rate at which GPU load is adjusted; computed as 1/N frames to reach 64% target.

actual var scaleRate: Float

Rate at which GPU load is adjusted; computed as 1/N frames to reach 64% target.

actual var scaleRate: Float

Rate at which GPU load is adjusted; computed as 1/N frames to reach 64% target.

actual var scaleRate: Float

Rate at which GPU load is adjusted; computed as 1/N frames to reach 64% target.