chrome-devtools-kotlin / org.hildan.chrome.devtools.domains.headlessexperimental / BeginFrameRequest

BeginFrameRequest

data class BeginFrameRequest

Request object containing input parameters for the HeadlessExperimentalDomain.beginFrame command.

Constructors

<init>

Request object containing input parameters for the HeadlessExperimentalDomain.beginFrame command.

BeginFrameRequest(frameTimeTicks: Double? = null, interval: Double? = null, noDisplayUpdates: Boolean? = null, screenshot: ScreenshotParams? = null)

Properties

frameTimeTicks

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

val frameTimeTicks: Double?

interval

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.

val interval: Double?

noDisplayUpdates

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.

val noDisplayUpdates: Boolean?

screenshot

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.

val screenshot: ScreenshotParams?