Struct BeginFrameCommand 

pub struct BeginFrameCommand { /* private fields */ }

Available on crate features experimental and HeadlessExperimental and Page and Runtime only.

Sends a BeginFrame to the target and returns when the frame was completed. Optionally captures a screenshot from the resulting frame. Requires that the target was created with enabled BeginFrameControl. Designed for use with –run-all-compositor-stages-before-draw, see also https://goo.gl/3zHXhB for more background.

Implementations

impl BeginFrameCommand

pub fn builder() -> BeginFrameCommandBuilder

pub fn frame_time_ticks(&self) -> Option<&f64>

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

pub fn interval(&self) -> Option<&f64>

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.

pub fn no_display_updates(&self) -> Option<&bool>

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.

pub fn screenshot(&self) -> Option<&ScreenshotParams>

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.

Trait Implementations

impl Clone for BeginFrameCommand

fn clone(&self) -> BeginFrameCommand

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Command for BeginFrameCommand

const METHOD: &'static str = "HeadlessExperimental.beginFrame"

Command method name.

type Return = BeginFrameReturn

Return type.

fn into_request(self, session_id: Option<SessionId>, id: u32) -> Request<Self>

where Self: Sized,

Into command request.

impl Debug for BeginFrameCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BeginFrameCommand

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BeginFrameCommand

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.