Struct CaptureScreenshotBuilder 

pub struct CaptureScreenshotBuilder { /* private fields */ }

Builder for CaptureScreenshot.

Implementations

impl CaptureScreenshotBuilder

pub fn format<VALUE: Into<CaptureScreenshotFormatOption>>( &mut self, value: VALUE, ) -> &mut Self

Image compression format (defaults to png).

pub fn quality<VALUE: Into<JsUInt>>(&mut self, value: VALUE) -> &mut Self

Compression quality from range [0..100] (jpeg only).

pub fn clip<VALUE: Into<Viewport>>(&mut self, value: VALUE) -> &mut Self

Capture the screenshot of a given region only.

pub fn from_surface<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Capture the screenshot from the surface, rather than the view. Defaults to true.

pub fn capture_beyond_viewport<VALUE: Into<bool>>( &mut self, value: VALUE, ) -> &mut Self

Capture the screenshot beyond the viewport. Defaults to false.

pub fn optimize_for_speed<VALUE: Into<bool>>( &mut self, value: VALUE, ) -> &mut Self

Optimize image encoding for speed, not for resulting size (defaults to false)

pub fn build(&self) -> Result<CaptureScreenshot, CaptureScreenshotBuilderError>

Builds a new CaptureScreenshot.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for CaptureScreenshotBuilder

fn clone(&self) -> CaptureScreenshotBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for CaptureScreenshotBuilder

fn default() -> Self

Returns the “default value” for a type.