Struct vma::VirtualAllocationCreateFlags
source · pub struct VirtualAllocationCreateFlags { /* private fields */ }
Expand description
Flags for configuring VirtualBlock
construction
Implementations§
source§impl VirtualAllocationCreateFlags
impl VirtualAllocationCreateFlags
sourcepub const VMA_VIRTUAL_ALLOCATION_CREATE_UPPER_ADDRESS_BIT: Self = _
pub const VMA_VIRTUAL_ALLOCATION_CREATE_UPPER_ADDRESS_BIT: Self = _
Allocation will be created from upper stack in a double stack pool.
This flag is only allowed for virtual blocks created with #VMA_VIRTUAL_BLOCK_CREATE_LINEAR_ALGORITHM_BIT flag.
sourcepub const VMA_VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT: Self = _
pub const VMA_VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT: Self = _
Allocation strategy that tries to minimize memory usage.
sourcepub const VMA_VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT: Self = _
pub const VMA_VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT: Self = _
Allocation strategy that tries to minimize allocation time.
sourcepub const VMA_VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_OFFSET_BIT: Self = _
pub const VMA_VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_OFFSET_BIT: Self = _
Allocation strategy that chooses always the lowest offset in available space. This is not the most efficient strategy but achieves highly packed data.
sourcepub const VMA_VIRTUAL_ALLOCATION_CREATE_STRATEGY_MASK: Self = _
pub const VMA_VIRTUAL_ALLOCATION_CREATE_STRATEGY_MASK: Self = _
A bit mask to extract only STRATEGY
bits from entire set of flags.
These strategy flags are binary compatible with equivalent flags in #VmaAllocationCreateFlagBits.
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§
source§impl BitAndAssign<VirtualAllocationCreateFlags> for VirtualAllocationCreateFlags
impl BitAndAssign<VirtualAllocationCreateFlags> for VirtualAllocationCreateFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<VirtualAllocationCreateFlags> for VirtualAllocationCreateFlags
impl BitOr<VirtualAllocationCreateFlags> for VirtualAllocationCreateFlags
source§fn bitor(self, other: VirtualAllocationCreateFlags) -> Self
fn bitor(self, other: VirtualAllocationCreateFlags) -> Self
Returns the union of the two sets of flags.
§type Output = VirtualAllocationCreateFlags
type Output = VirtualAllocationCreateFlags
|
operator.source§impl BitOrAssign<VirtualAllocationCreateFlags> for VirtualAllocationCreateFlags
impl BitOrAssign<VirtualAllocationCreateFlags> for VirtualAllocationCreateFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXorAssign<VirtualAllocationCreateFlags> for VirtualAllocationCreateFlags
impl BitXorAssign<VirtualAllocationCreateFlags> for VirtualAllocationCreateFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for VirtualAllocationCreateFlags
impl Clone for VirtualAllocationCreateFlags
source§fn clone(&self) -> VirtualAllocationCreateFlags
fn clone(&self) -> VirtualAllocationCreateFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for VirtualAllocationCreateFlags
impl Debug for VirtualAllocationCreateFlags
source§impl Extend<VirtualAllocationCreateFlags> for VirtualAllocationCreateFlags
impl Extend<VirtualAllocationCreateFlags> for VirtualAllocationCreateFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
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 FromIterator<VirtualAllocationCreateFlags> for VirtualAllocationCreateFlags
impl FromIterator<VirtualAllocationCreateFlags> for VirtualAllocationCreateFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for VirtualAllocationCreateFlags
impl Hash for VirtualAllocationCreateFlags
source§impl Not for VirtualAllocationCreateFlags
impl Not for VirtualAllocationCreateFlags
source§impl Octal for VirtualAllocationCreateFlags
impl Octal for VirtualAllocationCreateFlags
source§impl Ord for VirtualAllocationCreateFlags
impl Ord for VirtualAllocationCreateFlags
source§fn cmp(&self, other: &VirtualAllocationCreateFlags) -> Ordering
fn cmp(&self, other: &VirtualAllocationCreateFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<VirtualAllocationCreateFlags> for VirtualAllocationCreateFlags
impl PartialEq<VirtualAllocationCreateFlags> for VirtualAllocationCreateFlags
source§fn eq(&self, other: &VirtualAllocationCreateFlags) -> bool
fn eq(&self, other: &VirtualAllocationCreateFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<VirtualAllocationCreateFlags> for VirtualAllocationCreateFlags
impl PartialOrd<VirtualAllocationCreateFlags> for VirtualAllocationCreateFlags
source§fn partial_cmp(&self, other: &VirtualAllocationCreateFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &VirtualAllocationCreateFlags) -> 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 SubAssign<VirtualAllocationCreateFlags> for VirtualAllocationCreateFlags
impl SubAssign<VirtualAllocationCreateFlags> for VirtualAllocationCreateFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.