Struct PoolCreateInfo

pub struct PoolCreateInfo<'a> {
    pub memory_type_index: u32,
    pub flags: AllocatorPoolCreateFlags,
    pub block_size: DeviceSize,
    pub min_block_count: usize,
    pub max_block_count: usize,
    pub priority: f32,
    pub min_allocation_alignment: DeviceSize,
    pub memory_allocate_next: *const c_void,
    pub _marker: PhantomData<&'a mut ()>,
}

Fields

memory_type_index: u32

Vulkan memory type index to allocate this pool from.

flags: AllocatorPoolCreateFlags

block_size: DeviceSize

Size of a single vk::DeviceMemory block to be allocated as part of this pool, in bytes. Optional. Specify nonzero to set explicit, constant size of memory blocks used by this pool. Leave 0 to use default and let the library manage block sizes automatically. Sizes of particular blocks may vary. In this case, the pool will also support dedicated allocations.

min_block_count: usize

Minimum number of blocks to be always allocated in this pool, even if they stay empty. Set to 0 to have no preallocated blocks and allow the pool be completely empty.

max_block_count: usize

Maximum number of blocks that can be allocated in this pool. Optional. Set to 0 to use default, which is usize::MAX, which means no limit. Set to same value as VmaPoolCreateInfo::minBlockCount to have fixed amount of memory allocated throughout whole lifetime of this pool.

priority: f32

A floating-point value between 0 and 1, indicating the priority of the allocations in this pool relative to other memory allocations. It is used only when #VMA_ALLOCATOR_CREATE_EXT_MEMORY_PRIORITY_BIT flag was used during creation of the #VmaAllocator object. Otherwise, this variable is ignored.

min_allocation_alignment: DeviceSize

Additional minimum alignment to be used for all allocations created from this pool. Can be 0. Leave 0 (default) not to impose any additional alignment. If not 0, it must be a power of two. It can be useful in cases where alignment returned by Vulkan by functions like vkGetBufferMemoryRequirements is not enough, e.g. when doing interop with OpenGL.

memory_allocate_next: *const c_void

Additional pNext chain to be attached to VkMemoryAllocateInfo used for every allocation made by this pool. Optional. If not null, it must point to a pNext chain of structures that can be attached to VkMemoryAllocateInfo. It can be useful for special needs such as adding VkExportMemoryAllocateInfoKHR. Structures pointed by this member must remain alive and unchanged for the whole lifetime of the custom pool. Please note that some structures, e.g. VkMemoryPriorityAllocateInfoEXT, VkMemoryDedicatedAllocateInfoKHR, can be attached automatically by this library when using other, more convenient of its features.

_marker: PhantomData<&'a mut ()>

Implementations

impl<'a> PoolCreateInfo<'a>

pub fn push_next<T: ExtendsMemoryAllocateInfo>(&mut self, next: &'a mut T)

Trait Implementations

impl<'a> Clone for PoolCreateInfo<'a>

fn clone(&self) -> PoolCreateInfo<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for PoolCreateInfo<'_>

fn default() -> Self

Returns the “default value” for a type.