Struct wgpu_types::InstanceFlags
source · pub struct InstanceFlags(/* private fields */);
Expand description
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§
source§impl InstanceFlags
impl InstanceFlags
sourcepub const VALIDATION: Self = _
pub const VALIDATION: Self = _
Enable validation, if possible.
sourcepub const DISCARD_HAL_LABELS: Self = _
pub const DISCARD_HAL_LABELS: Self = _
Don’t pass labels to wgpu-hal.
sourcepub const ALLOW_UNDERLYING_NONCOMPLIANT_ADAPTER: Self = _
pub const ALLOW_UNDERLYING_NONCOMPLIANT_ADAPTER: Self = _
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.
sourcepub const GPU_BASED_VALIDATION: Self = _
pub const GPU_BASED_VALIDATION: Self = _
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”
source§impl InstanceFlags
impl InstanceFlags
sourcepub const fn bits(&self) -> u32
pub const fn bits(&self) -> u32
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u32) -> Self
pub const fn from_bits_retain(bits: u32) -> Self
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
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.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
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.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
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.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl InstanceFlags
impl InstanceFlags
sourcepub const fn iter(&self) -> Iter<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.
sourcepub const fn iter_names(&self) -> IterNames<InstanceFlags>
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.
source§impl InstanceFlags
impl InstanceFlags
sourcepub fn advanced_debugging() -> Self
pub fn advanced_debugging() -> Self
Enable advanced debugging and validation flags (potentially very slow).
sourcepub fn from_build_config() -> Self
pub fn from_build_config() -> Self
Infer good defaults from the build type
Returns the default flags and add debugging flags if the build configuration has debug_assertions
.
sourcepub fn with_env(self) -> Self
pub fn with_env(self) -> Self
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§
source§impl Binary for InstanceFlags
impl Binary for InstanceFlags
source§impl BitAnd for InstanceFlags
impl BitAnd for InstanceFlags
source§impl BitAndAssign for InstanceFlags
impl BitAndAssign for InstanceFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for InstanceFlags
impl BitOr for InstanceFlags
source§fn bitor(self, other: InstanceFlags) -> Self
fn bitor(self, other: InstanceFlags) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = InstanceFlags
type Output = InstanceFlags
|
operator.source§impl BitOrAssign for InstanceFlags
impl BitOrAssign for InstanceFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for InstanceFlags
impl BitXor for InstanceFlags
source§impl BitXorAssign for InstanceFlags
impl BitXorAssign for InstanceFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Clone for InstanceFlags
impl Clone for InstanceFlags
source§fn clone(&self) -> InstanceFlags
fn clone(&self) -> InstanceFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for InstanceFlags
impl Debug for InstanceFlags
source§impl Default for InstanceFlags
impl Default for InstanceFlags
source§impl Extend<InstanceFlags> for InstanceFlags
impl Extend<InstanceFlags> for InstanceFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|
) of the bits in each flags value.
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl Flags for InstanceFlags
impl Flags for InstanceFlags
source§const FLAGS: &'static [Flag<InstanceFlags>] = _
const FLAGS: &'static [Flag<InstanceFlags>] = _
source§fn from_bits_retain(bits: u32) -> InstanceFlags
fn from_bits_retain(bits: u32) -> InstanceFlags
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moresource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moresource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl FromIterator<InstanceFlags> for InstanceFlags
impl FromIterator<InstanceFlags> for InstanceFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
source§impl Hash for InstanceFlags
impl Hash for InstanceFlags
source§impl IntoIterator for InstanceFlags
impl IntoIterator for InstanceFlags
source§impl LowerHex for InstanceFlags
impl LowerHex for InstanceFlags
source§impl Not for InstanceFlags
impl Not for InstanceFlags
source§impl Octal for InstanceFlags
impl Octal for InstanceFlags
source§impl PartialEq for InstanceFlags
impl PartialEq for InstanceFlags
source§fn eq(&self, other: &InstanceFlags) -> bool
fn eq(&self, other: &InstanceFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PublicFlags for InstanceFlags
impl PublicFlags for InstanceFlags
source§impl Sub for InstanceFlags
impl Sub for InstanceFlags
source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
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
type Output = InstanceFlags
-
operator.source§impl SubAssign for InstanceFlags
impl SubAssign for InstanceFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
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.