Struct gpu_alloc::UsageFlags
source · pub struct UsageFlags(/* private fields */);
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 bits(&self) -> u8
pub const fn bits(&self) -> u8
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u8) -> Option<Self>
pub const fn from_bits(bits: u8) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: u8) -> Self
pub const fn from_bits_truncate(bits: u8) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u8) -> Self
pub const fn from_bits_retain(bits: u8) -> Self
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set.
This method will return None
if name
is empty or doesn’t
correspond to any named flag.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
remove
won’t truncate other
, but the !
operator will.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl UsageFlags
impl UsageFlags
sourcepub const fn iter(&self) -> Iter<UsageFlags>
pub const fn iter(&self) -> Iter<UsageFlags>
Yield a set of contained flags values.
Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.
sourcepub const fn iter_names(&self) -> IterNames<UsageFlags>
pub const fn iter_names(&self) -> IterNames<UsageFlags>
Yield a set of contained named flags values.
This method is like iter
, except only yields bits in contained named flags.
Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
Trait Implementations§
source§impl Binary for UsageFlags
impl Binary for UsageFlags
source§impl BitAnd for UsageFlags
impl BitAnd for UsageFlags
source§impl BitAndAssign for UsageFlags
impl BitAndAssign for UsageFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for UsageFlags
impl BitOr for UsageFlags
source§fn bitor(self, other: UsageFlags) -> Self
fn bitor(self, other: UsageFlags) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = UsageFlags
type Output = UsageFlags
|
operator.source§impl BitOrAssign for UsageFlags
impl BitOrAssign for UsageFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for UsageFlags
impl BitXor for UsageFlags
source§impl BitXorAssign for UsageFlags
impl BitXorAssign for UsageFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
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)
The bitwise or (|
) of the bits in each flags value.
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_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<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,
source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moresource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moresource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.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
The bitwise or (|
) of the bits in each flags value.
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 for UsageFlags
impl PartialEq 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 for UsageFlags
impl PartialOrd 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 for UsageFlags
impl Sub for UsageFlags
source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
§type Output = UsageFlags
type Output = UsageFlags
-
operator.source§impl SubAssign for UsageFlags
impl SubAssign for UsageFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.