Struct gpu_alloc_types::MemoryPropertyFlags

pub struct MemoryPropertyFlags { /* fields omitted */ }

Memory properties type.

Implementations

impl 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.

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.

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.

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.

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.

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.

pub const fn empty() -> MemoryPropertyFlags

Returns an empty set of flags

pub const fn all() -> MemoryPropertyFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u8) -> Option<MemoryPropertyFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u8) -> MemoryPropertyFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u8) -> MemoryPropertyFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: MemoryPropertyFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: MemoryPropertyFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: MemoryPropertyFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: MemoryPropertyFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: MemoryPropertyFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: MemoryPropertyFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for MemoryPropertyFlags

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl BitAnd<MemoryPropertyFlags> for MemoryPropertyFlags

type Output = MemoryPropertyFlags

The resulting type after applying the & operator.

pub fn bitand(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags

Returns the intersection between the two sets of flags.

impl BitAndAssign<MemoryPropertyFlags> for MemoryPropertyFlags

pub fn bitand_assign(&mut self, other: MemoryPropertyFlags)

Disables all flags disabled in the set.

impl BitOr<MemoryPropertyFlags> for MemoryPropertyFlags

type Output = MemoryPropertyFlags

The resulting type after applying the | operator.

pub fn bitor(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags

Returns the union of the two sets of flags.

impl BitOrAssign<MemoryPropertyFlags> for MemoryPropertyFlags

pub fn bitor_assign(&mut self, other: MemoryPropertyFlags)

Adds the set of flags.

impl BitXor<MemoryPropertyFlags> for MemoryPropertyFlags

type Output = MemoryPropertyFlags

The resulting type after applying the ^ operator.

pub fn bitxor(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<MemoryPropertyFlags> for MemoryPropertyFlags

pub fn bitxor_assign(&mut self, other: MemoryPropertyFlags)

Toggles the set of flags.

impl Clone for MemoryPropertyFlags

pub fn clone(&self) -> MemoryPropertyFlags

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for MemoryPropertyFlags

impl Debug for MemoryPropertyFlags

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for MemoryPropertyFlags

impl Extend<MemoryPropertyFlags> for MemoryPropertyFlags

pub fn extend<T: IntoIterator<Item = MemoryPropertyFlags>>(
    &mut self,
    iterator: T
)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<MemoryPropertyFlags> for MemoryPropertyFlags

pub fn from_iter<T: IntoIterator<Item = MemoryPropertyFlags>>(
    iterator: T
) -> MemoryPropertyFlags

Creates a value from an iterator.

impl Hash for MemoryPropertyFlags

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl LowerHex for MemoryPropertyFlags

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Not for MemoryPropertyFlags

type Output = MemoryPropertyFlags

The resulting type after applying the ! operator.

pub fn not(self) -> MemoryPropertyFlags

Returns the complement of this set of flags.

impl Octal for MemoryPropertyFlags

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Ord for MemoryPropertyFlags

pub fn cmp(&self, other: &MemoryPropertyFlags) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<MemoryPropertyFlags> for MemoryPropertyFlags

pub fn eq(&self, other: &MemoryPropertyFlags) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &MemoryPropertyFlags) -> bool

This method tests for !=.

impl PartialOrd<MemoryPropertyFlags> for MemoryPropertyFlags

pub fn partial_cmp(&self, other: &MemoryPropertyFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &MemoryPropertyFlags) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &MemoryPropertyFlags) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &MemoryPropertyFlags) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &MemoryPropertyFlags) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for MemoryPropertyFlags

impl StructuralPartialEq for MemoryPropertyFlags

impl Sub<MemoryPropertyFlags> for MemoryPropertyFlags

type Output = MemoryPropertyFlags

The resulting type after applying the - operator.

pub fn sub(self, other: MemoryPropertyFlags) -> MemoryPropertyFlags

Returns the set difference of the two sets of flags.

impl SubAssign<MemoryPropertyFlags> for MemoryPropertyFlags

pub fn sub_assign(&mut self, other: MemoryPropertyFlags)

Disables all flags enabled in the set.

impl UpperHex for MemoryPropertyFlags

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.