pub struct Access { /* private fields */ }
Expand description
Specifies the access types for a resource.
Implementations§
source§impl Access
impl Access
sourcepub const INDIRECT_COMMAND_READ: Self = _
pub const INDIRECT_COMMAND_READ: Self = _
Specifies read access to command data read from indirect buffers as part of an indirect build, trace, drawing or dispatch command.
sourcepub const INDEX_READ: Self = _
pub const INDEX_READ: Self = _
Specifies read access to an index buffer as part of an indexed drawing command.
sourcepub const VERTEX_ATTRIBUTE_READ: Self = _
pub const VERTEX_ATTRIBUTE_READ: Self = _
Specifies read access to a vertex buffer as part of a drawing command.
sourcepub const UNIFORM_READ: Self = _
pub const UNIFORM_READ: Self = _
Specifies read access to a uniform buffer in any shader pipeline stage.
sourcepub const SHADER_SAMPLED_READ: Self = _
pub const SHADER_SAMPLED_READ: Self = _
Specifies read access to a uniform texel buffer or sampled image in any shader pipeline stage.
sourcepub const SHADER_STORAGE_READ: Self = _
pub const SHADER_STORAGE_READ: Self = _
Specifies read access to a storage buffer, physical storage buffer, storage texel buffer, or storage image in any shader pipeline stage.
sourcepub const SHADER_BINDING_TABLE_READ: Self = _
pub const SHADER_BINDING_TABLE_READ: Self = _
Specifies read access to a shader binding table in any shader pipeline stage.
sourcepub const INPUT_ATTACHMENT_READ: Self = _
pub const INPUT_ATTACHMENT_READ: Self = _
Specifies read access to an input attachment within a render pass during subpass shading or fragment shading.
sourcepub const COLOR_ATTACHMENT_READ: Self = _
pub const COLOR_ATTACHMENT_READ: Self = _
Specifies read access to a color attachment, such as via blending, logic operations, or via certain subpass load operations.
sourcepub const DEPTH_STENCIL_ATTACHMENT_READ: Self = _
pub const DEPTH_STENCIL_ATTACHMENT_READ: Self = _
Specifies read access to a depth/stencil attachment, via depth or stencil operations or via certain subpass load operations.
sourcepub const ACCELERATION_STRUCTURE_READ: Self = _
pub const ACCELERATION_STRUCTURE_READ: Self = _
Specifies read access to an acceleration structure as part of a trace, build, or copy command, or to an acceleration structure scratch buffer as part of a build command.
sourcepub const TRANSFER_READ: Self = _
pub const TRANSFER_READ: Self = _
Specifies read access to an image or buffer in a copy operation.
sourcepub const HOST_READ: Self = _
pub const HOST_READ: Self = _
Specifies read access by a host operation. Accesses of this type are not performed through a resource, but directly on memory.
sourcepub const SHADER_STORAGE_WRITE: Self = _
pub const SHADER_STORAGE_WRITE: Self = _
Specifies write access to a storage buffer, physical storage buffer, storage texel buffer, or storage image in any shader pipeline stage.
sourcepub const COLOR_ATTACHMENT_WRITE: Self = _
pub const COLOR_ATTACHMENT_WRITE: Self = _
Specifies write access to a color, resolve, or depth/stencil resolve attachment during a render pass or via certain subpass load and store operations.
sourcepub const DEPTH_STENCIL_ATTACHMENT_WRITE: Self = _
pub const DEPTH_STENCIL_ATTACHMENT_WRITE: Self = _
Specifies write access to a depth/stencil attachment, via depth or stencil operations or via certain subpass load and store operations.
sourcepub const ACCELERATION_STRUCTURE_WRITE: Self = _
pub const ACCELERATION_STRUCTURE_WRITE: Self = _
Specifies write access to an acceleration structure or acceleration structure scratch buffer as part of a build or copy command
sourcepub const TRANSFER_WRITE: Self = _
pub const TRANSFER_WRITE: Self = _
Specifies write access to an image or buffer in a clear or copy operation
sourcepub const HOST_WRITE: Self = _
pub const HOST_WRITE: Self = _
Specifies write access by a host operation. Accesses of this type are not performed through a resource, but directly on memory.
sourcepub const fn from_bits(bits: u64) -> Option<Self>
pub const fn from_bits(bits: u64) -> 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: u64) -> Self
pub const fn from_bits_truncate(bits: u64) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u64) -> Self
pub const unsafe fn from_bits_unchecked(bits: u64) -> 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<Access> for Access
impl BitAndAssign<Access> for Access
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<Access> for Access
impl BitOrAssign<Access> for Access
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXorAssign<Access> for Access
impl BitXorAssign<Access> for Access
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Extend<Access> for Access
impl Extend<Access> for Access
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<Access> for Access
impl FromIterator<Access> for Access
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 Access
impl Ord for Access
source§impl PartialEq<Access> for Access
impl PartialEq<Access> for Access
source§impl PartialOrd<Access> for Access
impl PartialOrd<Access> for Access
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<Access> for Access
impl SubAssign<Access> for Access
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.