Struct wgpu::Backends

source ·
pub struct Backends(/* private fields */);
Expand description

Represents the backends that wgpu will use.

Implementations§

source§

impl Backends

source

pub const VULKAN: Backends = _

Supported on Windows, Linux/Android, and macOS/iOS via Vulkan Portability (with the Vulkan feature enabled)

source

pub const GL: Backends = _

Supported on Linux/Android, the web through webassembly via WebGL, and Windows and macOS/iOS via ANGLE

source

pub const METAL: Backends = _

Supported on macOS/iOS

source

pub const DX12: Backends = _

Supported on Windows 10

source

pub const BROWSER_WEBGPU: Backends = _

Supported when targeting the web through webassembly with the webgpu feature enabled.

The WebGPU backend is special in several ways: It is not not implemented by wgpu_core and instead by the higher level wgpu crate. Whether WebGPU is targeted is decided upon the creation of the wgpu::Instance, not upon adapter creation. See wgpu::Instance::new.

source

pub const PRIMARY: Backends = _

All the apis that wgpu offers first tier of support for.

Vulkan + Metal + DX12 + Browser WebGPU

source

pub const SECONDARY: Backends = _

All the apis that wgpu offers second tier of support for. These may be unsupported/still experimental.

OpenGL

source§

impl Backends

source

pub const fn empty() -> Backends

Get a flags value with all bits unset.

source

pub const fn all() -> Backends

Get a flags value with all known bits set.

source

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

source

pub const fn from_bits(bits: u32) -> Option<Backends>

Convert from a bits value.

This method will return None if any unknown bits are set.

source

pub const fn from_bits_truncate(bits: u32) -> Backends

Convert from a bits value, unsetting any unknown bits.

source

pub const fn from_bits_retain(bits: u32) -> Backends

Convert from a bits value exactly.

source

pub fn from_name(name: &str) -> Option<Backends>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

source

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

source

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

source

pub const fn intersects(&self, other: Backends) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

source

pub const fn contains(&self, other: Backends) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

source

pub fn insert(&mut self, other: Backends)

The bitwise or (|) of the bits in two flags values.

source

pub fn remove(&mut self, other: Backends)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

source

pub fn toggle(&mut self, other: Backends)

The bitwise exclusive-or (^) of the bits in two flags values.

source

pub fn set(&mut self, other: Backends, value: bool)

Call insert when value is true or remove when value is false.

source

pub const fn intersection(self, other: Backends) -> Backends

The bitwise and (&) of the bits in two flags values.

source

pub const fn union(self, other: Backends) -> Backends

The bitwise or (|) of the bits in two flags values.

source

pub const fn difference(self, other: Backends) -> Backends

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

source

pub const fn symmetric_difference(self, other: Backends) -> Backends

The bitwise exclusive-or (^) of the bits in two flags values.

source

pub const fn complement(self) -> Backends

The bitwise negation (!) of the bits in a flags value, truncating the result.

source§

impl Backends

source

pub const fn iter(&self) -> Iter<Backends>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

source

pub const fn iter_names(&self) -> IterNames<Backends>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

source§

impl Backends

source

pub fn contains_invalid_bits(&self) -> bool

Returns true if the bitflags contains bits that are not part of the bitflags definition.

Trait Implementations§

source§

impl Binary for Backends

source§

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

Formats the value using the given formatter.
source§

impl BitAnd for Backends

source§

fn bitand(self, other: Backends) -> Backends

The bitwise and (&) of the bits in two flags values.

§

type Output = Backends

The resulting type after applying the & operator.
source§

impl BitAndAssign for Backends

source§

fn bitand_assign(&mut self, other: Backends)

The bitwise and (&) of the bits in two flags values.

source§

impl BitOr for Backends

source§

fn bitor(self, other: Backends) -> Backends

The bitwise or (|) of the bits in two flags values.

§

type Output = Backends

The resulting type after applying the | operator.
source§

impl BitOrAssign for Backends

source§

fn bitor_assign(&mut self, other: Backends)

The bitwise or (|) of the bits in two flags values.

source§

impl BitXor for Backends

source§

fn bitxor(self, other: Backends) -> Backends

The bitwise exclusive-or (^) of the bits in two flags values.

§

type Output = Backends

The resulting type after applying the ^ operator.
source§

impl BitXorAssign for Backends

source§

fn bitxor_assign(&mut self, other: Backends)

The bitwise exclusive-or (^) of the bits in two flags values.

source§

impl Clone for Backends

source§

fn clone(&self) -> Backends

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Backends

source§

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

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

impl Default for Backends

source§

fn default() -> Backends

Returns the “default value” for a type. Read more
source§

impl<'de> Deserialize<'de> for Backends

Available on crate feature serde only.
source§

fn deserialize<D>( deserializer: D ) -> Result<Backends, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Extend<Backends> for Backends

source§

fn extend<T>(&mut self, iterator: T)
where T: IntoIterator<Item = Backends>,

The bitwise or (|) of the bits in each flags value.

source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl Flags for Backends

source§

const FLAGS: &'static [Flag<Backends>] = _

The set of defined flags.
§

type Bits = u32

The underlying bits type.
source§

fn bits(&self) -> u32

Get the underlying bits value. Read more
source§

fn from_bits_retain(bits: u32) -> Backends

Convert from a bits value exactly.
§

fn empty() -> Self

Get a flags value with all bits unset.
§

fn all() -> Self

Get a flags value with all known bits set.
§

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value. Read more
§

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.
§

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set. Read more
§

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values. Read more
§

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values. Read more
§

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.
§

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.
§

fn intersects(&self, other: Self) -> bool
where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.
§

fn contains(&self, other: Self) -> bool
where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.
§

fn insert(&mut self, other: Self)
where Self: Sized,

The bitwise or (|) of the bits in two flags values.
§

fn remove(&mut self, other: Self)
where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!). Read more
§

fn toggle(&mut self, other: Self)
where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.
§

fn set(&mut self, other: Self, value: bool)
where Self: Sized,

Call [Flags::insert] when value is true or [Flags::remove] when value is false.
§

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

The bitwise and (&) of the bits in two flags values.
§

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

The bitwise or (|) of the bits in two flags values.
§

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

The intersection of a source flags value with the complement of a target flags value (&!). Read more
§

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

The bitwise exclusive-or (^) of the bits in two flags values.
§

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.
source§

impl From<Backend> for Backends

source§

fn from(backend: Backend) -> Backends

Converts to this type from the input type.
source§

impl FromIterator<Backends> for Backends

source§

fn from_iter<T>(iterator: T) -> Backends
where T: IntoIterator<Item = Backends>,

The bitwise or (|) of the bits in each flags value.

source§

impl Hash for Backends

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl IntoIterator for Backends

§

type Item = Backends

The type of the elements being iterated over.
§

type IntoIter = Iter<Backends>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> <Backends as IntoIterator>::IntoIter

Creates an iterator from a value. Read more
source§

impl LowerHex for Backends

source§

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

Formats the value using the given formatter.
source§

impl Not for Backends

source§

fn not(self) -> Backends

The bitwise negation (!) of the bits in a flags value, truncating the result.

§

type Output = Backends

The resulting type after applying the ! operator.
source§

impl Octal for Backends

source§

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

Formats the value using the given formatter.
source§

impl PartialEq for Backends

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for Backends

Available on crate feature serde only.
source§

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. Read more
source§

impl Sub for Backends

source§

fn sub(self, other: Backends) -> Backends

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

§

type Output = Backends

The resulting type after applying the - operator.
source§

impl SubAssign for Backends

source§

fn sub_assign(&mut self, other: Backends)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

source§

impl UpperHex for Backends

source§

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

Formats the value using the given formatter.
source§

impl Copy for Backends

source§

impl Eq for Backends

source§

impl StructuralEq for Backends

source§

impl StructuralPartialEq for Backends

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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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,

§

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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

source§

impl<T> WasmNotSend for T
where T: Send,

source§

impl<T> WasmNotSendSync for T

source§

impl<T> WasmNotSync for T
where T: Sync,