pub struct Semantics { /* private fields */ }
Expand description
Memory semantics to determine how some operations should function - used when calling such configurable operations.
Implementations§
source§impl Semantics
impl Semantics
sourcepub const ACQUIRE: Self = _
pub const ACQUIRE: Self = _
On an atomic instruction, orders memory operations provided in program order after this atomic instruction against this atomic instruction. On a barrier, orders memory operations provided in program order after this barrier against atomic instructions before this barrier.
sourcepub const RELEASE: Self = _
pub const RELEASE: Self = _
On an atomic instruction, orders memory operations provided in program order before this atomic instruction against this atomic instruction. On a barrier, orders memory operations provided in program order before this barrier against atomic instructions after this barrier.
sourcepub const ACQUIRE_RELEASE: Self = _
pub const ACQUIRE_RELEASE: Self = _
Has the properties of both Self::ACQUIRE
and Self::RELEASE
semantics. It
is used for read-modify-write operations.
sourcepub const SEQUENTIALLY_CONST: Self = _
pub const SEQUENTIALLY_CONST: Self = _
All observers see this memory access in the same order with respect to
other sequentially-consistent memory accesses from this invocation.
If the declared memory model is vulkan
, SEQUENTIALLY_CONST
must
not be used.
sourcepub const UNIFORM_MEMORY: Self = _
pub const UNIFORM_MEMORY: Self = _
Apply the memory-ordering constraints to
[crate::storage_class::StorageBuffer
],
[crate::storage_class::PhysicalStorageBuffer
], or
[crate::storage_class::Uniform
] Storage Class memory.
sourcepub const SUBGROUP_MEMORY: Self = _
pub const SUBGROUP_MEMORY: Self = _
Apply the memory-ordering constraints to subgroup memory.
sourcepub const WORKGROUP_MEMORY: Self = _
pub const WORKGROUP_MEMORY: Self = _
Apply the memory-ordering constraints to
[crate::storage_class::Workgroup
] Storage Class memory.
sourcepub const CROSS_WORKGROUP_MEMORY: Self = _
pub const CROSS_WORKGROUP_MEMORY: Self = _
Apply the memory-ordering constraints to
[crate::storage_class::CrossWorkgroup
] Storage Class memory.
sourcepub const ATOMIC_COUNTER_MEMORY: Self = _
pub const ATOMIC_COUNTER_MEMORY: Self = _
Apply the memory-ordering constraints to
[crate::storage_class::AtomicCounter
] Storage Class memory.
sourcepub const IMAGE_MEMORY: Self = _
pub const IMAGE_MEMORY: Self = _
Apply the memory-ordering constraints to image contents (types declared
by OpTypeImage
), or to accesses done through pointers to the
[crate::storage_class::Image
] Storage Class.
sourcepub const OUTPUT_MEMORY: Self = _
pub const OUTPUT_MEMORY: Self = _
Apply the memory-ordering constraints to the
[crate::storage_class::Output
] Storage Class memory.
sourcepub const MAKE_AVAILABLE: Self = _
pub const MAKE_AVAILABLE: Self = _
Perform an availability operation on all references in the selected storage classes.
sourcepub const MAKE_VISIBLE: Self = _
pub const MAKE_VISIBLE: Self = _
Perform a visibility operation on all references in the selected storage classes.
sourcepub const VOLATILE: Self = _
pub const VOLATILE: Self = _
This access cannot be eliminated, duplicated, or combined with other accesses.
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 Semantics
impl BitAndAssign for Semantics
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 Semantics
impl BitOrAssign for Semantics
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXorAssign for Semantics
impl BitXorAssign for Semantics
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Extend<Semantics> for Semantics
impl Extend<Semantics> for Semantics
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<Semantics> for Semantics
impl FromIterator<Semantics> for Semantics
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 Semantics
impl Ord for Semantics
source§impl PartialEq for Semantics
impl PartialEq for Semantics
source§impl PartialOrd for Semantics
impl PartialOrd for Semantics
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 Semantics
impl SubAssign for Semantics
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 Semantics
impl Eq for Semantics
impl Pod for Semantics
impl StructuralPartialEq for Semantics
Auto Trait Implementations§
impl Freeze for Semantics
impl RefUnwindSafe for Semantics
impl Send for Semantics
impl Sync for Semantics
impl Unpin for Semantics
impl UnwindSafe for Semantics
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
.