pub struct Access { /* private fields */ }
Expand description
Bitflags to describe how memory in an image or buffer can be accessed.
Implementations
sourceimpl Access
impl Access
sourcepub const INPUT_ATTACHMENT_READ: Self
pub const INPUT_ATTACHMENT_READ: Self
Read access to an input attachment from within a fragment shader.
sourcepub const SHADER_READ: Self
pub const SHADER_READ: Self
Read-only state for SRV access, or combine with SHADER_WRITE
to have r/w access to UAV.
sourcepub const SHADER_WRITE: Self
pub const SHADER_WRITE: Self
Writeable state for UAV access.
Combine with SHADER_READ
to have r/w access to UAV.
sourcepub const COLOR_ATTACHMENT_READ: Self
pub const COLOR_ATTACHMENT_READ: Self
Read state but can only be combined with COLOR_ATTACHMENT_WRITE
.
sourcepub const COLOR_ATTACHMENT_WRITE: Self
pub const COLOR_ATTACHMENT_WRITE: Self
Write-only state but can be combined with COLOR_ATTACHMENT_READ
.
sourcepub const DEPTH_STENCIL_ATTACHMENT_READ: Self
pub const DEPTH_STENCIL_ATTACHMENT_READ: Self
Read access to a depth/stencil attachment in a depth or stencil operation.
sourcepub const DEPTH_STENCIL_ATTACHMENT_WRITE: Self
pub const DEPTH_STENCIL_ATTACHMENT_WRITE: Self
Write access to a depth/stencil attachment in a depth or stencil operation.
sourcepub const TRANSFER_READ: Self
pub const TRANSFER_READ: Self
Read access to the buffer in a copy operation.
sourcepub const TRANSFER_WRITE: Self
pub const TRANSFER_WRITE: Self
Write access to the buffer in a copy operation.
sourcepub const HOST_READ: Self
pub const HOST_READ: Self
Read access for raw memory to be accessed by the host system (ie, CPU).
sourcepub const HOST_WRITE: Self
pub const HOST_WRITE: Self
Write access for raw memory to be accessed by the host system.
sourcepub const MEMORY_READ: Self
pub const MEMORY_READ: Self
Read access for memory to be accessed by a non-specific entity. This may be the host system, or it may be something undefined or specified by an extension.
sourcepub const MEMORY_WRITE: Self
pub const MEMORY_WRITE: Self
Write access for memory to be accessed by a non-specific entity.
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
sourceimpl BitAndAssign<Access> for Access
impl BitAndAssign<Access> for Access
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOrAssign<Access> for Access
impl BitOrAssign<Access> for Access
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXorAssign<Access> for Access
impl BitXorAssign<Access> for Access
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Extend<Access> for Access
impl Extend<Access> for Access
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<Access> for Access
impl FromIterator<Access> for Access
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl Ord for Access
impl Ord for Access
sourceimpl PartialOrd<Access> for Access
impl PartialOrd<Access> for Access
sourcefn partial_cmp(&self, other: &Access) -> Option<Ordering>
fn partial_cmp(&self, other: &Access) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl SubAssign<Access> for Access
impl SubAssign<Access> for Access
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
impl Copy for Access
impl Eq for Access
impl StructuralEq for Access
impl StructuralPartialEq for Access
Auto Trait Implementations
impl RefUnwindSafe for Access
impl Send for Access
impl Sync for Access
impl Unpin for Access
impl UnwindSafe for Access
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more