Struct gpu_alloc::UsageFlags [−][src]
pub struct UsageFlags { /* fields omitted */ }
Expand description
Memory usage type. Bits set define intended usage for requested memory.
Implementations
impl UsageFlags
[src]
impl UsageFlags
[src]pub const FAST_DEVICE_ACCESS: UsageFlags
[src]
pub const FAST_DEVICE_ACCESS: UsageFlags
[src]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
[src]
pub const HOST_ACCESS: UsageFlags
[src]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
[src]
pub const DOWNLOAD: UsageFlags
[src]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
[src]
pub const UPLOAD: UsageFlags
[src]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
[src]
pub const TRANSIENT: UsageFlags
[src]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
[src]
pub const DEVICE_ADDRESS: UsageFlags
[src]Requests memory that can be addressed with u64
.
Allows fetching device address for resources bound to that memory.
pub const fn empty() -> UsageFlags
[src]
pub const fn empty() -> UsageFlags
[src]Returns an empty set of flags
pub const fn all() -> UsageFlags
[src]
pub const fn all() -> UsageFlags
[src]Returns the set containing all flags.
pub fn from_bits(bits: u8) -> Option<UsageFlags>
[src]
pub fn from_bits(bits: u8) -> Option<UsageFlags>
[src]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
[src]
pub const fn from_bits_truncate(bits: u8) -> UsageFlags
[src]Convert from underlying bit representation, dropping any bits that do not correspond to flags.
pub const unsafe fn from_bits_unchecked(bits: u8) -> UsageFlags
[src]
pub const unsafe fn from_bits_unchecked(bits: u8) -> UsageFlags
[src]Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
pub const fn intersects(&self, other: UsageFlags) -> bool
[src]
pub const fn intersects(&self, other: UsageFlags) -> bool
[src]Returns true
if there are flags common to both self
and other
.
pub const fn contains(&self, other: UsageFlags) -> bool
[src]
pub const fn contains(&self, other: UsageFlags) -> bool
[src]Returns true
all of the flags in other
are contained within self
.
pub fn insert(&mut self, other: UsageFlags)
[src]
pub fn insert(&mut self, other: UsageFlags)
[src]Inserts the specified flags in-place.
pub fn remove(&mut self, other: UsageFlags)
[src]
pub fn remove(&mut self, other: UsageFlags)
[src]Removes the specified flags in-place.
pub fn toggle(&mut self, other: UsageFlags)
[src]
pub fn toggle(&mut self, other: UsageFlags)
[src]Toggles the specified flags in-place.
pub fn set(&mut self, other: UsageFlags, value: bool)
[src]
pub fn set(&mut self, other: UsageFlags, value: bool)
[src]Inserts or removes the specified flags depending on the passed value.
Trait Implementations
impl Binary for UsageFlags
[src]
impl Binary for UsageFlags
[src]impl BitAnd<UsageFlags> for UsageFlags
[src]
impl BitAnd<UsageFlags> for UsageFlags
[src]fn bitand(self, other: UsageFlags) -> UsageFlags
[src]
fn bitand(self, other: UsageFlags) -> UsageFlags
[src]Returns the intersection between the two sets of flags.
type Output = UsageFlags
type Output = UsageFlags
The resulting type after applying the &
operator.
impl BitAndAssign<UsageFlags> for UsageFlags
[src]
impl BitAndAssign<UsageFlags> for UsageFlags
[src]fn bitand_assign(&mut self, other: UsageFlags)
[src]
fn bitand_assign(&mut self, other: UsageFlags)
[src]Disables all flags disabled in the set.
impl BitOr<UsageFlags> for UsageFlags
[src]
impl BitOr<UsageFlags> for UsageFlags
[src]fn bitor(self, other: UsageFlags) -> UsageFlags
[src]
fn bitor(self, other: UsageFlags) -> UsageFlags
[src]Returns the union of the two sets of flags.
type Output = UsageFlags
type Output = UsageFlags
The resulting type after applying the |
operator.
impl BitOrAssign<UsageFlags> for UsageFlags
[src]
impl BitOrAssign<UsageFlags> for UsageFlags
[src]fn bitor_assign(&mut self, other: UsageFlags)
[src]
fn bitor_assign(&mut self, other: UsageFlags)
[src]Adds the set of flags.
impl BitXor<UsageFlags> for UsageFlags
[src]
impl BitXor<UsageFlags> for UsageFlags
[src]fn bitxor(self, other: UsageFlags) -> UsageFlags
[src]
fn bitxor(self, other: UsageFlags) -> UsageFlags
[src]Returns the left flags, but with all the right flags toggled.
type Output = UsageFlags
type Output = UsageFlags
The resulting type after applying the ^
operator.
impl BitXorAssign<UsageFlags> for UsageFlags
[src]
impl BitXorAssign<UsageFlags> for UsageFlags
[src]fn bitxor_assign(&mut self, other: UsageFlags)
[src]
fn bitxor_assign(&mut self, other: UsageFlags)
[src]Toggles the set of flags.
impl Clone for UsageFlags
[src]
impl Clone for UsageFlags
[src]fn clone(&self) -> UsageFlags
[src]
fn clone(&self) -> UsageFlags
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Debug for UsageFlags
[src]
impl Debug for UsageFlags
[src]impl Extend<UsageFlags> for UsageFlags
[src]
impl Extend<UsageFlags> for UsageFlags
[src]fn extend<T: IntoIterator<Item = UsageFlags>>(&mut self, iterator: T)
[src]
fn extend<T: IntoIterator<Item = UsageFlags>>(&mut self, iterator: T)
[src]Extends a collection with the contents of an iterator. Read more
fn extend_one(&mut self, item: A)
[src]
fn extend_one(&mut self, item: A)
[src]extend_one
)Extends a collection with exactly one element.
fn extend_reserve(&mut self, additional: usize)
[src]
fn extend_reserve(&mut self, additional: usize)
[src]extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
impl FromIterator<UsageFlags> for UsageFlags
[src]
impl FromIterator<UsageFlags> for UsageFlags
[src]fn from_iter<T: IntoIterator<Item = UsageFlags>>(iterator: T) -> UsageFlags
[src]
fn from_iter<T: IntoIterator<Item = UsageFlags>>(iterator: T) -> UsageFlags
[src]Creates a value from an iterator. Read more
impl Hash for UsageFlags
[src]
impl Hash for UsageFlags
[src]impl LowerHex for UsageFlags
[src]
impl LowerHex for UsageFlags
[src]impl Not for UsageFlags
[src]
impl Not for UsageFlags
[src]fn not(self) -> UsageFlags
[src]
fn not(self) -> UsageFlags
[src]Returns the complement of this set of flags.
type Output = UsageFlags
type Output = UsageFlags
The resulting type after applying the !
operator.
impl Octal for UsageFlags
[src]
impl Octal for UsageFlags
[src]impl Ord for UsageFlags
[src]
impl Ord for UsageFlags
[src]impl PartialEq<UsageFlags> for UsageFlags
[src]
impl PartialEq<UsageFlags> for UsageFlags
[src]fn eq(&self, other: &UsageFlags) -> bool
[src]
fn eq(&self, other: &UsageFlags) -> bool
[src]This method tests for self
and other
values to be equal, and is used
by ==
. Read more
fn ne(&self, other: &UsageFlags) -> bool
[src]
fn ne(&self, other: &UsageFlags) -> bool
[src]This method tests for !=
.
impl PartialOrd<UsageFlags> for UsageFlags
[src]
impl PartialOrd<UsageFlags> for UsageFlags
[src]fn partial_cmp(&self, other: &UsageFlags) -> Option<Ordering>
[src]
fn partial_cmp(&self, other: &UsageFlags) -> Option<Ordering>
[src]This method returns an ordering between self
and other
values if one exists. Read more
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than (for self
and other
) and is used by the <
operator. Read more
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl Sub<UsageFlags> for UsageFlags
[src]
impl Sub<UsageFlags> for UsageFlags
[src]fn sub(self, other: UsageFlags) -> UsageFlags
[src]
fn sub(self, other: UsageFlags) -> UsageFlags
[src]Returns the set difference of the two sets of flags.
type Output = UsageFlags
type Output = UsageFlags
The resulting type after applying the -
operator.
impl SubAssign<UsageFlags> for UsageFlags
[src]
impl SubAssign<UsageFlags> for UsageFlags
[src]fn sub_assign(&mut self, other: UsageFlags)
[src]
fn sub_assign(&mut self, other: UsageFlags)
[src]Disables all flags enabled in the set.
impl UpperHex for UsageFlags
[src]
impl UpperHex for UsageFlags
[src]impl Copy for UsageFlags
[src]
impl Eq for UsageFlags
[src]
impl StructuralEq for UsageFlags
[src]
impl StructuralPartialEq for UsageFlags
[src]
Auto Trait Implementations
impl RefUnwindSafe for UsageFlags
impl Send for UsageFlags
impl Sync for UsageFlags
impl Unpin for UsageFlags
impl UnwindSafe for UsageFlags
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more