Enum wgpu::ExternalImageSource

pub enum ExternalImageSource {
    ImageBitmap(ImageBitmap),
    HTMLVideoElement(HtmlVideoElement),
    HTMLCanvasElement(HtmlCanvasElement),
    OffscreenCanvas(OffscreenCanvas),
}

Available on webgpu or webgl only.

Source of an external texture copy.

Corresponds to the implicit union type on WebGPU GPUImageCopyExternalImage.source.

Variants

ImageBitmap(ImageBitmap)

Copy from a previously-decoded image bitmap.

HTMLVideoElement(HtmlVideoElement)

Copy from a current frame of a video element.

HTMLCanvasElement(HtmlCanvasElement)

Copy from a on-screen canvas.

OffscreenCanvas(OffscreenCanvas)

Copy from a off-screen canvas.

Requires DownlevelFlags::UNRESTRICTED_EXTERNAL_TEXTURE_COPIES

Implementations

impl ExternalImageSource

pub fn width(&self) -> u32

Available on WebAssembly only.

Gets the pixel, not css, width of the source.

pub fn height(&self) -> u32

Available on WebAssembly only.

Gets the pixel, not css, height of the source.

Methods from Deref<Target = Object>

pub fn constructor(&self) -> Function

Available on webgl or webgpu only.

The constructor property returns a reference to the Object constructor function that created the instance object.

MDN documentation

pub fn has_own_property(&self, property: &JsValue) -> bool

Available on webgl or webgpu only.

The hasOwnProperty() method returns a boolean indicating whether the object has the specified property as its own property (as opposed to inheriting it).

MDN documentation

pub fn is_prototype_of(&self, value: &JsValue) -> bool

Available on webgl or webgpu only.

The isPrototypeOf() method checks if an object exists in another object’s prototype chain.

MDN documentation

pub fn property_is_enumerable(&self, property: &JsValue) -> bool

Available on webgl or webgpu only.

The propertyIsEnumerable() method returns a Boolean indicating whether the specified property is enumerable.

MDN documentation

pub fn to_locale_string(&self) -> JsString

Available on webgl or webgpu only.

The toLocaleString() method returns a string representing the object. This method is meant to be overridden by derived objects for locale-specific purposes.

MDN documentation

pub fn to_string(&self) -> JsString

Available on webgl or webgpu only.

The toString() method returns a string representing the object.

MDN documentation

pub fn value_of(&self) -> Object

Available on webgl or webgpu only.

The valueOf() method returns the primitive value of the specified object.

MDN documentation

Methods from Deref<Target = JsValue>

pub const NULL: JsValue = _

pub const UNDEFINED: JsValue = _

pub const TRUE: JsValue = _

pub const FALSE: JsValue = _

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

Available on webgl or webgpu only.

Returns the f64 value of this JS value if it’s an instance of a number.

If this JS value is not an instance of a number then this returns None.

pub fn is_string(&self) -> bool

Available on webgl or webgpu only.

Tests whether this JS value is a JS string.

pub fn as_string(&self) -> Option<String>

Available on (webgl or webgpu) and crate feature std only.

If this JS value is a string value, this function copies the JS string value into wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

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

Available on webgl or webgpu only.

Returns the bool value of this JS value if it’s an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

pub fn is_null(&self) -> bool

Available on webgl or webgpu only.

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool

Available on webgl or webgpu only.

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool

Available on webgl or webgpu only.

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool

Available on webgl or webgpu only.

Tests whether typeof self == "object" && self !== null.

pub fn is_array(&self) -> bool

Available on webgl or webgpu only.

Tests whether this JS value is an instance of Array.

pub fn is_function(&self) -> bool

Available on webgl or webgpu only.

Tests whether the type of this JS value is function.

pub fn is_bigint(&self) -> bool

Available on webgl or webgpu only.

Tests whether the type of this JS value is bigint.

pub fn js_typeof(&self) -> JsValue

Available on webgl or webgpu only.

Applies the unary typeof JS operator on a JsValue.

MDN documentation

pub fn js_in(&self, obj: &JsValue) -> bool

Available on webgl or webgpu only.

Applies the binary in JS operator on the two JsValues.

MDN documentation

pub fn is_truthy(&self) -> bool

Available on webgl or webgpu only.

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool

Available on webgl or webgpu only.

Tests whether the value is “falsy”.

pub fn loose_eq(&self, other: &JsValue) -> bool

Available on webgl or webgpu only.

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

pub fn bit_not(&self) -> JsValue

Available on webgl or webgpu only.

Applies the unary ~ JS operator on a JsValue.

MDN documentation

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Available on webgl or webgpu only.

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Available on webgl or webgpu only.

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

pub fn pow(&self, rhs: &JsValue) -> JsValue

Available on webgl or webgpu only.

Applies the binary ** JS operator on the two JsValues.

MDN documentation

pub fn lt(&self, other: &JsValue) -> bool

Available on webgl or webgpu only.

Applies the binary < JS operator on the two JsValues.

MDN documentation

pub fn le(&self, other: &JsValue) -> bool

Available on webgl or webgpu only.

Applies the binary <= JS operator on the two JsValues.

MDN documentation

pub fn ge(&self, other: &JsValue) -> bool

Available on webgl or webgpu only.

Applies the binary >= JS operator on the two JsValues.

MDN documentation

pub fn gt(&self, other: &JsValue) -> bool

Available on webgl or webgpu only.

Applies the binary > JS operator on the two JsValues.

MDN documentation

pub fn unchecked_into_f64(&self) -> f64

Available on webgl or webgpu only.

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

Trait Implementations

impl Clone for ExternalImageSource

fn clone(&self) -> ExternalImageSource

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExternalImageSource

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

Formats the value using the given formatter.

impl Deref for ExternalImageSource

Available on WebAssembly only.

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &<ExternalImageSource as Deref>::Target

Dereferences the value.

impl Send for ExternalImageSource

Available on WebAssembly and crate feature fragile-send-sync-non-atomic-wasm and non-target feature atomics only.

impl Sync for ExternalImageSource

Available on WebAssembly and crate feature fragile-send-sync-non-atomic-wasm and non-target feature atomics only.