Struct gpu_alloc::UsageFlags

pub struct UsageFlags { /* fields omitted */ }

Memory usage type. Bits set define intended usage for requested memory.

Implementations

impl UsageFlags

pub const FAST_DEVICE_ACCESS: UsageFlags

Hints for allocator to find memory with faster device access. If no flags is specified than FAST_DEVICE_ACCESS is implied.

pub const HOST_ACCESS: UsageFlags

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.

pub const DOWNLOAD: UsageFlags

Hints allocator that memory will be used for data downloading. Allocator will strongly prefer host-cached memory. Implies HOST_ACCESS flag.

pub const UPLOAD: UsageFlags

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.

pub const TRANSIENT: UsageFlags

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.

pub const DEVICE_ADDRESS: UsageFlags

Requests memory that can be addressed with u64. Allows fetching device address for resources bound to that memory.

pub const fn empty() -> UsageFlags

Returns an empty set of flags

pub const fn all() -> UsageFlags

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<UsageFlags>

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) -> UsageFlags

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

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

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: UsageFlags) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for UsageFlags

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

Formats the value using the given formatter.

impl BitAnd<UsageFlags> for UsageFlags

type Output = UsageFlags

The resulting type after applying the & operator.

fn bitand(self, other: UsageFlags) -> UsageFlags

Returns the intersection between the two sets of flags.

impl BitAndAssign<UsageFlags> for UsageFlags

fn bitand_assign(&mut self, other: UsageFlags)

Disables all flags disabled in the set.

impl BitOr<UsageFlags> for UsageFlags

type Output = UsageFlags

The resulting type after applying the | operator.

fn bitor(self, other: UsageFlags) -> UsageFlags

Returns the union of the two sets of flags.

impl BitOrAssign<UsageFlags> for UsageFlags

fn bitor_assign(&mut self, other: UsageFlags)

Adds the set of flags.

impl BitXor<UsageFlags> for UsageFlags

type Output = UsageFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: UsageFlags) -> UsageFlags

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

impl BitXorAssign<UsageFlags> for UsageFlags

fn bitxor_assign(&mut self, other: UsageFlags)

Toggles the set of flags.

impl Clone for UsageFlags

fn clone(&self) -> UsageFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for UsageFlags

impl Debug for UsageFlags

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

Formats the value using the given formatter.

impl Eq for UsageFlags

impl Extend<UsageFlags> for UsageFlags

fn extend<T: IntoIterator<Item = UsageFlags>>(&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<UsageFlags> for UsageFlags

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

Creates a value from an iterator.

impl Hash for UsageFlags

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 UsageFlags

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

Formats the value using the given formatter.

impl Not for UsageFlags

type Output = UsageFlags

The resulting type after applying the ! operator.

fn not(self) -> UsageFlags

Returns the complement of this set of flags.

impl Octal for UsageFlags

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

Formats the value using the given formatter.

impl Ord for UsageFlags

fn cmp(&self, other: &UsageFlags) -> 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<UsageFlags> for UsageFlags

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

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

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

This method tests for !=.

impl PartialOrd<UsageFlags> for UsageFlags

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

impl StructuralEq for UsageFlags

impl StructuralPartialEq for UsageFlags

impl Sub<UsageFlags> for UsageFlags

type Output = UsageFlags

The resulting type after applying the - operator.

fn sub(self, other: UsageFlags) -> UsageFlags

Returns the set difference of the two sets of flags.

impl SubAssign<UsageFlags> for UsageFlags

fn sub_assign(&mut self, other: UsageFlags)

Disables all flags enabled in the set.

impl UpperHex for UsageFlags

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

Formats the value using the given formatter.