Skip to main content

WebGpuInitError

Enum WebGpuInitError 

Source
pub enum WebGpuInitError {
Show 18 variants NavigatorLookup(JsValue), NavigatorGpuMissing, RequestAdapterLookup(JsValue), RequestAdapterCall(JsValue), AdapterPromise(JsValue), AdapterUnavailable, RequestDeviceLookup(JsValue), RequestDeviceCall(JsValue), DevicePromise(JsValue), DeviceUnavailable, CanvasNotFound(String), CanvasQuery(JsValue), CanvasContextUnavailable, PreferredFormatLookup(JsValue), PreferredFormatCall(JsValue), PreferredFormatType(JsValue), ConfigureLookup(JsValue), QueueLookup(JsValue),
}
Expand description

Errors that can occur while asynchronously initializing a WebGpuRenderer.

Each variant maps to one specific failure mode that the WebGPU init pipeline can encounter when calling into the browser’s GPU API. The underlying JS error (when available) is carried as a JsValue so callers can surface the exact diagnostic string without losing fidelity.

Instead of logging diagnostics inside the engine, WebGpuRenderer::init returns Result<WebGpuRenderer, WebGpuInitError> and lets the caller decide how to react — typically via Console::error on the example side or by falling back to the Canvas 2D backend.

Variants§

§

NavigatorLookup(JsValue)

Reflect::get(navigator, "webgpu") threw an exception.

Surfaced when the JavaScript binding lookup itself fails rather than simply returning undefined/null. Carries the original JS error.

§

NavigatorGpuMissing

navigator.gpu is undefined or null.

The browser does not expose WebGPU on the current origin. The most common causes are serving over an insecure origin (must be HTTPS or localhost) or running in a browser that lacks the WebGPU feature.

§

RequestAdapterLookup(JsValue)

Reflect::get(gpu, "requestAdapter") threw an exception.

Carries the original JS error returned by the reflect call.

§

RequestAdapterCall(JsValue)

gpu.requestAdapter() threw an exception synchronously.

Carries the thrown JS error or value.

§

AdapterPromise(JsValue)

The adapter promise rejected, or the INIT_PROMISE_TIMEOUT_MILLIS race timer fired before the adapter was produced.

Carries the rejection value, which may be a string, an error object, or undefined when the timeout won the race.

§

AdapterUnavailable

requestAdapter() resolved to null or undefined.

No compatible GPU adapter exists for the requested powerPreference.

§

RequestDeviceLookup(JsValue)

Reflect::get(adapter, "requestDevice") threw an exception.

§

RequestDeviceCall(JsValue)

adapter.requestDevice() threw an exception synchronously.

§

DevicePromise(JsValue)

The device promise rejected, or the INIT_PROMISE_TIMEOUT_MILLIS race timer fired before the device was produced.

§

DeviceUnavailable

requestDevice() resolved to null or undefined.

The adapter could not allocate a device, typically because the adapter is in a device-lost state.

§

CanvasNotFound(String)

document.querySelector(canvas_selector) returned None.

The canvas element is not in the DOM yet (or its selector is wrong). Carries the selector string that was queried.

§

CanvasQuery(JsValue)

document.querySelector(canvas_selector) threw an exception.

§

CanvasContextUnavailable

canvas.get_context("webgpu") returned None.

The canvas is already using a different context type, or WebGPU is disabled for this canvas.

§

PreferredFormatLookup(JsValue)

Reflect::get(gpu, "getPreferredCanvasFormat") threw an exception.

§

PreferredFormatCall(JsValue)

gpu.getPreferredCanvasFormat() threw an exception synchronously.

§

PreferredFormatType(JsValue)

getPreferredCanvasFormat() resolved to a value that is not a string.

Carries the offending JS value so callers can log its type/name.

§

ConfigureLookup(JsValue)

Reflect::get(context, "configure") threw an exception.

§

QueueLookup(JsValue)

Reflect::get(device, "queue") threw an exception.

Implementations§

Source§

impl WebGpuInitError

Implements helper methods on WebGpuInitError.

These methods provide ergonomic access to the diagnostic code and the underlying JS error value, which are useful when surfacing the failure to the user (e.g. via Console::error from the example crate).

Source

pub fn code(&self) -> &'static str

Returns a short, machine-readable identifier for this error variant.

Suitable for use as a stable error code in logs or telemetry. The codes are stable across releases.

§Returns
  • &'static str - The error code (e.g. "WEBGPU_NAVIGATOR_GPU_MISSING").
Source

pub fn js_error(&self) -> Option<&JsValue>

Returns the underlying JS error value if this variant carries one.

Variants that do not capture a JS value (e.g. NavigatorGpuMissing, AdapterUnavailable, CanvasNotFound, CanvasContextUnavailable) return None.

§Returns
  • Option<&JsValue> - The captured JS error, if any.

Trait Implementations§

Source§

impl Clone for WebGpuInitError

Source§

fn clone(&self) -> WebGpuInitError

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 Debug for WebGpuInitError

Source§

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

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

impl Display for WebGpuInitError

Implements std::fmt::Display for WebGpuInitError.

The formatted message is intended for end-user diagnostic output (typically forwarded to Console::error by the calling application) and includes the variant code plus a human-readable description. When the variant carries a JS error, its Debug form is appended.

Source§

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

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

impl Error for WebGpuInitError

Implements the standard std::error::Error trait for WebGpuInitError.

The source() method delegates to the underlying JS error’s toString() representation when present, otherwise returns None. The engine never logs or prints anything; this impl exists solely so the error composes with Result-based APIs and ? operator chains.

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more

Auto Trait Implementations§

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more