Struct gpu_alloc::MemoryPropertyFlags
source · pub struct MemoryPropertyFlags(/* private fields */);
Expand description
Memory properties type.
Implementations§
source§impl MemoryPropertyFlags
impl MemoryPropertyFlags
sourcepub const DEVICE_LOCAL: MemoryPropertyFlags = _
pub const DEVICE_LOCAL: MemoryPropertyFlags = _
This flag is set for device-local memory types. Device-local memory is situated “close” to the GPU cores and allows for fast access.
sourcepub const HOST_VISIBLE: MemoryPropertyFlags = _
pub const HOST_VISIBLE: MemoryPropertyFlags = _
This flag is set for host-visible memory types. Host-visible memory can be mapped to the host memory range.
sourcepub const HOST_COHERENT: MemoryPropertyFlags = _
pub const HOST_COHERENT: MemoryPropertyFlags = _
This flag is set for host-coherent memory types. Host-coherent memory does not requires manual invalidation for modifications on GPU to become visible on host; nor flush for modification on host to become visible on GPU. Access synchronization is still required.
sourcepub const HOST_CACHED: MemoryPropertyFlags = _
pub const HOST_CACHED: MemoryPropertyFlags = _
This flag is set for host-cached memory types. Host-cached memory uses cache in host memory for faster reads from host.
sourcepub const LAZILY_ALLOCATED: MemoryPropertyFlags = _
pub const LAZILY_ALLOCATED: MemoryPropertyFlags = _
This flag is set for lazily-allocated memory types. Lazily-allocated memory must be used (and only) for transient image attachments.
sourcepub const PROTECTED: MemoryPropertyFlags = _
pub const PROTECTED: MemoryPropertyFlags = _
This flag is set for protected memory types. Protected memory can be used for writing by protected operations and can be read only by protected operations. Protected memory cannot be host-visible. Implementation must guarantee that there is no way for data to flow from protected to unprotected memory.
source§impl MemoryPropertyFlags
impl MemoryPropertyFlags
sourcepub const fn empty() -> MemoryPropertyFlags
pub const fn empty() -> MemoryPropertyFlags
Get a flags value with all bits unset.
sourcepub const fn all() -> MemoryPropertyFlags
pub const fn all() -> MemoryPropertyFlags
Get a flags value with all known bits set.
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<MemoryPropertyFlags>
pub const fn from_bits(bits: u8) -> Option<MemoryPropertyFlags>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: u8) -> MemoryPropertyFlags
pub const fn from_bits_truncate(bits: u8) -> MemoryPropertyFlags
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u8) -> MemoryPropertyFlags
pub const fn from_bits_retain(bits: u8) -> MemoryPropertyFlags
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<MemoryPropertyFlags>
pub fn from_name(name: &str) -> Option<MemoryPropertyFlags>
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: MemoryPropertyFlags) -> bool
pub const fn intersects(&self, other: MemoryPropertyFlags) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: MemoryPropertyFlags) -> bool
pub const fn contains(&self, other: MemoryPropertyFlags) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn insert(&mut self, other: MemoryPropertyFlags)
pub fn insert(&mut self, other: MemoryPropertyFlags)
The bitwise or (|
) of the bits in two flags values.
sourcepub fn remove(&mut self, other: MemoryPropertyFlags)
pub fn remove(&mut self, other: MemoryPropertyFlags)
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: MemoryPropertyFlags)
pub fn toggle(&mut self, other: MemoryPropertyFlags)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: MemoryPropertyFlags, value: bool)
pub fn set(&mut self, other: MemoryPropertyFlags, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(
self,
other: MemoryPropertyFlags
) -> MemoryPropertyFlags
pub const fn intersection( self, other: MemoryPropertyFlags ) -> MemoryPropertyFlags
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags
pub const fn union(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags
pub const fn difference(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags
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: MemoryPropertyFlags
) -> MemoryPropertyFlags
pub const fn symmetric_difference( self, other: MemoryPropertyFlags ) -> MemoryPropertyFlags
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> MemoryPropertyFlags
pub const fn complement(self) -> MemoryPropertyFlags
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl MemoryPropertyFlags
impl MemoryPropertyFlags
sourcepub const fn iter(&self) -> Iter<MemoryPropertyFlags>
pub const fn iter(&self) -> Iter<MemoryPropertyFlags>
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<MemoryPropertyFlags>
pub const fn iter_names(&self) -> IterNames<MemoryPropertyFlags>
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 MemoryPropertyFlags
impl Binary for MemoryPropertyFlags
source§impl BitAnd for MemoryPropertyFlags
impl BitAnd for MemoryPropertyFlags
source§fn bitand(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags
fn bitand(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags
The bitwise and (&
) of the bits in two flags values.
§type Output = MemoryPropertyFlags
type Output = MemoryPropertyFlags
&
operator.source§impl BitAndAssign for MemoryPropertyFlags
impl BitAndAssign for MemoryPropertyFlags
source§fn bitand_assign(&mut self, other: MemoryPropertyFlags)
fn bitand_assign(&mut self, other: MemoryPropertyFlags)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for MemoryPropertyFlags
impl BitOr for MemoryPropertyFlags
source§fn bitor(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags
fn bitor(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags
The bitwise or (|
) of the bits in two flags values.
§type Output = MemoryPropertyFlags
type Output = MemoryPropertyFlags
|
operator.source§impl BitOrAssign for MemoryPropertyFlags
impl BitOrAssign for MemoryPropertyFlags
source§fn bitor_assign(&mut self, other: MemoryPropertyFlags)
fn bitor_assign(&mut self, other: MemoryPropertyFlags)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for MemoryPropertyFlags
impl BitXor for MemoryPropertyFlags
source§fn bitxor(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags
fn bitxor(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags
The bitwise exclusive-or (^
) of the bits in two flags values.
§type Output = MemoryPropertyFlags
type Output = MemoryPropertyFlags
^
operator.source§impl BitXorAssign for MemoryPropertyFlags
impl BitXorAssign for MemoryPropertyFlags
source§fn bitxor_assign(&mut self, other: MemoryPropertyFlags)
fn bitxor_assign(&mut self, other: MemoryPropertyFlags)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Clone for MemoryPropertyFlags
impl Clone for MemoryPropertyFlags
source§fn clone(&self) -> MemoryPropertyFlags
fn clone(&self) -> MemoryPropertyFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for MemoryPropertyFlags
impl Debug for MemoryPropertyFlags
source§impl Extend<MemoryPropertyFlags> for MemoryPropertyFlags
impl Extend<MemoryPropertyFlags> for MemoryPropertyFlags
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = MemoryPropertyFlags>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = MemoryPropertyFlags>,
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 MemoryPropertyFlags
impl Flags for MemoryPropertyFlags
source§const FLAGS: &'static [Flag<MemoryPropertyFlags>] = _
const FLAGS: &'static [Flag<MemoryPropertyFlags>] = _
source§fn from_bits_retain(bits: u8) -> MemoryPropertyFlags
fn from_bits_retain(bits: u8) -> MemoryPropertyFlags
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<MemoryPropertyFlags> for MemoryPropertyFlags
impl FromIterator<MemoryPropertyFlags> for MemoryPropertyFlags
source§fn from_iter<T>(iterator: T) -> MemoryPropertyFlagswhere
T: IntoIterator<Item = MemoryPropertyFlags>,
fn from_iter<T>(iterator: T) -> MemoryPropertyFlagswhere
T: IntoIterator<Item = MemoryPropertyFlags>,
The bitwise or (|
) of the bits in each flags value.
source§impl Hash for MemoryPropertyFlags
impl Hash for MemoryPropertyFlags
source§impl IntoIterator for MemoryPropertyFlags
impl IntoIterator for MemoryPropertyFlags
§type Item = MemoryPropertyFlags
type Item = MemoryPropertyFlags
§type IntoIter = Iter<MemoryPropertyFlags>
type IntoIter = Iter<MemoryPropertyFlags>
source§fn into_iter(self) -> <MemoryPropertyFlags as IntoIterator>::IntoIter
fn into_iter(self) -> <MemoryPropertyFlags as IntoIterator>::IntoIter
source§impl LowerHex for MemoryPropertyFlags
impl LowerHex for MemoryPropertyFlags
source§impl Not for MemoryPropertyFlags
impl Not for MemoryPropertyFlags
source§fn not(self) -> MemoryPropertyFlags
fn not(self) -> MemoryPropertyFlags
The bitwise negation (!
) of the bits in a flags value, truncating the result.
§type Output = MemoryPropertyFlags
type Output = MemoryPropertyFlags
!
operator.source§impl Octal for MemoryPropertyFlags
impl Octal for MemoryPropertyFlags
source§impl Ord for MemoryPropertyFlags
impl Ord for MemoryPropertyFlags
source§fn cmp(&self, other: &MemoryPropertyFlags) -> Ordering
fn cmp(&self, other: &MemoryPropertyFlags) -> 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 MemoryPropertyFlags
impl PartialEq for MemoryPropertyFlags
source§fn eq(&self, other: &MemoryPropertyFlags) -> bool
fn eq(&self, other: &MemoryPropertyFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for MemoryPropertyFlags
impl PartialOrd for MemoryPropertyFlags
source§fn partial_cmp(&self, other: &MemoryPropertyFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &MemoryPropertyFlags) -> 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 for MemoryPropertyFlags
impl Sub for MemoryPropertyFlags
source§fn sub(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags
fn sub(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags
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 = MemoryPropertyFlags
type Output = MemoryPropertyFlags
-
operator.source§impl SubAssign for MemoryPropertyFlags
impl SubAssign for MemoryPropertyFlags
source§fn sub_assign(&mut self, other: MemoryPropertyFlags)
fn sub_assign(&mut self, other: MemoryPropertyFlags)
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.