Struct gpu_alloc::MemoryPropertyFlags
source · pub struct MemoryPropertyFlags(_);
Expand description
Memory properties type.
Implementations§
source§impl MemoryPropertyFlags
impl MemoryPropertyFlags
sourcepub const DEVICE_LOCAL: MemoryPropertyFlags = Self::from_bits_retain(1)
pub const DEVICE_LOCAL: MemoryPropertyFlags = Self::from_bits_retain(1)
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 = Self::from_bits_retain(2)
pub const HOST_VISIBLE: MemoryPropertyFlags = Self::from_bits_retain(2)
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 = Self::from_bits_retain(4)
pub const HOST_COHERENT: MemoryPropertyFlags = Self::from_bits_retain(4)
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 = Self::from_bits_retain(8)
pub const HOST_CACHED: MemoryPropertyFlags = Self::from_bits_retain(8)
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 = Self::from_bits_retain(16)
pub const LAZILY_ALLOCATED: MemoryPropertyFlags = Self::from_bits_retain(16)
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 = Self::from_bits_retain(32)
pub const PROTECTED: MemoryPropertyFlags = Self::from_bits_retain(32)
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
Returns an empty set of flags.
sourcepub const fn all() -> MemoryPropertyFlags
pub const fn all() -> MemoryPropertyFlags
Returns the set containing all flags.
sourcepub const fn from_bits(bits: u8) -> Option<MemoryPropertyFlags>
pub const fn from_bits(bits: u8) -> Option<MemoryPropertyFlags>
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) -> MemoryPropertyFlags
pub const fn from_bits_truncate(bits: u8) -> MemoryPropertyFlags
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const fn from_bits_retain(bits: u8) -> MemoryPropertyFlags
pub const fn from_bits_retain(bits: u8) -> MemoryPropertyFlags
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
sourcepub fn from_name(name: &str) -> Option<MemoryPropertyFlags>
pub fn from_name(name: &str) -> Option<MemoryPropertyFlags>
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: MemoryPropertyFlags) -> bool
pub const fn intersects(&self, other: MemoryPropertyFlags) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: MemoryPropertyFlags) -> bool
pub const fn contains(&self, other: MemoryPropertyFlags) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: MemoryPropertyFlags)
pub fn insert(&mut self, other: MemoryPropertyFlags)
Inserts the specified flags in-place.
sourcepub fn remove(&mut self, other: MemoryPropertyFlags)
pub fn remove(&mut self, other: MemoryPropertyFlags)
Removes the specified flags in-place.
sourcepub fn toggle(&mut self, other: MemoryPropertyFlags)
pub fn toggle(&mut self, other: MemoryPropertyFlags)
Toggles the specified flags in-place.
sourcepub fn set(&mut self, other: MemoryPropertyFlags, value: bool)
pub fn set(&mut self, other: MemoryPropertyFlags, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(
self,
other: MemoryPropertyFlags
) -> MemoryPropertyFlags
pub const fn intersection( self, other: MemoryPropertyFlags ) -> MemoryPropertyFlags
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: MemoryPropertyFlags) -> MemoryPropertyFlags
pub const fn union(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags
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: MemoryPropertyFlags) -> MemoryPropertyFlags
pub const fn difference(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags
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: MemoryPropertyFlags
) -> MemoryPropertyFlags
pub const fn symmetric_difference( self, other: MemoryPropertyFlags ) -> MemoryPropertyFlags
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) -> MemoryPropertyFlags
pub const fn complement(self) -> MemoryPropertyFlags
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 MemoryPropertyFlags
impl MemoryPropertyFlags
sourcepub const fn iter(&self) -> Iter<MemoryPropertyFlags>
pub const fn iter(&self) -> Iter<MemoryPropertyFlags>
Iterate over enabled flag values.
sourcepub const fn iter_names(&self) -> IterNames<MemoryPropertyFlags>
pub const fn iter_names(&self) -> IterNames<MemoryPropertyFlags>
Iterate over enabled flag values with their stringified names.
Trait Implementations§
source§impl Binary for MemoryPropertyFlags
impl Binary for MemoryPropertyFlags
source§impl BitAnd<MemoryPropertyFlags> for MemoryPropertyFlags
impl BitAnd<MemoryPropertyFlags> for MemoryPropertyFlags
source§fn bitand(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags
fn bitand(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags
Returns the intersection between the two sets of flags.
§type Output = MemoryPropertyFlags
type Output = MemoryPropertyFlags
&
operator.source§impl BitAndAssign<MemoryPropertyFlags> for MemoryPropertyFlags
impl BitAndAssign<MemoryPropertyFlags> for MemoryPropertyFlags
source§fn bitand_assign(&mut self, other: MemoryPropertyFlags)
fn bitand_assign(&mut self, other: MemoryPropertyFlags)
Disables all flags disabled in the set.
source§impl BitOr<MemoryPropertyFlags> for MemoryPropertyFlags
impl BitOr<MemoryPropertyFlags> for MemoryPropertyFlags
source§fn bitor(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags
fn bitor(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags
Returns the union of the two sets of flags.
§type Output = MemoryPropertyFlags
type Output = MemoryPropertyFlags
|
operator.source§impl BitOrAssign<MemoryPropertyFlags> for MemoryPropertyFlags
impl BitOrAssign<MemoryPropertyFlags> for MemoryPropertyFlags
source§fn bitor_assign(&mut self, other: MemoryPropertyFlags)
fn bitor_assign(&mut self, other: MemoryPropertyFlags)
Adds the set of flags.
source§impl BitXor<MemoryPropertyFlags> for MemoryPropertyFlags
impl BitXor<MemoryPropertyFlags> for MemoryPropertyFlags
source§fn bitxor(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags
fn bitxor(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags
Returns the left flags, but with all the right flags toggled.
§type Output = MemoryPropertyFlags
type Output = MemoryPropertyFlags
^
operator.source§impl BitXorAssign<MemoryPropertyFlags> for MemoryPropertyFlags
impl BitXorAssign<MemoryPropertyFlags> for MemoryPropertyFlags
source§fn bitxor_assign(&mut self, other: MemoryPropertyFlags)
fn bitxor_assign(&mut self, other: MemoryPropertyFlags)
Toggles the set of flags.
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>,
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>] = &[{
::bitflags::Flag::new("DEVICE_LOCAL",
MemoryPropertyFlags::DEVICE_LOCAL)
},
{
::bitflags::Flag::new("HOST_VISIBLE",
MemoryPropertyFlags::HOST_VISIBLE)
},
{
::bitflags::Flag::new("HOST_COHERENT",
MemoryPropertyFlags::HOST_COHERENT)
},
{
::bitflags::Flag::new("HOST_CACHED",
MemoryPropertyFlags::HOST_CACHED)
},
{
::bitflags::Flag::new("LAZILY_ALLOCATED",
MemoryPropertyFlags::LAZILY_ALLOCATED)
},
{
::bitflags::Flag::new("PROTECTED",
MemoryPropertyFlags::PROTECTED)
}]
const FLAGS: &'static [Flag<MemoryPropertyFlags>] = &[{ ::bitflags::Flag::new("DEVICE_LOCAL", MemoryPropertyFlags::DEVICE_LOCAL) }, { ::bitflags::Flag::new("HOST_VISIBLE", MemoryPropertyFlags::HOST_VISIBLE) }, { ::bitflags::Flag::new("HOST_COHERENT", MemoryPropertyFlags::HOST_COHERENT) }, { ::bitflags::Flag::new("HOST_CACHED", MemoryPropertyFlags::HOST_CACHED) }, { ::bitflags::Flag::new("LAZILY_ALLOCATED", MemoryPropertyFlags::LAZILY_ALLOCATED) }, { ::bitflags::Flag::new("PROTECTED", MemoryPropertyFlags::PROTECTED) }]
source§fn from_bits_retain(bits: u8) -> MemoryPropertyFlags
fn from_bits_retain(bits: u8) -> MemoryPropertyFlags
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<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>,
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
Returns the complement of this set of flags.
§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<MemoryPropertyFlags> for MemoryPropertyFlags
impl PartialEq<MemoryPropertyFlags> 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<MemoryPropertyFlags> for MemoryPropertyFlags
impl PartialOrd<MemoryPropertyFlags> 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<MemoryPropertyFlags> for MemoryPropertyFlags
impl Sub<MemoryPropertyFlags> for MemoryPropertyFlags
source§fn sub(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags
fn sub(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags
Returns the set difference of the two sets of flags.
§type Output = MemoryPropertyFlags
type Output = MemoryPropertyFlags
-
operator.source§impl SubAssign<MemoryPropertyFlags> for MemoryPropertyFlags
impl SubAssign<MemoryPropertyFlags> for MemoryPropertyFlags
source§fn sub_assign(&mut self, other: MemoryPropertyFlags)
fn sub_assign(&mut self, other: MemoryPropertyFlags)
Disables all flags enabled in the set.