Struct vk_mem_alloc::AllocationCreateFlags
source · [−]pub struct AllocationCreateFlags { /* private fields */ }
Implementations
sourceimpl AllocationCreateFlags
impl AllocationCreateFlags
pub const NONE: Self = _
pub const DEDICATED_MEMORY: Self = _
pub const NEVER_ALLOCATE: Self = _
pub const MAPPED: Self = _
pub const USER_DATA_COPY_STRING: Self = _
pub const UPPER_ADDRESS: Self = _
pub const DONT_BIND: Self = _
pub const WITHIN_BUDGET: Self = _
pub const CAN_ALIAS: Self = _
pub const HOST_ACCESS_SEQUENTIAL_WRITE: Self = _
pub const HOST_ACCESS_RANDOM: Self = _
pub const HOST_ACCESS_ALLOW_TRANSFER_INSTEAD: Self = _
pub const STRATEGY_MIN_MEMORY: Self = _
pub const STRATEGY_MIN_TIME: Self = _
pub const STRATEGY_MIN_OFFSET: Self = _
pub const STRATEGY_BEST_FIT: Self = _
pub const STRATEGY_FIRST_FIT: Self = _
pub const STRATEGY_MASK: Self = _
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
pub const unsafe fn from_bits_unchecked(bits: u32) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
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: Self) -> Self
pub const fn union(self, other: Self) -> Self
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: Self) -> Self
pub const fn difference(self, other: Self) -> Self
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: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
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) -> Self
pub const fn complement(self) -> Self
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
.
Trait Implementations
sourceimpl Binary for AllocationCreateFlags
impl Binary for AllocationCreateFlags
sourceimpl BitAnd<AllocationCreateFlags> for AllocationCreateFlags
impl BitAnd<AllocationCreateFlags> for AllocationCreateFlags
type Output = AllocationCreateFlags
type Output = AllocationCreateFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<AllocationCreateFlags> for AllocationCreateFlags
impl BitAndAssign<AllocationCreateFlags> for AllocationCreateFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<AllocationCreateFlags> for AllocationCreateFlags
impl BitOr<AllocationCreateFlags> for AllocationCreateFlags
sourcefn bitor(self, other: AllocationCreateFlags) -> Self
fn bitor(self, other: AllocationCreateFlags) -> Self
Returns the union of the two sets of flags.
type Output = AllocationCreateFlags
type Output = AllocationCreateFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<AllocationCreateFlags> for AllocationCreateFlags
impl BitOrAssign<AllocationCreateFlags> for AllocationCreateFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<AllocationCreateFlags> for AllocationCreateFlags
impl BitXor<AllocationCreateFlags> for AllocationCreateFlags
sourcefn bitxor(self, other: Self) -> Self
fn bitxor(self, other: Self) -> Self
Returns the left flags, but with all the right flags toggled.
type Output = AllocationCreateFlags
type Output = AllocationCreateFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<AllocationCreateFlags> for AllocationCreateFlags
impl BitXorAssign<AllocationCreateFlags> for AllocationCreateFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for AllocationCreateFlags
impl Clone for AllocationCreateFlags
sourcefn clone(&self) -> AllocationCreateFlags
fn clone(&self) -> AllocationCreateFlags
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for AllocationCreateFlags
impl Debug for AllocationCreateFlags
sourceimpl Default for AllocationCreateFlags
impl Default for AllocationCreateFlags
sourceimpl Extend<AllocationCreateFlags> for AllocationCreateFlags
impl Extend<AllocationCreateFlags> for AllocationCreateFlags
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<AllocationCreateFlags> for AllocationCreateFlags
impl FromIterator<AllocationCreateFlags> for AllocationCreateFlags
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl Hash for AllocationCreateFlags
impl Hash for AllocationCreateFlags
sourceimpl LowerHex for AllocationCreateFlags
impl LowerHex for AllocationCreateFlags
sourceimpl Not for AllocationCreateFlags
impl Not for AllocationCreateFlags
type Output = AllocationCreateFlags
type Output = AllocationCreateFlags
The resulting type after applying the !
operator.
sourceimpl Octal for AllocationCreateFlags
impl Octal for AllocationCreateFlags
sourceimpl Ord for AllocationCreateFlags
impl Ord for AllocationCreateFlags
sourcefn cmp(&self, other: &AllocationCreateFlags) -> Ordering
fn cmp(&self, other: &AllocationCreateFlags) -> Ordering
1.21.0 · sourcefn max(self, other: Self) -> Self
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
1.21.0 · sourcefn min(self, other: Self) -> Self
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,
Restrict a value to a certain interval. Read more
sourceimpl PartialEq<AllocationCreateFlags> for AllocationCreateFlags
impl PartialEq<AllocationCreateFlags> for AllocationCreateFlags
sourcefn eq(&self, other: &AllocationCreateFlags) -> bool
fn eq(&self, other: &AllocationCreateFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &AllocationCreateFlags) -> bool
fn ne(&self, other: &AllocationCreateFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<AllocationCreateFlags> for AllocationCreateFlags
impl PartialOrd<AllocationCreateFlags> for AllocationCreateFlags
sourcefn partial_cmp(&self, other: &AllocationCreateFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &AllocationCreateFlags) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl Sub<AllocationCreateFlags> for AllocationCreateFlags
impl Sub<AllocationCreateFlags> for AllocationCreateFlags
type Output = AllocationCreateFlags
type Output = AllocationCreateFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<AllocationCreateFlags> for AllocationCreateFlags
impl SubAssign<AllocationCreateFlags> for AllocationCreateFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for AllocationCreateFlags
impl UpperHex for AllocationCreateFlags
impl Copy for AllocationCreateFlags
impl Eq for AllocationCreateFlags
impl StructuralEq for AllocationCreateFlags
impl StructuralPartialEq for AllocationCreateFlags
Auto Trait Implementations
impl RefUnwindSafe for AllocationCreateFlags
impl Send for AllocationCreateFlags
impl Sync for AllocationCreateFlags
impl Unpin for AllocationCreateFlags
impl UnwindSafe for AllocationCreateFlags
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more