Struct wgpu::Instance

pub struct Instance { /* fields omitted */ }

Instance of wgpu. First thing you create when using wgpu.

An instance sets up the context for all other wgpu objects.

Instances and adapters do not have to be kept alive, only devices.

Methods

impl Instance

pub fn new() -> Self

Create an new instance of wgpu.

pub fn enumerate_adapters(
    &self,
    unsafe_extensions: UnsafeExtensions,
    backends: BackendBit
) -> impl Iterator<Item = Adapter>

Retrieves all available [Adapter]s that match the given backends.

pub unsafe fn create_surface<W: HasRawWindowHandle>(
    &self,
    window: &W
) -> Surface

Creates a surface from a raw window handle.

Safety

• Raw Window Handle must be a valid object to create a surface upon.

pub fn request_adapter(
    &self,
    options: &RequestAdapterOptions,
    unsafe_extensions: UnsafeExtensions,
    backends: BackendBit
) -> impl Future<Output = Option<Adapter>> + Send

Retrieves an [Adapter] which matches the given options.

Some options are "soft", so treated as non-mandatory. Others are "hard".

If no adapters are found that suffice all the "hard" options, None is returned.