pub struct RayFlag(/* private fields */);
wgpu_core
or naga
only.Expand description
Ray flags, for a RayDesc
’s flags
field.
Note that these exactly correspond to the SPIR-V “Ray Flags” mask, and
the SPIR-V backend passes them directly through to the
OpRayQueryInitializeKHR
instruction. (We have to choose something, so
we might as well make one back end’s life easier.)
Implementations§
source§impl RayFlag
impl RayFlag
pub const OPAQUE: RayFlag = _
wgpu_core
only.pub const NO_OPAQUE: RayFlag = _
wgpu_core
only.pub const TERMINATE_ON_FIRST_HIT: RayFlag = _
wgpu_core
only.pub const SKIP_CLOSEST_HIT_SHADER: RayFlag = _
wgpu_core
only.pub const CULL_BACK_FACING: RayFlag = _
wgpu_core
only.pub const CULL_FRONT_FACING: RayFlag = _
wgpu_core
only.pub const CULL_OPAQUE: RayFlag = _
wgpu_core
only.pub const CULL_NO_OPAQUE: RayFlag = _
wgpu_core
only.pub const SKIP_TRIANGLES: RayFlag = _
wgpu_core
only.pub const SKIP_AABBS: RayFlag = _
wgpu_core
only.source§impl RayFlag
impl RayFlag
sourcepub const fn empty() -> RayFlag
Available on wgpu_core
only.
pub const fn empty() -> RayFlag
wgpu_core
only.Get a flags value with all bits unset.
sourcepub const fn all() -> RayFlag
Available on wgpu_core
only.
pub const fn all() -> RayFlag
wgpu_core
only.Get a flags value with all known bits set.
sourcepub const fn bits(&self) -> u32
Available on wgpu_core
only.
pub const fn bits(&self) -> u32
wgpu_core
only.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<RayFlag>
Available on wgpu_core
only.
pub const fn from_bits(bits: u32) -> Option<RayFlag>
wgpu_core
only.Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: u32) -> RayFlag
Available on wgpu_core
only.
pub const fn from_bits_truncate(bits: u32) -> RayFlag
wgpu_core
only.Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u32) -> RayFlag
Available on wgpu_core
only.
pub const fn from_bits_retain(bits: u32) -> RayFlag
wgpu_core
only.Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<RayFlag>
Available on wgpu_core
only.
pub fn from_name(name: &str) -> Option<RayFlag>
wgpu_core
only.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 is_empty(&self) -> bool
Available on wgpu_core
only.
pub const fn is_empty(&self) -> bool
wgpu_core
only.Whether all bits in this flags value are unset.
sourcepub const fn is_all(&self) -> bool
Available on wgpu_core
only.
pub const fn is_all(&self) -> bool
wgpu_core
only.Whether all known bits in this flags value are set.
sourcepub const fn intersects(&self, other: RayFlag) -> bool
Available on wgpu_core
only.
pub const fn intersects(&self, other: RayFlag) -> bool
wgpu_core
only.Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: RayFlag) -> bool
Available on wgpu_core
only.
pub const fn contains(&self, other: RayFlag) -> bool
wgpu_core
only.Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn insert(&mut self, other: RayFlag)
Available on wgpu_core
only.
pub fn insert(&mut self, other: RayFlag)
wgpu_core
only.The bitwise or (|
) of the bits in two flags values.
sourcepub fn remove(&mut self, other: RayFlag)
Available on wgpu_core
only.
pub fn remove(&mut self, other: RayFlag)
wgpu_core
only.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: RayFlag)
Available on wgpu_core
only.
pub fn toggle(&mut self, other: RayFlag)
wgpu_core
only.The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: RayFlag, value: bool)
Available on wgpu_core
only.
pub fn set(&mut self, other: RayFlag, value: bool)
wgpu_core
only.Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: RayFlag) -> RayFlag
Available on wgpu_core
only.
pub const fn intersection(self, other: RayFlag) -> RayFlag
wgpu_core
only.The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: RayFlag) -> RayFlag
Available on wgpu_core
only.
pub const fn union(self, other: RayFlag) -> RayFlag
wgpu_core
only.The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: RayFlag) -> RayFlag
Available on wgpu_core
only.
pub const fn difference(self, other: RayFlag) -> RayFlag
wgpu_core
only.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: RayFlag) -> RayFlag
Available on wgpu_core
only.
pub const fn symmetric_difference(self, other: RayFlag) -> RayFlag
wgpu_core
only.The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> RayFlag
Available on wgpu_core
only.
pub const fn complement(self) -> RayFlag
wgpu_core
only.The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl RayFlag
impl RayFlag
sourcepub const fn iter(&self) -> Iter<RayFlag>
Available on wgpu_core
only.
pub const fn iter(&self) -> Iter<RayFlag>
wgpu_core
only.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<RayFlag>
Available on wgpu_core
only.
pub const fn iter_names(&self) -> IterNames<RayFlag>
wgpu_core
only.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.
Trait Implementations§
source§impl BitAndAssign for RayFlag
impl BitAndAssign for RayFlag
source§fn bitand_assign(&mut self, other: RayFlag)
fn bitand_assign(&mut self, other: RayFlag)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOrAssign for RayFlag
impl BitOrAssign for RayFlag
source§fn bitor_assign(&mut self, other: RayFlag)
fn bitor_assign(&mut self, other: RayFlag)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXorAssign for RayFlag
impl BitXorAssign for RayFlag
source§fn bitxor_assign(&mut self, other: RayFlag)
fn bitxor_assign(&mut self, other: RayFlag)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Extend<RayFlag> for RayFlag
impl Extend<RayFlag> for RayFlag
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = RayFlag>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = RayFlag>,
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 RayFlag
impl Flags for RayFlag
source§fn from_bits_retain(bits: u32) -> RayFlag
fn from_bits_retain(bits: u32) -> RayFlag
§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
§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.§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read more§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.§fn set(&mut self, other: Self, value: bool)where
Self: Sized,
fn set(&mut self, other: Self, value: bool)where
Self: Sized,
Flags::insert
] when value
is true
or [Flags::remove
] when value
is false
.§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read more§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl FromIterator<RayFlag> for RayFlag
impl FromIterator<RayFlag> for RayFlag
source§impl IntoIterator for RayFlag
impl IntoIterator for RayFlag
source§impl PartialEq for RayFlag
impl PartialEq for RayFlag
source§impl Sub for RayFlag
impl Sub for RayFlag
source§impl SubAssign for RayFlag
impl SubAssign for RayFlag
source§fn sub_assign(&mut self, other: RayFlag)
fn sub_assign(&mut self, other: RayFlag)
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 Copy for RayFlag
impl Eq for RayFlag
impl StructuralEq for RayFlag
impl StructuralPartialEq for RayFlag
Auto Trait Implementations§
impl RefUnwindSafe for RayFlag
impl Send for RayFlag
impl Sync for RayFlag
impl Unpin for RayFlag
impl UnwindSafe for RayFlag
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.