Struct wgpu_types::AccelerationStructureFlags
source · pub struct AccelerationStructureFlags(/* private fields */);
Expand description
Flags for acceleration structures
Implementations§
source§impl AccelerationStructureFlags
impl AccelerationStructureFlags
sourcepub const ALLOW_UPDATE: Self = _
pub const ALLOW_UPDATE: Self = _
Allow for incremental updates (no change in size)
sourcepub const ALLOW_COMPACTION: Self = _
pub const ALLOW_COMPACTION: Self = _
Allow the acceleration structure to be compacted in a copy operation
sourcepub const PREFER_FAST_TRACE: Self = _
pub const PREFER_FAST_TRACE: Self = _
Optimize for fast ray tracing performance
sourcepub const PREFER_FAST_BUILD: Self = _
pub const PREFER_FAST_BUILD: Self = _
Optimize for fast build time
sourcepub const LOW_MEMORY: Self = _
pub const LOW_MEMORY: Self = _
Optimize for low memory footprint (scratch and output)
source§impl AccelerationStructureFlags
impl AccelerationStructureFlags
sourcepub const fn bits(&self) -> u8
pub const fn bits(&self) -> u8
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u8) -> Option<Self>
pub const fn from_bits(bits: u8) -> 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: u8) -> Self
pub const fn from_bits_truncate(bits: u8) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u8) -> Self
pub const fn from_bits_retain(bits: u8) -> 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 AccelerationStructureFlags
impl AccelerationStructureFlags
sourcepub const fn iter(&self) -> Iter<AccelerationStructureFlags>
pub const fn iter(&self) -> Iter<AccelerationStructureFlags>
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<AccelerationStructureFlags>
pub const fn iter_names(&self) -> IterNames<AccelerationStructureFlags>
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 AccelerationStructureFlags
impl AccelerationStructureFlags
sourcepub fn contains_invalid_bits(&self) -> bool
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 AccelerationStructureFlags
impl Binary for AccelerationStructureFlags
source§impl BitAnd for AccelerationStructureFlags
impl BitAnd for AccelerationStructureFlags
source§impl BitAndAssign for AccelerationStructureFlags
impl BitAndAssign for AccelerationStructureFlags
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 AccelerationStructureFlags
impl BitOr for AccelerationStructureFlags
source§fn bitor(self, other: AccelerationStructureFlags) -> Self
fn bitor(self, other: AccelerationStructureFlags) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = AccelerationStructureFlags
type Output = AccelerationStructureFlags
|
operator.source§impl BitOrAssign for AccelerationStructureFlags
impl BitOrAssign for AccelerationStructureFlags
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 AccelerationStructureFlags
impl BitXor for AccelerationStructureFlags
source§impl BitXorAssign for AccelerationStructureFlags
impl BitXorAssign for AccelerationStructureFlags
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 AccelerationStructureFlags
impl Clone for AccelerationStructureFlags
source§fn clone(&self) -> AccelerationStructureFlags
fn clone(&self) -> AccelerationStructureFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for AccelerationStructureFlags
impl Debug for AccelerationStructureFlags
source§impl Extend<AccelerationStructureFlags> for AccelerationStructureFlags
impl Extend<AccelerationStructureFlags> for AccelerationStructureFlags
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 AccelerationStructureFlags
impl Flags for AccelerationStructureFlags
source§const FLAGS: &'static [Flag<AccelerationStructureFlags>] = _
const FLAGS: &'static [Flag<AccelerationStructureFlags>] = _
source§fn from_bits_retain(bits: u8) -> AccelerationStructureFlags
fn from_bits_retain(bits: u8) -> AccelerationStructureFlags
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<AccelerationStructureFlags> for AccelerationStructureFlags
impl FromIterator<AccelerationStructureFlags> for AccelerationStructureFlags
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 AccelerationStructureFlags
impl Hash for AccelerationStructureFlags
source§impl Not for AccelerationStructureFlags
impl Not for AccelerationStructureFlags
source§impl Octal for AccelerationStructureFlags
impl Octal for AccelerationStructureFlags
source§impl PartialEq for AccelerationStructureFlags
impl PartialEq for AccelerationStructureFlags
source§fn eq(&self, other: &AccelerationStructureFlags) -> bool
fn eq(&self, other: &AccelerationStructureFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PublicFlags for AccelerationStructureFlags
impl PublicFlags for AccelerationStructureFlags
source§impl Sub for AccelerationStructureFlags
impl Sub for AccelerationStructureFlags
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 = AccelerationStructureFlags
type Output = AccelerationStructureFlags
-
operator.source§impl SubAssign for AccelerationStructureFlags
impl SubAssign for AccelerationStructureFlags
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.