Struct gpu_alloc::AllocationFlags
source · pub struct AllocationFlags(_);
Expand description
Allocation flags
Implementations§
source§impl AllocationFlags
impl AllocationFlags
sourcepub const DEVICE_ADDRESS: AllocationFlags = Self::from_bits_retain(1)
pub const DEVICE_ADDRESS: AllocationFlags = Self::from_bits_retain(1)
Specifies that the memory can be used for buffers created with flag that allows fetching device address.
source§impl AllocationFlags
impl AllocationFlags
sourcepub const fn empty() -> AllocationFlags
pub const fn empty() -> AllocationFlags
Returns an empty set of flags.
sourcepub const fn all() -> AllocationFlags
pub const fn all() -> AllocationFlags
Returns the set containing all flags.
sourcepub const fn from_bits(bits: u8) -> Option<AllocationFlags>
pub const fn from_bits(bits: u8) -> Option<AllocationFlags>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u8) -> AllocationFlags
pub const fn from_bits_truncate(bits: u8) -> AllocationFlags
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const fn from_bits_retain(bits: u8) -> AllocationFlags
pub const fn from_bits_retain(bits: u8) -> AllocationFlags
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
sourcepub fn from_name(name: &str) -> Option<AllocationFlags>
pub fn from_name(name: &str) -> Option<AllocationFlags>
Get the value for a flag from its stringified name.
Names are case-sensitive, so must correspond exactly to the identifier given to the flag.
sourcepub const fn intersects(&self, other: AllocationFlags) -> bool
pub const fn intersects(&self, other: AllocationFlags) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: AllocationFlags) -> bool
pub const fn contains(&self, other: AllocationFlags) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: AllocationFlags)
pub fn insert(&mut self, other: AllocationFlags)
Inserts the specified flags in-place.
sourcepub fn remove(&mut self, other: AllocationFlags)
pub fn remove(&mut self, other: AllocationFlags)
Removes the specified flags in-place.
sourcepub fn toggle(&mut self, other: AllocationFlags)
pub fn toggle(&mut self, other: AllocationFlags)
Toggles the specified flags in-place.
sourcepub fn set(&mut self, other: AllocationFlags, value: bool)
pub fn set(&mut self, other: AllocationFlags, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: AllocationFlags) -> AllocationFlags
pub const fn intersection(self, other: AllocationFlags) -> AllocationFlags
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: AllocationFlags) -> AllocationFlags
pub const fn union(self, other: AllocationFlags) -> AllocationFlags
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: AllocationFlags) -> AllocationFlags
pub const fn difference(self, other: AllocationFlags) -> AllocationFlags
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: AllocationFlags
) -> AllocationFlags
pub const fn symmetric_difference( self, other: AllocationFlags ) -> AllocationFlags
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) -> AllocationFlags
pub const fn complement(self) -> AllocationFlags
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
.
source§impl AllocationFlags
impl AllocationFlags
sourcepub const fn iter(&self) -> Iter<AllocationFlags>
pub const fn iter(&self) -> Iter<AllocationFlags>
Iterate over enabled flag values.
sourcepub const fn iter_names(&self) -> IterNames<AllocationFlags>
pub const fn iter_names(&self) -> IterNames<AllocationFlags>
Iterate over enabled flag values with their stringified names.
Trait Implementations§
source§impl Binary for AllocationFlags
impl Binary for AllocationFlags
source§impl BitAnd<AllocationFlags> for AllocationFlags
impl BitAnd<AllocationFlags> for AllocationFlags
source§fn bitand(self, other: AllocationFlags) -> AllocationFlags
fn bitand(self, other: AllocationFlags) -> AllocationFlags
Returns the intersection between the two sets of flags.
§type Output = AllocationFlags
type Output = AllocationFlags
&
operator.source§impl BitAndAssign<AllocationFlags> for AllocationFlags
impl BitAndAssign<AllocationFlags> for AllocationFlags
source§fn bitand_assign(&mut self, other: AllocationFlags)
fn bitand_assign(&mut self, other: AllocationFlags)
Disables all flags disabled in the set.
source§impl BitOr<AllocationFlags> for AllocationFlags
impl BitOr<AllocationFlags> for AllocationFlags
source§fn bitor(self, other: AllocationFlags) -> AllocationFlags
fn bitor(self, other: AllocationFlags) -> AllocationFlags
Returns the union of the two sets of flags.
§type Output = AllocationFlags
type Output = AllocationFlags
|
operator.source§impl BitOrAssign<AllocationFlags> for AllocationFlags
impl BitOrAssign<AllocationFlags> for AllocationFlags
source§fn bitor_assign(&mut self, other: AllocationFlags)
fn bitor_assign(&mut self, other: AllocationFlags)
Adds the set of flags.
source§impl BitXor<AllocationFlags> for AllocationFlags
impl BitXor<AllocationFlags> for AllocationFlags
source§fn bitxor(self, other: AllocationFlags) -> AllocationFlags
fn bitxor(self, other: AllocationFlags) -> AllocationFlags
Returns the left flags, but with all the right flags toggled.
§type Output = AllocationFlags
type Output = AllocationFlags
^
operator.source§impl BitXorAssign<AllocationFlags> for AllocationFlags
impl BitXorAssign<AllocationFlags> for AllocationFlags
source§fn bitxor_assign(&mut self, other: AllocationFlags)
fn bitxor_assign(&mut self, other: AllocationFlags)
Toggles the set of flags.
source§impl Clone for AllocationFlags
impl Clone for AllocationFlags
source§fn clone(&self) -> AllocationFlags
fn clone(&self) -> AllocationFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for AllocationFlags
impl Debug for AllocationFlags
source§impl Extend<AllocationFlags> for AllocationFlags
impl Extend<AllocationFlags> for AllocationFlags
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = AllocationFlags>,
fn extend<T>(&mut self, iterator: T)where T: IntoIterator<Item = AllocationFlags>,
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 Flags for AllocationFlags
impl Flags for AllocationFlags
source§const FLAGS: &'static [Flag<AllocationFlags>] = &[{
::bitflags::Flag::new("DEVICE_ADDRESS",
AllocationFlags::DEVICE_ADDRESS)
}]
const FLAGS: &'static [Flag<AllocationFlags>] = &[{ ::bitflags::Flag::new("DEVICE_ADDRESS", AllocationFlags::DEVICE_ADDRESS) }]
source§fn from_bits_retain(bits: u8) -> AllocationFlags
fn from_bits_retain(bits: u8) -> AllocationFlags
source§fn from_bits(bits: Self::Bits) -> Option<Self>
fn from_bits(bits: Self::Bits) -> Option<Self>
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere Self: Sized,
true
if there are flags common to both self
and other
.source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere Self: Sized,
true
if all of the flags in other
are contained within self
.source§fn set(&mut self, other: Self, value: bool)where
Self: Sized,
fn set(&mut self, other: Self, value: bool)where Self: Sized,
source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
source§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
source§fn complement(self) -> Self
fn complement(self) -> Self
source§impl FromIterator<AllocationFlags> for AllocationFlags
impl FromIterator<AllocationFlags> for AllocationFlags
source§fn from_iter<T>(iterator: T) -> AllocationFlagswhere
T: IntoIterator<Item = AllocationFlags>,
fn from_iter<T>(iterator: T) -> AllocationFlagswhere T: IntoIterator<Item = AllocationFlags>,
source§impl Hash for AllocationFlags
impl Hash for AllocationFlags
source§impl IntoIterator for AllocationFlags
impl IntoIterator for AllocationFlags
§type Item = AllocationFlags
type Item = AllocationFlags
§type IntoIter = Iter<AllocationFlags>
type IntoIter = Iter<AllocationFlags>
source§fn into_iter(self) -> <AllocationFlags as IntoIterator>::IntoIter
fn into_iter(self) -> <AllocationFlags as IntoIterator>::IntoIter
source§impl LowerHex for AllocationFlags
impl LowerHex for AllocationFlags
source§impl Not for AllocationFlags
impl Not for AllocationFlags
source§fn not(self) -> AllocationFlags
fn not(self) -> AllocationFlags
Returns the complement of this set of flags.
§type Output = AllocationFlags
type Output = AllocationFlags
!
operator.source§impl Octal for AllocationFlags
impl Octal for AllocationFlags
source§impl Ord for AllocationFlags
impl Ord for AllocationFlags
source§fn cmp(&self, other: &AllocationFlags) -> Ordering
fn cmp(&self, other: &AllocationFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<AllocationFlags> for AllocationFlags
impl PartialEq<AllocationFlags> for AllocationFlags
source§fn eq(&self, other: &AllocationFlags) -> bool
fn eq(&self, other: &AllocationFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<AllocationFlags> for AllocationFlags
impl PartialOrd<AllocationFlags> for AllocationFlags
source§fn partial_cmp(&self, other: &AllocationFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &AllocationFlags) -> Option<Ordering>
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 Sub<AllocationFlags> for AllocationFlags
impl Sub<AllocationFlags> for AllocationFlags
source§fn sub(self, other: AllocationFlags) -> AllocationFlags
fn sub(self, other: AllocationFlags) -> AllocationFlags
Returns the set difference of the two sets of flags.
§type Output = AllocationFlags
type Output = AllocationFlags
-
operator.source§impl SubAssign<AllocationFlags> for AllocationFlags
impl SubAssign<AllocationFlags> for AllocationFlags
source§fn sub_assign(&mut self, other: AllocationFlags)
fn sub_assign(&mut self, other: AllocationFlags)
Disables all flags enabled in the set.