Skip to main content

BeginFrameParams

Struct BeginFrameParams 

Source
pub struct BeginFrameParams<'a> { /* private fields */ }
Expand description

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.

Implementations§

Source§

impl<'a> BeginFrameParams<'a>

Source

pub fn builder() -> BeginFrameParamsBuilder<'a>

Creates a builder for this type.

Source

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.

Source

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.

Source

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.

Source

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

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.

Source§

impl<'a> BeginFrameParams<'a>

Source

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

Trait Implementations§

Source§

impl<'a> CdpCommand<'a> for BeginFrameParams<'a>

Source§

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

Source§

type Response = BeginFrameReturns<'a>

Source§

impl<'a> Clone for BeginFrameParams<'a>

Source§

fn clone(&self) -> BeginFrameParams<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for BeginFrameParams<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Default for BeginFrameParams<'a>

Source§

fn default() -> BeginFrameParams<'a>

Returns the “default value” for a type. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<'a> Serialize for BeginFrameParams<'a>

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for BeginFrameParams<'a>

§

impl<'a> RefUnwindSafe for BeginFrameParams<'a>

§

impl<'a> Send for BeginFrameParams<'a>

§

impl<'a> Sync for BeginFrameParams<'a>

§

impl<'a> Unpin for BeginFrameParams<'a>

§

impl<'a> UnsafeUnpin for BeginFrameParams<'a>

§

impl<'a> UnwindSafe for BeginFrameParams<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,