Struct vma::AllocationCreateFlags

pub struct AllocationCreateFlags { /* private fields */ }

Flags for configuring Allocation construction.

Implementations

impl AllocationCreateFlags

pub const DEDICATED_MEMORY: Self = _

Set this flag if the allocation should have its own memory block.

Use it for special, big resources, like fullscreen images used as attachments.

pub const NEVER_ALLOCATE: Self = _

Set this flag to only try to allocate from existing ash::vk::DeviceMemory blocks and never create new such block.

If new allocation cannot be placed in any of the existing blocks, allocation fails with ash::vk::Result::ERROR_OUT_OF_DEVICE_MEMORY error.

You should not use AllocationCreateFlags::DEDICATED_MEMORY and AllocationCreateFlags::NEVER_ALLOCATE at the same time. It makes no sense.

pub const MAPPED: Self = _

Set this flag to use a memory that will be persistently mapped and retrieve pointer to it.

Pointer to mapped memory will be returned through Allocation::get_mapped_data().

Is it valid to use this flag for allocation made from memory type that is not ash::vk::MemoryPropertyFlags::HOST_VISIBLE. This flag is then ignored and memory is not mapped. This is useful if you need an allocation that is efficient to use on GPU (ash::vk::MemoryPropertyFlags::DEVICE_LOCAL) and still want to map it directly if possible on platforms that support it (e.g. Intel GPU).

You should not use this flag together with AllocationCreateFlags::CAN_BECOME_LOST.

pub const USER_DATA_COPY_STRING: Self = _

👎Deprecated since 0.3: Consider using vmaSetAllocationName() instead.

Set this flag to treat AllocationCreateInfo::user_data as pointer to a null-terminated string. Instead of copying pointer value, a local copy of the string is made and stored in allocation’s user data. The string is automatically freed together with the allocation. It is also used in Allocator::build_stats_string.

pub const UPPER_ADDRESS: Self = _

Allocation will be created from upper stack in a double stack pool.

This flag is only allowed for custom pools created with AllocatorPoolCreateFlags::LINEAR_ALGORITHM flag.

pub const DONT_BIND: Self = _

Create both buffer/image and allocation, but don’t bind them together. It is useful when you want to bind yourself to do some more advanced binding, e.g. using some extensions. The flag is meaningful only with functions that bind by default, such as Allocator::create_buffer or Allocator::create_image. Otherwise it is ignored.

If you want to make sure the new buffer/image is not tied to the new memory allocation through VkMemoryDedicatedAllocateInfoKHR structure in case the allocation ends up in its own memory block, use also flag #VMA_ALLOCATION_CREATE_CAN_ALIAS_BIT.

pub const WITHIN_BUDGET: Self = _

Create allocation only if additional device memory required for it, if any, won’t exceed memory budget. Otherwise return VK_ERROR_OUT_OF_DEVICE_MEMORY.

pub const CAN_ALIAS: Self = _

Set this flag if the allocated memory will have aliasing resources.

Usage of this flag prevents supplying VkMemoryDedicatedAllocateInfoKHR when #VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT is specified. Otherwise created dedicated memory will not be suitable for aliasing resources, resulting in Vulkan Validation Layer errors.

pub const HOST_ACCESS_SEQUENTIAL_WRITE: Self = _

Requests possibility to map the allocation (using vmaMapMemory() or #VMA_ALLOCATION_CREATE_MAPPED_BIT).

• If you use #VMA_MEMORY_USAGE_AUTO or other VMA_MEMORY_USAGE_AUTO* value, you must use this flag to be able to map the allocation. Otherwise, mapping is incorrect.
• If you use other value of #VmaMemoryUsage, this flag is ignored and mapping is always possible in memory types that are HOST_VISIBLE. This includes allocations created in custom_memory_pools.

Declares that mapped memory will only be written sequentially, e.g. using memcpy() or a loop writing number-by-number, never read or accessed randomly, so a memory type can be selected that is uncached and write-combined.

Violating this declaration may work correctly, but will likely be very slow. Watch out for implicit reads introduced by doing e.g. pMappedData[i] += x; Better prepare your data in a local variable and memcpy() it to the mapped pointer all at once.

pub const HOST_ACCESS_RANDOM: Self = _

Requests possibility to map the allocation (using vmaMapMemory() or #VMA_ALLOCATION_CREATE_MAPPED_BIT).

• If you use #VMA_MEMORY_USAGE_AUTO or other VMA_MEMORY_USAGE_AUTO* value, you must use this flag to be able to map the allocation. Otherwise, mapping is incorrect.
• If you use other value of #VmaMemoryUsage, this flag is ignored and mapping is always possible in memory types that are HOST_VISIBLE. This includes allocations created in custom_memory_pools.

Declares that mapped memory can be read, written, and accessed in random order, so a HOST_CACHED memory type is required.

pub const HOST_ACCESS_ALLOW_TRANSFER_INSTEAD: Self = _

Together with #VMA_ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT or #VMA_ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT, it says that despite request for host access, a not-HOST_VISIBLE memory type can be selected if it may improve performance.

By using this flag, you declare that you will check if the allocation ended up in a HOST_VISIBLE memory type (e.g. using vmaGetAllocationMemoryProperties()) and if not, you will create some “staging” buffer and issue an explicit transfer to write/read your data. To prepare for this possibility, don’t forget to add appropriate flags like VK_BUFFER_USAGE_TRANSFER_DST_BIT, VK_BUFFER_USAGE_TRANSFER_SRC_BIT to the parameters of created buffer or image.

pub const STRATEGY_MIN_MEMORY: Self = _

Allocation strategy that chooses smallest possible free range for the allocation to minimize memory usage and fragmentation, possibly at the expense of allocation time.

pub const STRATEGY_BEST_FIT: Self = _

Alias to STRATEGY_MIN_MEMORY.

pub const STRATEGY_MIN_TIME: Self = _

Allocation strategy that chooses first suitable free range for the allocation - not necessarily in terms of the smallest offset but the one that is easiest and fastest to find to minimize allocation time, possibly at the expense of allocation quality.

pub const STRATEGY_FIRST_FIT: Self = _

Alias to STRATEGY_MIN_TIME.

pub const STRATEGY_MIN_OFFSET: Self = _

Allocation strategy that chooses always the lowest offset in available space. This is not the most efficient strategy but achieves highly packed data. Used internally by defragmentation, not recomended in typical usage.

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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.

pub const fn from_bits_truncate(bits: u32) -> Self

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

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.

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

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.

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.

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.

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.

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

impl Binary for AllocationCreateFlags

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

Formats the value using the given formatter.

impl BitAnd<AllocationCreateFlags> for AllocationCreateFlags

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

Returns the intersection between the two sets of flags.

type Output = AllocationCreateFlags

The resulting type after applying the & operator.

impl BitAndAssign<AllocationCreateFlags> for AllocationCreateFlags

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<AllocationCreateFlags> for AllocationCreateFlags

fn bitor(self, other: AllocationCreateFlags) -> Self

Returns the union of the two sets of flags.

type Output = AllocationCreateFlags

The resulting type after applying the | operator.

impl BitOrAssign<AllocationCreateFlags> for AllocationCreateFlags

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<AllocationCreateFlags> for AllocationCreateFlags

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

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

type Output = AllocationCreateFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<AllocationCreateFlags> for AllocationCreateFlags

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for AllocationCreateFlags

fn clone(&self) -> AllocationCreateFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AllocationCreateFlags

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

Formats the value using the given formatter.

impl Extend<AllocationCreateFlags> for AllocationCreateFlags

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

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<AllocationCreateFlags> for AllocationCreateFlags

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

Creates a value from an iterator.

impl Hash for AllocationCreateFlags

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for AllocationCreateFlags

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

Formats the value using the given formatter.

impl Not for AllocationCreateFlags

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = AllocationCreateFlags

The resulting type after applying the ! operator.

impl Octal for AllocationCreateFlags

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

Formats the value using the given formatter.

impl Ord for AllocationCreateFlags

fn cmp(&self, other: &AllocationCreateFlags) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<AllocationCreateFlags> for AllocationCreateFlags

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<AllocationCreateFlags> for AllocationCreateFlags

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

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

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

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

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

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

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

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

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 Sub<AllocationCreateFlags> for AllocationCreateFlags

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

Returns the set difference of the two sets of flags.

type Output = AllocationCreateFlags

The resulting type after applying the - operator.

impl SubAssign<AllocationCreateFlags> for AllocationCreateFlags

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for AllocationCreateFlags

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

Formats the value using the given formatter.

impl Copy for AllocationCreateFlags

impl Eq for AllocationCreateFlags

impl StructuralEq for AllocationCreateFlags

impl StructuralPartialEq for AllocationCreateFlags