Struct spirv_std::ray_tracing::RayFlags
source · pub struct RayFlags { /* private fields */ }
Expand description
Flags controlling the properties of an OpTraceRayKHR instruction.
Despite being a mask and allowing multiple bits to be combined, it is
invalid for more than one of these four bits to be set: OPAQUE
,
NO_OPAQUE
, CULL_OPAQUE
, CULL_NO_OPAQUE
, only one of
CULL_BACK_FACING_TRIANGLES
and CULL_FRONT_FACING_TRIANGLES
may
be set.
Implementations§
source§impl RayFlags
impl RayFlags
sourcepub const TERMINATE_ON_FIRST_HIT: Self = _
pub const TERMINATE_ON_FIRST_HIT: Self = _
Accept the first hit discovered.
sourcepub const SKIP_CLOSEST_HIT_SHADER: Self = _
pub const SKIP_CLOSEST_HIT_SHADER: Self = _
Do not execute a closest hit shader.
sourcepub const CULL_BACK_FACING_TRIANGLES: Self = _
pub const CULL_BACK_FACING_TRIANGLES: Self = _
Do not intersect with the back face of triangles.
sourcepub const CULL_FRONT_FACING_TRIANGLES: Self = _
pub const CULL_FRONT_FACING_TRIANGLES: Self = _
Do not intersect with the front face of triangles.
sourcepub const CULL_OPAQUE: Self = _
pub const CULL_OPAQUE: Self = _
Do not intersect with opaque geometry.
sourcepub const CULL_NO_OPAQUE: Self = _
pub const CULL_NO_OPAQUE: Self = _
Do not intersect with non-opaque geometry.
sourcepub const SKIP_TRIANGLES: Self = _
pub const SKIP_TRIANGLES: Self = _
Do not intersect with any triangle geometries.
sourcepub const SKIP_AABBS: Self = _
pub const SKIP_AABBS: Self = _
Do not intersect with any AABB (Axis Aligned Bounding Box) geometries.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
pub const unsafe fn from_bits_unchecked(bits: u32) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
§Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
Trait Implementations§
source§impl BitAndAssign for RayFlags
impl BitAndAssign for RayFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOrAssign for RayFlags
impl BitOrAssign for RayFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXorAssign for RayFlags
impl BitXorAssign for RayFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Extend<RayFlags> for RayFlags
impl Extend<RayFlags> for RayFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
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 FromIterator<RayFlags> for RayFlags
impl FromIterator<RayFlags> for RayFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Ord for RayFlags
impl Ord for RayFlags
source§impl PartialEq for RayFlags
impl PartialEq for RayFlags
source§impl PartialOrd for RayFlags
impl PartialOrd for RayFlags
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl SubAssign for RayFlags
impl SubAssign for RayFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
impl Copy for RayFlags
impl Eq for RayFlags
impl Pod for RayFlags
impl StructuralPartialEq for RayFlags
Auto Trait Implementations§
impl Freeze for RayFlags
impl RefUnwindSafe for RayFlags
impl Send for RayFlags
impl Sync for RayFlags
impl Unpin for RayFlags
impl UnwindSafe for RayFlags
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
source§impl<T> CheckedBitPattern for Twhere
T: AnyBitPattern,
impl<T> CheckedBitPattern for Twhere
T: AnyBitPattern,
§type Bits = T
type Bits = T
Self
must have the same layout as the specified Bits
except for
the possible invalid bit patterns being checked during
is_valid_bit_pattern
.source§fn is_valid_bit_pattern(_bits: &T) -> bool
fn is_valid_bit_pattern(_bits: &T) -> bool
bits
as &Self
.