Struct web_sys::OffscreenCanvas

#[repr(transparent)]
pub struct OffscreenCanvas { /* fields omitted */ }

The OffscreenCanvas object

MDN Documentation

This API requires the following crate features to be activated: OffscreenCanvas

Methods

impl OffscreenCanvas

pub fn new(width: u32, height: u32) -> Result<OffscreenCanvas, JsValue>

The new OffscreenCanvas(..) constructor, creating a new instance of OffscreenCanvas

MDN Documentation

This API requires the following crate features to be activated: OffscreenCanvas

impl OffscreenCanvas

pub fn get_context(&self, context_id: &str) -> Result<Option<Object>, JsValue>

The getContext() method

MDN Documentation

This API requires the following crate features to be activated: OffscreenCanvas

impl OffscreenCanvas

pub fn get_context_with_context_options(
    &self,
    context_id: &str,
    context_options: &JsValue
) -> Result<Option<Object>, JsValue>

The getContext() method

MDN Documentation

This API requires the following crate features to be activated: OffscreenCanvas

impl OffscreenCanvas

pub fn to_blob(&self) -> Result<Promise, JsValue>

The toBlob() method

MDN Documentation

This API requires the following crate features to be activated: OffscreenCanvas

impl OffscreenCanvas

pub fn to_blob_with_type(&self, type_: &str) -> Result<Promise, JsValue>

The toBlob() method

MDN Documentation

This API requires the following crate features to be activated: OffscreenCanvas

impl OffscreenCanvas

pub fn to_blob_with_type_and_encoder_options(
    &self,
    type_: &str,
    encoder_options: &JsValue
) -> Result<Promise, JsValue>

The toBlob() method

MDN Documentation

This API requires the following crate features to be activated: OffscreenCanvas

impl OffscreenCanvas

pub fn transfer_to_image_bitmap(&self) -> Result<ImageBitmap, JsValue>

The transferToImageBitmap() method

MDN Documentation

This API requires the following crate features to be activated: ImageBitmap, OffscreenCanvas

impl OffscreenCanvas

pub fn width(&self) -> u32

The width getter

MDN Documentation

This API requires the following crate features to be activated: OffscreenCanvas

impl OffscreenCanvas

pub fn set_width(&self, width: u32)

The width setter

MDN Documentation

This API requires the following crate features to be activated: OffscreenCanvas

impl OffscreenCanvas

pub fn height(&self) -> u32

The height getter

MDN Documentation

This API requires the following crate features to be activated: OffscreenCanvas

impl OffscreenCanvas

pub fn set_height(&self, height: u32)

The height setter

MDN Documentation

This API requires the following crate features to be activated: OffscreenCanvas

Methods from Deref<Target = EventTarget>

pub fn add_event_listener_with_callback(
    &self,
    type_: &str,
    listener: &Function
) -> Result<(), JsValue>

The addEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventTarget

pub fn add_event_listener_with_event_listener(
    &self,
    type_: &str,
    listener: &EventListener
) -> Result<(), JsValue>

The addEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventListener, EventTarget

pub fn add_event_listener_with_callback_and_add_event_listener_options(
    &self,
    type_: &str,
    listener: &Function,
    options: &AddEventListenerOptions
) -> Result<(), JsValue>

The addEventListener() method

MDN Documentation

This API requires the following crate features to be activated: AddEventListenerOptions, EventTarget

pub fn add_event_listener_with_event_listener_and_add_event_listener_options(
    &self,
    type_: &str,
    listener: &EventListener,
    options: &AddEventListenerOptions
) -> Result<(), JsValue>

The addEventListener() method

MDN Documentation

This API requires the following crate features to be activated: AddEventListenerOptions, EventListener, EventTarget

pub fn add_event_listener_with_callback_and_bool(
    &self,
    type_: &str,
    listener: &Function,
    options: bool
) -> Result<(), JsValue>

The addEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventTarget

pub fn add_event_listener_with_event_listener_and_bool(
    &self,
    type_: &str,
    listener: &EventListener,
    options: bool
) -> Result<(), JsValue>

The addEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventListener, EventTarget

pub fn add_event_listener_with_callback_and_add_event_listener_options_and_wants_untrusted(
    &self,
    type_: &str,
    listener: &Function,
    options: &AddEventListenerOptions,
    wants_untrusted: Option<bool>
) -> Result<(), JsValue>

The addEventListener() method

MDN Documentation

This API requires the following crate features to be activated: AddEventListenerOptions, EventTarget

pub fn add_event_listener_with_event_listener_and_add_event_listener_options_and_wants_untrusted(
    &self,
    type_: &str,
    listener: &EventListener,
    options: &AddEventListenerOptions,
    wants_untrusted: Option<bool>
) -> Result<(), JsValue>

The addEventListener() method

MDN Documentation

This API requires the following crate features to be activated: AddEventListenerOptions, EventListener, EventTarget

pub fn add_event_listener_with_callback_and_bool_and_wants_untrusted(
    &self,
    type_: &str,
    listener: &Function,
    options: bool,
    wants_untrusted: Option<bool>
) -> Result<(), JsValue>

The addEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventTarget

pub fn add_event_listener_with_event_listener_and_bool_and_wants_untrusted(
    &self,
    type_: &str,
    listener: &EventListener,
    options: bool,
    wants_untrusted: Option<bool>
) -> Result<(), JsValue>

The addEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventListener, EventTarget

pub fn dispatch_event(&self, event: &Event) -> Result<bool, JsValue>

The dispatchEvent() method

MDN Documentation

This API requires the following crate features to be activated: Event, EventTarget

pub fn remove_event_listener_with_callback(
    &self,
    type_: &str,
    listener: &Function
) -> Result<(), JsValue>

The removeEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventTarget

pub fn remove_event_listener_with_event_listener(
    &self,
    type_: &str,
    listener: &EventListener
) -> Result<(), JsValue>

The removeEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventListener, EventTarget

pub fn remove_event_listener_with_callback_and_event_listener_options(
    &self,
    type_: &str,
    listener: &Function,
    options: &EventListenerOptions
) -> Result<(), JsValue>

The removeEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventListenerOptions, EventTarget

pub fn remove_event_listener_with_event_listener_and_event_listener_options(
    &self,
    type_: &str,
    listener: &EventListener,
    options: &EventListenerOptions
) -> Result<(), JsValue>

The removeEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventListener, EventListenerOptions, EventTarget

pub fn remove_event_listener_with_callback_and_bool(
    &self,
    type_: &str,
    listener: &Function,
    options: bool
) -> Result<(), JsValue>

The removeEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventTarget

pub fn remove_event_listener_with_event_listener_and_bool(
    &self,
    type_: &str,
    listener: &EventListener,
    options: bool
) -> Result<(), JsValue>

The removeEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventListener, EventTarget

Trait Implementations

impl Clone for OffscreenCanvas

fn clone(&self) -> OffscreenCanvas

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<OffscreenCanvas> for OffscreenCanvas

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl AsRef<JsValue> for OffscreenCanvas

fn as_ref(&self) -> &JsValue

Performs the conversion.

impl AsRef<OffscreenCanvas> for OffscreenCanvas

fn as_ref(&self) -> &OffscreenCanvas

Performs the conversion.

impl AsRef<EventTarget> for OffscreenCanvas

fn as_ref(&self) -> &EventTarget

Performs the conversion.

impl AsRef<Object> for OffscreenCanvas

fn as_ref(&self) -> &Object

Performs the conversion.

impl From<JsValue> for OffscreenCanvas

fn from(obj: JsValue) -> OffscreenCanvas

Performs the conversion.

impl From<OffscreenCanvas> for JsValue

fn from(obj: OffscreenCanvas) -> JsValue

Performs the conversion.

impl From<OffscreenCanvas> for EventTarget

fn from(obj: OffscreenCanvas) -> EventTarget

Performs the conversion.

impl From<OffscreenCanvas> for Object

fn from(obj: OffscreenCanvas) -> Object

Performs the conversion.

impl Eq for OffscreenCanvas

impl Deref for OffscreenCanvas

type Target = EventTarget

The resulting type after dereferencing.

fn deref(&self) -> &EventTarget

Dereferences the value.

impl Debug for OffscreenCanvas

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

Formats the value using the given formatter.

impl JsCast for OffscreenCanvas

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

fn unchecked_from_js_ref(val: &JsValue) -> &Self

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

fn has_type<T>(&self) -> bool where
    T: JsCast, 

Test whether this JS value has a type T.

fn dyn_into<T>(self) -> Result<T, Self> where
    T: JsCast, 

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn dyn_ref<T>(&self) -> Option<&T> where
    T: JsCast, 

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn unchecked_into<T>(self) -> T where
    T: JsCast, 

Performs a zero-cost unchecked cast into the specified type.

fn unchecked_ref<T>(&self) -> &T where
    T: JsCast, 

Performs a zero-cost unchecked cast into a reference to the specified type.

fn is_instance_of<T>(&self) -> bool where
    T: JsCast, 

Test whether this JS value is an instance of the type T.

fn is_type_of(val: &JsValue) -> bool

Performs a dynamic check to see whether the JsValue provided is a value of this type.

impl IntoWasmAbi for OffscreenCanvas

type Abi = <JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl<'a> IntoWasmAbi for &'a OffscreenCanvas

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl FromWasmAbi for OffscreenCanvas

type Abi = <JsValue as FromWasmAbi>::Abi

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl RefFromWasmAbi for OffscreenCanvas

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<OffscreenCanvas>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don't persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl WasmDescribe for OffscreenCanvas

fn describe()

impl OptionIntoWasmAbi for OffscreenCanvas

fn none() -> Self::Abi

Returns an ABI instance indicating "none", which JS will interpret as the None branch of this option.

impl<'a> OptionIntoWasmAbi for &'a OffscreenCanvas

fn none() -> Self::Abi

Returns an ABI instance indicating "none", which JS will interpret as the None branch of this option.

impl OptionFromWasmAbi for OffscreenCanvas

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a "none" instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.