Struct BeginFrameParams

pub struct BeginFrameParams {
    pub frame_time_ticks: Option<f64>,
    pub interval: Option<f64>,
    pub no_display_updates: Option<bool>,
    pub screenshot: Option<ScreenshotParams>,
}

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.gle/chrome-headless-rendering for more background. beginFrame

Fields

frame_time_ticks: Option<f64>

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

interval: 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.

no_display_updates: 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.

screenshot: 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.

Implementations

impl BeginFrameParams

pub fn builder() -> BeginFrameParamsBuilder

impl BeginFrameParams

pub const IDENTIFIER: &'static str = "HeadlessExperimental.beginFrame"

Trait Implementations

impl Clone for BeginFrameParams

fn clone(&self) -> BeginFrameParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Command for BeginFrameParams

type Response = BeginFrameReturns

The type of the response this request triggers on the chromium server

fn response_from_value(response: Value) -> Result<Self::Response, Error>

deserialize the response from json

impl Debug for BeginFrameParams

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

Formats the value using the given formatter.

impl Default for BeginFrameParams

fn default() -> BeginFrameParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BeginFrameParams

fn deserialize<__D>( __deserializer: __D, ) -> Result<BeginFrameParams, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Method for BeginFrameParams

fn identifier(&self) -> Cow<'static, str>

The whole string identifier for this method like: DOM.removeNode

fn domain_name(&self) -> Cow<'static, str>

The name of the domain this method belongs to: DOM

fn method_name(&self) -> Cow<'static, str>

The standalone identifier of the method inside the domain: removeNode

fn split(&self) -> (Cow<'static, str>, Cow<'static, str>)

Tuple of (domain_name, method_name) : (DOM, removeNode)

impl MethodType for BeginFrameParams

fn method_id() -> Cow<'static, str>

where BeginFrameParams: Sized,

The identifier for this event’s method field

impl PartialEq for BeginFrameParams

fn eq(&self, other: &BeginFrameParams) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for BeginFrameParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BeginFrameParams