Struct gpu_alloc::UsageFlags
source · pub struct UsageFlags(_);
Expand description
Memory usage type. Bits set define intended usage for requested memory.
Implementations§
source§impl UsageFlags
impl UsageFlags
sourcepub const FAST_DEVICE_ACCESS: Self = _
pub const FAST_DEVICE_ACCESS: Self = _
Hints for allocator to find memory with faster device access.
If no flags is specified than FAST_DEVICE_ACCESS
is implied.
sourcepub const HOST_ACCESS: Self = _
pub const HOST_ACCESS: Self = _
Memory will be accessed from host. This flags guarantees that host memory operations will be available. Otherwise implementation is encouraged to use non-host-accessible memory.
sourcepub const DOWNLOAD: Self = _
pub const DOWNLOAD: Self = _
Hints allocator that memory will be used for data downloading.
Allocator will strongly prefer host-cached memory.
Implies HOST_ACCESS
flag.
sourcepub const UPLOAD: Self = _
pub const UPLOAD: Self = _
Hints allocator that memory will be used for data uploading.
If DOWNLOAD
flag is not set then allocator will assume that
host will access memory in write-only manner and may
pick not host-cached.
Implies HOST_ACCESS
flag.
sourcepub const TRANSIENT: Self = _
pub const TRANSIENT: Self = _
Hints allocator that memory will be used for short duration allowing to use faster algorithm with less memory overhead. If use holds returned memory block for too long then effective memory overhead increases instead. Best use case is for staging buffer for single batch of operations.
sourcepub const DEVICE_ADDRESS: Self = _
pub const DEVICE_ADDRESS: Self = _
Requests memory that can be addressed with u64
.
Allows fetching device address for resources bound to that memory.
source§impl UsageFlags
impl UsageFlags
sourcepub const fn from_bits(bits: u8) -> Option<Self>
pub const fn from_bits(bits: u8) -> 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: u8) -> Self
pub const fn from_bits_truncate(bits: u8) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const fn from_bits_retain(bits: u8) -> Self
pub const fn from_bits_retain(bits: u8) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
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: 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
.
source§impl UsageFlags
impl UsageFlags
sourcepub const fn iter(&self) -> Iter<UsageFlags>
pub const fn iter(&self) -> Iter<UsageFlags>
Iterate over enabled flag values.
sourcepub const fn iter_names(&self) -> IterNames<UsageFlags>
pub const fn iter_names(&self) -> IterNames<UsageFlags>
Iterate over enabled flag values with their stringified names.
Trait Implementations§
source§impl Binary for UsageFlags
impl Binary for UsageFlags
source§impl BitAnd<UsageFlags> for UsageFlags
impl BitAnd<UsageFlags> for UsageFlags
source§impl BitAndAssign<UsageFlags> for UsageFlags
impl BitAndAssign<UsageFlags> for UsageFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<UsageFlags> for UsageFlags
impl BitOr<UsageFlags> for UsageFlags
source§fn bitor(self, other: UsageFlags) -> Self
fn bitor(self, other: UsageFlags) -> Self
Returns the union of the two sets of flags.
§type Output = UsageFlags
type Output = UsageFlags
|
operator.source§impl BitOrAssign<UsageFlags> for UsageFlags
impl BitOrAssign<UsageFlags> for UsageFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<UsageFlags> for UsageFlags
impl BitXor<UsageFlags> for UsageFlags
source§impl BitXorAssign<UsageFlags> for UsageFlags
impl BitXorAssign<UsageFlags> for UsageFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for UsageFlags
impl Clone for UsageFlags
source§fn clone(&self) -> UsageFlags
fn clone(&self) -> UsageFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for UsageFlags
impl Debug for UsageFlags
source§impl Extend<UsageFlags> for UsageFlags
impl Extend<UsageFlags> for UsageFlags
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 Flags for UsageFlags
impl Flags for UsageFlags
source§const FLAGS: &'static [Flag<UsageFlags>] = _
const FLAGS: &'static [Flag<UsageFlags>] = _
source§fn from_bits_retain(bits: u8) -> UsageFlags
fn from_bits_retain(bits: u8) -> UsageFlags
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<UsageFlags> for UsageFlags
impl FromIterator<UsageFlags> for UsageFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for UsageFlags
impl Hash for UsageFlags
source§impl IntoIterator for UsageFlags
impl IntoIterator for UsageFlags
source§impl LowerHex for UsageFlags
impl LowerHex for UsageFlags
source§impl Not for UsageFlags
impl Not for UsageFlags
source§impl Octal for UsageFlags
impl Octal for UsageFlags
source§impl Ord for UsageFlags
impl Ord for UsageFlags
source§fn cmp(&self, other: &UsageFlags) -> Ordering
fn cmp(&self, other: &UsageFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<UsageFlags> for UsageFlags
impl PartialEq<UsageFlags> for UsageFlags
source§fn eq(&self, other: &UsageFlags) -> bool
fn eq(&self, other: &UsageFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<UsageFlags> for UsageFlags
impl PartialOrd<UsageFlags> for UsageFlags
source§fn partial_cmp(&self, other: &UsageFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &UsageFlags) -> 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 PublicFlags for UsageFlags
impl PublicFlags for UsageFlags
source§impl Sub<UsageFlags> for UsageFlags
impl Sub<UsageFlags> for UsageFlags
source§impl SubAssign<UsageFlags> for UsageFlags
impl SubAssign<UsageFlags> for UsageFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.