Struct wgpu::InstanceFlags

pub struct InstanceFlags(/* private fields */);

Instance debugging flags.

These are not part of the webgpu standard.

Defaults to enabling debugging-related flags if the build configuration has debug_assertions.

Implementations

impl InstanceFlags

pub const DEBUG: InstanceFlags = _

Generate debug information in shaders and objects.

pub const VALIDATION: InstanceFlags = _

Enable validation, if possible.

pub const DISCARD_HAL_LABELS: InstanceFlags = _

Don’t pass labels to wgpu-hal.

pub const ALLOW_UNDERLYING_NONCOMPLIANT_ADAPTER: InstanceFlags = _

Whether wgpu should expose adapters that run on top of non-compliant adapters.

Turning this on might mean that some of the functionality provided by the wgpu adapter/device is not working or is broken. It could be that all the functionality wgpu currently exposes works but we can’t tell for sure since we have no additional transparency into what is working and what is not on the underlying adapter.

This mainly applies to a Vulkan driver’s compliance version. If the major compliance version is 0, then the driver is ignored. This flag allows that driver to be enabled for testing.

pub const GPU_BASED_VALIDATION: InstanceFlags = _

Enable GPU-based validation. Implies Self::VALIDATION. Currently, this only changes behavior on the DX12 and Vulkan backends.

Supported platforms:

• D3D12; called “GPU-based validation”, or “GBV”
• Vulkan, via the VK_LAYER_KHRONOS_validation layer; called “GPU-Assisted Validation”

impl InstanceFlags

pub const fn empty() -> InstanceFlags

Get a flags value with all bits unset.

pub const fn all() -> InstanceFlags

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

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

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

Convert from a bits value.

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

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

Convert from a bits value, unsetting any unknown bits.

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

Convert from a bits value exactly.

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

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.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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.

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

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

pub const fn complement(self) -> InstanceFlags

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

impl InstanceFlags

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

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.

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

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.

impl InstanceFlags

pub fn debugging() -> InstanceFlags

Enable recommended debugging and validation flags.

pub fn advanced_debugging() -> InstanceFlags

Enable advanced debugging and validation flags (potentially very slow).

pub fn from_build_config() -> InstanceFlags

Infer good defaults from the build type

Returns the default flags and add debugging flags if the build configuration has debug_assertions.

pub fn with_env(self) -> InstanceFlags

Returns this set of flags, affected by environment variables.

The presence of an environment variable implies that the corresponding flag should be set unless the value is “0” in which case the flag is unset. If the environment variable is not present, then the flag is unaffected.

For example let flags = InstanceFlags::debugging().with_env(); with WGPU_VALIDATION=0 does not contain InstanceFlags::VALIDATION.

The environment variables are named after the flags prefixed with “WGPU_”. For example:

• WGPU_DEBUG
• WGPU_VALIDATION

Trait Implementations

impl Binary for InstanceFlags

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

Formats the value using the given formatter.

impl BitAnd for InstanceFlags

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

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

type Output = InstanceFlags

The resulting type after applying the & operator.

impl BitAndAssign for InstanceFlags

fn bitand_assign(&mut self, other: InstanceFlags)

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

impl BitOr for InstanceFlags

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

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

type Output = InstanceFlags

The resulting type after applying the | operator.

impl BitOrAssign for InstanceFlags

fn bitor_assign(&mut self, other: InstanceFlags)

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

impl BitXor for InstanceFlags

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

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

type Output = InstanceFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for InstanceFlags

fn bitxor_assign(&mut self, other: InstanceFlags)

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

impl Clone for InstanceFlags

fn clone(&self) -> InstanceFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InstanceFlags

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

Formats the value using the given formatter.

impl Default for InstanceFlags

fn default() -> InstanceFlags

Returns the “default value” for a type.

impl Extend<InstanceFlags> for InstanceFlags

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = InstanceFlags>,

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

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

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.

impl Flags for InstanceFlags

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

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> InstanceFlags

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.

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.

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

Yield a set of contained flags values.

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

Yield a set of contained named flags values.

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 (&!).

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 (&!).

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.

impl FromIterator<InstanceFlags> for InstanceFlags

fn from_iter<T>(iterator: T) -> InstanceFlags

where T: IntoIterator<Item = InstanceFlags>,

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

impl Hash for InstanceFlags

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 IntoIterator for InstanceFlags

type Item = InstanceFlags

The type of the elements being iterated over.

type IntoIter = Iter<InstanceFlags>

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl LowerHex for InstanceFlags

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

Formats the value using the given formatter.

impl Not for InstanceFlags

fn not(self) -> InstanceFlags

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

type Output = InstanceFlags

The resulting type after applying the ! operator.

impl Octal for InstanceFlags

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

Formats the value using the given formatter.

impl PartialEq for InstanceFlags

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

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

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.

impl Sub for InstanceFlags

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

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 = InstanceFlags

The resulting type after applying the - operator.

impl SubAssign for InstanceFlags

fn sub_assign(&mut self, other: InstanceFlags)

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.

impl UpperHex for InstanceFlags

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

Formats the value using the given formatter.

impl Copy for InstanceFlags

impl Eq for InstanceFlags

impl StructuralEq for InstanceFlags

impl StructuralPartialEq for InstanceFlags