Struct vma::AllocatorPoolCreateFlags
source · pub struct AllocatorPoolCreateFlags { /* private fields */ }
Expand description
Flags for configuring AllocatorPool
construction.
Implementations§
source§impl AllocatorPoolCreateFlags
impl AllocatorPoolCreateFlags
sourcepub const IGNORE_BUFFER_IMAGE_GRANULARITY: Self = _
pub const IGNORE_BUFFER_IMAGE_GRANULARITY: Self = _
Use this flag if you always allocate only buffers and linear images or only optimal images out of this pool and so buffer-image granularity can be ignored.
This is an optional optimization flag.
If you always allocate using Allocator::create_buffer
, Allocator::create_image
,
Allocator::allocate_memory_for_buffer
, then you don’t need to use it because allocator
knows exact type of your allocations so it can handle buffer-image granularity
in the optimal way.
If you also allocate using Allocator::allocate_memory_for_image
or Allocator::allocate_memory
,
exact type of such allocations is not known, so allocator must be conservative
in handling buffer-image granularity, which can lead to suboptimal allocation
(wasted memory). In that case, if you can make sure you always allocate only
buffers and linear images or only optimal images out of this pool, use this flag
to make allocator disregard buffer-image granularity and so make allocations
faster and more optimal.
sourcepub const LINEAR_ALGORITHM: Self = _
pub const LINEAR_ALGORITHM: Self = _
Enables alternative, linear allocation algorithm in this pool.
Specify this flag to enable linear allocation algorithm, which always creates new allocations after last one and doesn’t reuse space from allocations freed in between. It trades memory consumption for simplified algorithm and data structure, which has better performance and uses less memory for metadata.
By using this flag, you can achieve behavior of free-at-once, stack, ring buffer, and double stack.
When using this flag, you must specify PoolCreateInfo::max_block_count == 1 (or 0 for default).
sourcepub const ALGORITHM_MASK: Self = _
pub const ALGORITHM_MASK: Self = _
Bit mask to extract only *_ALGORITHM
bits from entire set of flags.
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 Binary for AllocatorPoolCreateFlags
impl Binary for AllocatorPoolCreateFlags
source§impl BitAndAssign<AllocatorPoolCreateFlags> for AllocatorPoolCreateFlags
impl BitAndAssign<AllocatorPoolCreateFlags> for AllocatorPoolCreateFlags
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<AllocatorPoolCreateFlags> for AllocatorPoolCreateFlags
impl BitOr<AllocatorPoolCreateFlags> for AllocatorPoolCreateFlags
source§fn bitor(self, other: AllocatorPoolCreateFlags) -> Self
fn bitor(self, other: AllocatorPoolCreateFlags) -> Self
Returns the union of the two sets of flags.
§type Output = AllocatorPoolCreateFlags
type Output = AllocatorPoolCreateFlags
|
operator.source§impl BitOrAssign<AllocatorPoolCreateFlags> for AllocatorPoolCreateFlags
impl BitOrAssign<AllocatorPoolCreateFlags> for AllocatorPoolCreateFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXorAssign<AllocatorPoolCreateFlags> for AllocatorPoolCreateFlags
impl BitXorAssign<AllocatorPoolCreateFlags> for AllocatorPoolCreateFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for AllocatorPoolCreateFlags
impl Clone for AllocatorPoolCreateFlags
source§fn clone(&self) -> AllocatorPoolCreateFlags
fn clone(&self) -> AllocatorPoolCreateFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for AllocatorPoolCreateFlags
impl Debug for AllocatorPoolCreateFlags
source§impl Extend<AllocatorPoolCreateFlags> for AllocatorPoolCreateFlags
impl Extend<AllocatorPoolCreateFlags> for AllocatorPoolCreateFlags
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<AllocatorPoolCreateFlags> for AllocatorPoolCreateFlags
impl FromIterator<AllocatorPoolCreateFlags> for AllocatorPoolCreateFlags
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 AllocatorPoolCreateFlags
impl Hash for AllocatorPoolCreateFlags
source§impl LowerHex for AllocatorPoolCreateFlags
impl LowerHex for AllocatorPoolCreateFlags
source§impl Not for AllocatorPoolCreateFlags
impl Not for AllocatorPoolCreateFlags
source§impl Octal for AllocatorPoolCreateFlags
impl Octal for AllocatorPoolCreateFlags
source§impl Ord for AllocatorPoolCreateFlags
impl Ord for AllocatorPoolCreateFlags
source§fn cmp(&self, other: &AllocatorPoolCreateFlags) -> Ordering
fn cmp(&self, other: &AllocatorPoolCreateFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<AllocatorPoolCreateFlags> for AllocatorPoolCreateFlags
impl PartialEq<AllocatorPoolCreateFlags> for AllocatorPoolCreateFlags
source§fn eq(&self, other: &AllocatorPoolCreateFlags) -> bool
fn eq(&self, other: &AllocatorPoolCreateFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<AllocatorPoolCreateFlags> for AllocatorPoolCreateFlags
impl PartialOrd<AllocatorPoolCreateFlags> for AllocatorPoolCreateFlags
source§fn partial_cmp(&self, other: &AllocatorPoolCreateFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &AllocatorPoolCreateFlags) -> 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<AllocatorPoolCreateFlags> for AllocatorPoolCreateFlags
impl SubAssign<AllocatorPoolCreateFlags> for AllocatorPoolCreateFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.