Enum Backend

#[repr(u8)]
pub enum Backend {
    Noop = 0,
    Vulkan = 1,
    Metal = 2,
    Dx12 = 3,
    Gl = 4,
    BrowserWebGpu = 5,
}

Backends supported by wgpu.

See also Backends.

Variants

Noop = 0

Dummy backend, which may be used for testing.

It performs no rendering or computation, but allows creation of stub GPU resource types, so that code which manages GPU resources can be tested without an available GPU. Specifically, the following operations are implemented:

• Enumerating adapters will always return one noop adapter, which can be used to create devices.
• Buffers may be created, written, mapped, and copied to other buffers.
• Command encoders may be created, but only buffer operations are useful.

Other resources can be created but are nonfunctional; notably,

• Render passes and compute passes are not executed.
• Textures may be created, but do not store any texels.
• There are no compatible surfaces.

An adapter using the noop backend can only be obtained if NoopBackendOptions enables it, in addition to the ordinary requirement of Backends::NOOP being set. This ensures that applications not desiring a non-functional backend will not receive it.

Vulkan = 1

Vulkan API (Windows, Linux, Android, MacOS via vulkan-portability/MoltenVK)

Metal = 2

Metal API (Apple platforms)

Dx12 = 3

Direct3D-12 (Windows)

Gl = 4

OpenGL 3.3+ (Windows), OpenGL ES 3.0+ (Linux, Android, MacOS via Angle), and WebGL2

BrowserWebGpu = 5

WebGPU in the browser

Implementations

impl Backend

pub const fn to_str(self) -> &'static str

Returns the string name of the backend.

Trait Implementations

impl Clone for Backend

fn clone(&self) -> Backend

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Backend

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Backend

fn deserialize<__D>( __deserializer: __D, ) -> Result<Backend, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Backend

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

Formats the value using the given formatter.

impl From<Backend> for Backends

fn from(backend: Backend) -> Backends

Converts to this type from the input type.

impl Hash for Backend

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

where __H: Hasher,

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 PartialEq for Backend

fn eq(&self, other: &Backend) -> 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 Serialize for Backend

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Backend

impl Eq for Backend

impl StructuralPartialEq for Backend