Struct gfx_hal::memory::SparseFlags
source · [−]pub struct SparseFlags { /* private fields */ }
Expand description
Sparse flags for creating images and buffers.
Implementations
sourceimpl SparseFlags
impl SparseFlags
sourcepub const SPARSE_BINDING: Self
pub const SPARSE_BINDING: Self
Specifies the view will be backed using sparse memory binding.
sourcepub const SPARSE_RESIDENCY: Self
pub const SPARSE_RESIDENCY: Self
Specifies the view can be partially backed with sparse memory binding.
Must have SPARSE_BINDING
enabled.
sourcepub const SPARSE_ALIASED: Self
pub const SPARSE_ALIASED: Self
Specifies the view will be backed using sparse memory binding with memory bindings that
might alias other data. Must have SPARSE_BINDING
enabled.
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 Binary for SparseFlags
impl Binary for SparseFlags
sourceimpl BitAnd<SparseFlags> for SparseFlags
impl BitAnd<SparseFlags> for SparseFlags
sourceimpl BitAndAssign<SparseFlags> for SparseFlags
impl BitAndAssign<SparseFlags> for SparseFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<SparseFlags> for SparseFlags
impl BitOr<SparseFlags> for SparseFlags
sourcefn bitor(self, other: SparseFlags) -> Self
fn bitor(self, other: SparseFlags) -> Self
Returns the union of the two sets of flags.
type Output = Self
type Output = Self
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<SparseFlags> for SparseFlags
impl BitOrAssign<SparseFlags> for SparseFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<SparseFlags> for SparseFlags
impl BitXor<SparseFlags> for SparseFlags
sourceimpl BitXorAssign<SparseFlags> for SparseFlags
impl BitXorAssign<SparseFlags> for SparseFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for SparseFlags
impl Clone for SparseFlags
sourcefn clone(&self) -> SparseFlags
fn clone(&self) -> SparseFlags
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for SparseFlags
impl Debug for SparseFlags
sourceimpl Extend<SparseFlags> for SparseFlags
impl Extend<SparseFlags> for SparseFlags
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<SparseFlags> for SparseFlags
impl FromIterator<SparseFlags> for SparseFlags
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 Hash for SparseFlags
impl Hash for SparseFlags
sourceimpl LowerHex for SparseFlags
impl LowerHex for SparseFlags
sourceimpl Not for SparseFlags
impl Not for SparseFlags
sourceimpl Octal for SparseFlags
impl Octal for SparseFlags
sourceimpl Ord for SparseFlags
impl Ord for SparseFlags
sourceimpl PartialEq<SparseFlags> for SparseFlags
impl PartialEq<SparseFlags> for SparseFlags
sourcefn eq(&self, other: &SparseFlags) -> bool
fn eq(&self, other: &SparseFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &SparseFlags) -> bool
fn ne(&self, other: &SparseFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<SparseFlags> for SparseFlags
impl PartialOrd<SparseFlags> for SparseFlags
sourcefn partial_cmp(&self, other: &SparseFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &SparseFlags) -> 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 Sub<SparseFlags> for SparseFlags
impl Sub<SparseFlags> for SparseFlags
sourceimpl SubAssign<SparseFlags> for SparseFlags
impl SubAssign<SparseFlags> for SparseFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for SparseFlags
impl UpperHex for SparseFlags
impl Copy for SparseFlags
impl Eq for SparseFlags
impl StructuralEq for SparseFlags
impl StructuralPartialEq for SparseFlags
Auto Trait Implementations
impl RefUnwindSafe for SparseFlags
impl Send for SparseFlags
impl Sync for SparseFlags
impl Unpin for SparseFlags
impl UnwindSafe for SparseFlags
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