Struct Instance

pub struct Instance {
    inner: DispatchInstance,
}

Context for all other wgpu objects. Instance of wgpu.

This is the first thing you create when using wgpu. Its primary use is to create Adapters and Surfaces.

Does not have to be kept alive.

Corresponds to WebGPU GPU.

Fields

inner: DispatchInstance

Implementations

impl Instance

pub const fn enabled_backend_features() -> Backends

Returns which backends can be picked for the current build configuration.

The returned set depends on a combination of target platform and enabled features. This does not do any runtime checks and is exclusively based on compile time information.

InstanceDescriptor::backends does not need to be a subset of this, but any backend that is not in this set, will not be picked.

pub fn new(_instance_desc: &InstanceDescriptor) -> Self

Create an new instance of wgpu.

Arguments

• instance_desc - Has fields for which backends wgpu will choose during instantiation, and which DX12 shader compiler wgpu will use.

  Backends::BROWSER_WEBGPU takes a special role: If it is set and a navigator.gpu object is present, this instance will only be able to create WebGPU adapters.

  ⚠️ On some browsers this check is insufficient to determine whether WebGPU is supported, as the browser may define the navigator.gpu object, but be unable to create any WebGPU adapters. For targeting both WebGPU & WebGL is recommended to use crate::util::new_instance_with_webgpu_detection.

  If you instead want to force use of WebGL, either disable the webgpu compile-time feature or don’t add the Backends::BROWSER_WEBGPU flag to the the instance_desc’s backends field. If it is set and WebGPU support is not detected, the instance will use wgpu-core to create adapters. Meaning that if the webgl feature is enabled, it is able to create a WebGL adapter.

Panics

If no backend feature for the active target platform is enabled, this method will panic, see Instance::enabled_backend_features().

pub unsafe fn from_hal<A: HalApi>(hal_instance: A::Instance) -> Self

Available on wgpu_core only.

Create an new instance of wgpu from a wgpu-hal instance.

Arguments

• hal_instance - wgpu-hal instance.

Safety

Refer to the creation of wgpu-hal Instance for every backend.

pub unsafe fn as_hal<A: HalApi>(&self) -> Option<&A::Instance>

Available on wgpu_core only.

Return a reference to a specific backend instance, if available.

If this Instance has a wgpu-hal Instance for backend A, return a reference to it. Otherwise, return None.

Safety

• The raw instance handle returned must not be manually destroyed.

pub unsafe fn from_core(core_instance: Instance) -> Self

Available on wgpu_core only.

Create an new instance of wgpu from a wgpu-core instance.

Arguments

• core_instance - wgpu-core instance.

Safety

Refer to the creation of wgpu-core Instance.

pub fn from_custom<T: InstanceInterface>(instance: T) -> Self

Available on custom only.

Creates instance from custom context implementation

pub fn as_custom<T: InstanceInterface>(&self) -> Option<&T>

Available on custom only.

Returns custom implementation of Instance (if custom backend and is internally T)

pub fn enumerate_adapters(&self, backends: Backends) -> Vec<Adapter>

Available on wgpu_core only.

Retrieves all available Adapters that match the given Backends.

Arguments

• backends - Backends from which to enumerate adapters.

pub fn request_adapter( &self, options: &RequestAdapterOptions<'_, '_>, ) -> impl Future<Output = Result<Adapter, RequestAdapterError>> + WasmNotSend

Retrieves an Adapter which matches the given RequestAdapterOptions.

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

If no adapters are found that satisfy all the “hard” options, an error is returned.

When targeting WebGL2, a compatible_surface must be specified; using RequestAdapterOptions::default() will not succeed.

pub unsafe fn create_adapter_from_hal<A: HalApi>( &self, hal_adapter: ExposedAdapter<A>, ) -> Adapter

Available on wgpu_core only.

Converts a wgpu-hal ExposedAdapter to a wgpu Adapter.

Safety

hal_adapter must be created from this instance internal handle.

pub fn create_surface<'window>( &self, target: impl Into<SurfaceTarget<'window>>, ) -> Result<Surface<'window>, CreateSurfaceError>

Creates a new surface targeting a given window/canvas/surface/etc..

Internally, this creates surfaces for all backends that are enabled for this instance.

See SurfaceTarget for what targets are supported. See Instance::create_surface_unsafe for surface creation with unsafe target variants.

Most commonly used are window handles (or provider of windows handles) which can be passed directly as they’re automatically converted to SurfaceTarget.

pub unsafe fn create_surface_unsafe<'window>( &self, target: SurfaceTargetUnsafe, ) -> Result<Surface<'window>, CreateSurfaceError>

Creates a new surface targeting a given window/canvas/surface/etc. using an unsafe target.

Internally, this creates surfaces for all backends that are enabled for this instance.

See SurfaceTargetUnsafe for what targets are supported. See Instance::create_surface for surface creation with safe target variants.

Safety

• See respective SurfaceTargetUnsafe variants for safety requirements.

pub fn poll_all(&self, force_wait: bool) -> bool

Polls all devices.

If force_wait is true and this is not running on the web, then this function will block until all in-flight buffers have been mapped and all submitted commands have finished execution.

Return true if all devices’ queues are empty, or false if there are queue submissions still in flight. (Note that, unless access to all Queues associated with this Instance is coordinated somehow, this information could be out of date by the time the caller receives it. Queues can be shared between threads, and other threads could submit new work at any time.)

On the web, this is a no-op. Devices are automatically polled.

pub fn generate_report(&self) -> Option<GlobalReport>

Available on wgpu_core only.

Generates memory report.

Returns None if the feature is not supported by the backend which happens only when WebGPU is pre-selected by the instance creation.

pub fn wgsl_language_features(&self) -> WgslLanguageFeatures

Available on crate feature wgsl only.

Returns set of supported WGSL language extensions supported by this instance.

https://www.w3.org/TR/webgpu/#gpuwgsllanguagefeatures

Trait Implementations

impl Clone for Instance

fn clone(&self) -> Instance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Instance

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

Formats the value using the given formatter.

impl Default for Instance

fn default() -> Self

Creates a new instance of wgpu with default options.

Backends are set to Backends::all(), and FXC is chosen as the dx12_shader_compiler.

Panics

If no backend feature for the active target platform is enabled, this method will panic, see Instance::enabled_backend_features().

impl Hash for Instance

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Instance

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Instance

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Instance

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Instance