Enum SurfaceTarget 

#[non_exhaustive]
pub enum SurfaceTarget<'window> {
    DisplayAndWindow(Box<dyn DisplayAndWindowHandle + 'window>),
    Window(Box<dyn WindowHandle + 'window>),
    Canvas(HtmlCanvasElement),
    OffscreenCanvas(OffscreenCanvas),
}

The window/canvas/surface/swap-chain/etc. a surface is attached to, for use with safe surface creation.

This is either a window or an actual web canvas depending on the platform and enabled features. Refer to the individual variants for more information.

See also SurfaceTargetUnsafe for unsafe variants.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

DisplayAndWindow(Box<dyn DisplayAndWindowHandle + 'window>)

Window and display handle producer.

If the specified display and window handle are not supported by any of the backends, then the surface will not be supported by any adapters.

Errors

• On WebGL2: surface creation returns an error if the browser does not support WebGL2, or declines to provide GPU access (such as due to a resource shortage).

Panics

• On macOS/Metal: will panic if not called on the main thread.
• On web: will panic if the HasWindowHandle does not properly refer to a canvas element.
• On all platforms: If crate::InstanceDescriptor::display was not None but its value is not identical to that returned by HasDisplayHandle::display_handle().

Window(Box<dyn WindowHandle + 'window>)

Window handle producer.

HasWindowHandle-only version of SurfaceTarget::DisplayAndWindow.

This requires that the display handle was already passed through crate::InstanceDescriptor::display.

Canvas(HtmlCanvasElement)

Available on web only.

Surface from a web_sys::HtmlCanvasElement.

The canvas argument must be a valid <canvas> element to create a surface upon.

Errors

• On WebGL2: surface creation will return an error if the browser does not support WebGL2, or declines to provide GPU access (such as due to a resource shortage).

OffscreenCanvas(OffscreenCanvas)

Available on web only.

Surface from a web_sys::OffscreenCanvas.

The canvas argument must be a valid OffscreenCanvas object to create a surface upon.

Errors

• On WebGL2: surface creation will return an error if the browser does not support WebGL2, or declines to provide GPU access (such as due to a resource shortage).

Implementations

impl<'a> SurfaceTarget<'a>

pub fn from_window_without_display(window: impl WindowHandle + 'a) -> Self

Constructor for Self::Window without consuming a display handle

Trait Implementations

impl Debug for SurfaceTarget<'_>

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

Formats the value using the given formatter.

impl<'a, T> From<T> for SurfaceTarget<'a>

where T: DisplayAndWindowHandle + 'a,

fn from(window: T) -> Self

Converts to this type from the input type.