Vulkan.Core10.CommandPool

vkCreateCommandPool - Create a new command pool object

Valid Usage

• pCreateInfo->queueFamilyIndex must be the index of a queue family available in the logical device device

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid CommandPoolCreateInfo structure

• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure

• pCommandPool must be a valid pointer to a CommandPool handle

• The device must have been created with at least 1 queue

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_DEVICE_MEMORY

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

See Also

VK_VERSION_1_0, AllocationCallbacks, CommandPool, CommandPoolCreateInfo, Device

A convenience wrapper to make a compatible pair of calls to createCommandPool and destroyCommandPool

To ensure that destroyCommandPool is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

vkDestroyCommandPool - Destroy a command pool object

Description

When a pool is destroyed, all command buffers allocated from the pool are freed.

Any primary command buffer allocated from another CommandPool that is in the recording or executable state and has a secondary command buffer allocated from commandPool recorded into it, becomes invalid.

Valid Usage

• All CommandBuffer objects allocated from commandPool must not be in the pending state

• If AllocationCallbacks were provided when commandPool was created, a compatible set of callbacks must be provided here

• If no AllocationCallbacks were provided when commandPool was created, pAllocator must be NULL

Valid Usage (Implicit)

• device must be a valid Device handle

• If commandPool is not NULL_HANDLE, commandPool must be a valid CommandPool handle

• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure

• If commandPool is a valid handle, it must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to commandPool must be externally synchronized

See Also

VK_VERSION_1_0, AllocationCallbacks, CommandPool, Device

vkResetCommandPool - Reset a command pool

Description

Resetting a command pool recycles all of the resources from all of the command buffers allocated from the command pool back to the command pool. All command buffers that have been allocated from the command pool are put in the initial state.

Any primary command buffer allocated from another CommandPool that is in the recording or executable state and has a secondary command buffer allocated from commandPool recorded into it, becomes invalid.

Valid Usage

• All CommandBuffer objects allocated from commandPool must not be in the pending state

Valid Usage (Implicit)

• device must be a valid Device handle

• commandPool must be a valid CommandPool handle

• flags must be a valid combination of CommandPoolResetFlagBits values

• commandPool must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to commandPool must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_DEVICE_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

See Also

VK_VERSION_1_0, CommandPool, CommandPoolResetFlags, Device

VkCommandPoolCreateInfo - Structure specifying parameters of a newly created command pool

Valid Usage

• If the protectedMemory feature is not enabled, the COMMAND_POOL_CREATE_PROTECTED_BIT bit of flags must not be set

• If the pNext chain includes a DataGraphProcessingEngineCreateInfoARM structure, then queueFamilyIndex must designate a queue family that supports QUEUE_DATA_GRAPH_BIT_ARM

• If the pNext chain includes a DataGraphProcessingEngineCreateInfoARM structure, each member of pProcessingEngines must be identical to QueueFamilyDataGraphPropertiesARM::engine retrieved from getPhysicalDeviceQueueFamilyDataGraphPropertiesARM with queueFamilyIndex and the physicalDevice that was used to create device

• If queueFamilyIndex designates a queue family that supports QUEUE_DATA_GRAPH_BIT_ARM and enumerates a foreign engine through getPhysicalDeviceQueueFamilyDataGraphPropertiesARM with type PHYSICAL_DEVICE_DATA_GRAPH_PROCESSING_ENGINE_TYPE_NEURAL_QCOM or PHYSICAL_DEVICE_DATA_GRAPH_PROCESSING_ENGINE_TYPE_COMPUTE_QCOM, the pNext chain must include DataGraphProcessingEngineCreateInfoARM with PhysicalDeviceDataGraphProcessingEngineARM::isForeign set to TRUE for all elements of pProcessingEngines

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO

• pNext must be NULL or a pointer to a valid instance of DataGraphProcessingEngineCreateInfoARM

• The sType value of each structure in the pNext chain must be unique

• flags must be a valid combination of CommandPoolCreateFlagBits values

See Also

VK_VERSION_1_0, CommandPoolCreateFlags, StructureType, createCommandPool

VkCommandPool - Opaque handle to a command pool object

See Also

VK_DEFINE_NON_DISPATCHABLE_HANDLE, VK_VERSION_1_0, CommandBufferAllocateInfo, createCommandPool, destroyCommandPool, freeCommandBuffers, resetCommandPool, trimCommandPool, trimCommandPool

VkCommandPoolCreateFlagBits - Bitmask specifying usage behavior for a command pool

Description

• COMMAND_POOL_CREATE_TRANSIENT_BIT specifies that command buffers allocated from the pool will be short-lived, meaning that they will be reset or freed in a relatively short timeframe. This flag may be used by the implementation to control memory allocation behavior within the pool.

• COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT allows any command buffer allocated from a pool to be individually reset to the initial state; either by calling resetCommandBuffer, or via the implicit reset when calling beginCommandBuffer. If this flag is not set on a pool, then resetCommandBuffer must not be called for any command buffer allocated from that pool.

• COMMAND_POOL_CREATE_PROTECTED_BIT specifies that command buffers allocated from the pool are protected command buffers.

See Also

VK_VERSION_1_0, CommandPoolCreateFlags

VkCommandPoolResetFlagBits - Bitmask controlling behavior of a command pool reset

Description

• COMMAND_POOL_RESET_RELEASE_RESOURCES_BIT specifies that resetting a command pool recycles all of the resources from the command pool back to the system.

See Also

VK_VERSION_1_0, CommandPoolResetFlags