HeadlessExperimentalClientBeginFrameAsync Method

public Task<BeginFrameResponse> BeginFrameAsync(
	double? frameTimeTicks = null,
	double? interval = null,
	bool? noDisplayUpdates = null,
	ScreenshotParams screenshot = null
)

public:
Task<BeginFrameResponse^>^ BeginFrameAsync(
	Nullable<double> frameTimeTicks = nullptr, 
	Nullable<double> interval = nullptr, 
	Nullable<bool> noDisplayUpdates = nullptr, 
	ScreenshotParams^ screenshot = nullptr
)

Parameters

frameTimeTicks  NullableDouble  (Optional)

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

interval  NullableDouble  (Optional)

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.

noDisplayUpdates  NullableBoolean  (Optional)

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

screenshot  ScreenshotParams  (Optional)

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.

Return Value

Reference