mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-01-31 08:36:26 +00:00
e2d981c029
* Bump API patch number and header version number to 20 for this
update.
Github Issues:
* Replaced existing reference pages by text automatically extracted
from the specification source, or generated from vk.xml in some
cases. This isn't a complete solution for the reference pages, but
puts them in a much better state. The ref pages (only) are now
placed under a CC BY open source license, which is more current than
the obsolete license previously used.
Further improvements to the pages should not edit them directly, but
instead concentrate on the specification source from which the ref
pages are being extracted (public issues 44, 55, 160; internal issue
389).
78 lines
2.7 KiB
Plaintext
78 lines
2.7 KiB
Plaintext
// Copyright (c) 2014-2016 Khronos Group. This work is licensed under a
|
|
// Creative Commons Attribution 4.0 International License; see
|
|
// http://creativecommons.org/licenses/by/4.0/
|
|
|
|
VkCommandPoolCreateInfo(3)
|
|
==========================
|
|
|
|
Name
|
|
----
|
|
VkCommandPoolCreateInfo - Structure specifying parameters of a newly created command pool
|
|
|
|
C Specification
|
|
---------------
|
|
|
|
// refBegin VkCommandPoolCreateInfo - Structure specifying parameters of a newly created command pool
|
|
|
|
The sname:VkCommandPoolCreateInfo structure is defined as:
|
|
|
|
include::../structs/VkCommandPoolCreateInfo.txt[]
|
|
|
|
|
|
Members
|
|
-------
|
|
|
|
* pname:sType is the type of this structure.
|
|
* pname:pNext is `NULL` or a pointer to an extension-specific structure.
|
|
* pname:flags is a bitmask indicating usage behavior for the pool and
|
|
command buffers allocated from it. Bits which can: be set include:
|
|
+
|
|
--
|
|
// refBegin VkCommandPoolCreateFlagBits - Bitmask specifying usage behavior for a command pool
|
|
include::../enums/VkCommandPoolCreateFlagBits.txt[]
|
|
--
|
|
+
|
|
** ename:VK_COMMAND_POOL_CREATE_TRANSIENT_BIT indicates 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.
|
|
** ename:VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT controls whether
|
|
command buffers allocated from the pool can: be individually reset. If
|
|
this flag is set, individual command buffers allocated from the pool can:
|
|
be reset either explicitly, by calling fname:vkResetCommandBuffer, or
|
|
implicitly, by calling fname:vkBeginCommandBuffer on an executable
|
|
command buffer. If this flag is not set, then fname:vkResetCommandBuffer
|
|
and fname:vkBeginCommandBuffer (on an executable command buffer) mustnot:
|
|
be called on the command buffers allocated from the pool, and they can:
|
|
only be reset in bulk by calling fname:vkResetCommandPool.
|
|
* pname:queueFamilyIndex designates a queue family as described in section
|
|
<<devsandqueues-queueprops,Queue Family Properties>>. All command
|
|
buffers created from this command pool must: be submitted on queues
|
|
from the same queue family.
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
include::../validity/structs/VkCommandPoolCreateInfo.txt[]
|
|
|
|
|
|
See Also
|
|
--------
|
|
|
|
elink:VkCommandPoolCreateFlags, elink:VkStructureType, flink:vkCreateCommandPool
|
|
|
|
|
|
Document Notes
|
|
--------------
|
|
|
|
For more information, see the Vulkan Specification at URL
|
|
|
|
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#VkCommandPoolCreateInfo
|
|
|
|
This page is extracted from the Vulkan Specification.
|
|
Fixes and changes should be made to the Specification,not directly.
|
|
|
|
include::footer.txt[]
|
|
|