cdp/dev.kdriver.cdp.domain/HeadlessExperimental/BeginFrameParameter

BeginFrameParameter

@Serializable
data class BeginFrameParameter(val frameTimeTicks: Double? = null, val interval: Double? = null, val noDisplayUpdates: Boolean? = null, val screenshot: HeadlessExperimental.ScreenshotParams? = null)

Constructors

Link copied to clipboard
constructor(frameTimeTicks: Double? = null, interval: Double? = null, noDisplayUpdates: Boolean? = null, screenshot: HeadlessExperimental.ScreenshotParams? = null)

Properties

Link copied to clipboard
val frameTimeTicks: Double? = null

Timestamp of this BeginFrame in Renderer TimeTicks (milliseconds of uptime). If not set, the current time will be used.

Link copied to clipboard
val interval: Double? = null

The interval between BeginFrames that is reported to the compositor, in milliseconds. Defaults to a 60 frames/second interval, i.e. about 16.666 milliseconds.

Link copied to clipboard
val noDisplayUpdates: Boolean? = null

Whether updates should not be committed and drawn onto the display. False by default. If true, only side effects of the BeginFrame will be run, such as layout and animations, but any visual updates may not be visible on the display or in screenshots.

Link copied to clipboard
val screenshot: HeadlessExperimental.ScreenshotParams? = null

If set, a screenshot of the frame will be captured and returned in the response. Otherwise, no screenshot will be captured. Note that capturing a screenshot can fail, for example, during renderer initialization. In such a case, no screenshot data will be returned.