Vulkan-Docs/doc/specs/vulkan/man/VkSubmitInfo.txt

74 lines
2.4 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/
VkSubmitInfo(3)
===============
Name
----
VkSubmitInfo - Structure specifying a queue submit operation
C Specification
---------------
// refBegin VkSubmitInfo - Structure specifying a queue submit operation
The sname:VkSubmitInfo structure is defined as:
include::../structs/VkSubmitInfo.txt[]
Members
-------
* pname:sType is the type of this structure.
* pname:pNext is `NULL` or a pointer to an extension-specific structure.
* pname:waitSemaphoreCount is the number of semaphores upon which
to wait before executing the command buffers for the batch.
* pname:pWaitSemaphores is a pointer to an array of semaphores upon which
to wait before the command buffers for this batch begin execution. If
semaphores to wait on are provided, they define a
<<synchronization-semaphores-waiting, semaphore wait operation>>.
* pname:pWaitDstStageMask is a pointer to an array of pipeline stages at
which each corresponding semaphore wait will occur.
* pname:commandBufferCount is the number of command buffers to
execute in the batch.
* pname:pCommandBuffers is a pointer to an array of command buffers to
execute in the batch. The command buffers submitted in a batch begin
execution in the order they appear in pname:pCommandBuffers, but may:
complete out of order.
* pname:signalSemaphoreCount is the number of semaphores to be
signaled once the commands specified in pname:pCommandBuffers have
completed execution.
* pname:pSignalSemaphores is a pointer to an array of semaphores which
will be signaled when the command buffers for this batch have completed
execution. If semaphores to be signaled are provided, they define a
<<synchronization-semaphores-signaling, semaphore signal operation>>.
Description
-----------
include::../validity/structs/VkSubmitInfo.txt[]
See Also
--------
slink:VkCommandBuffer, elink:VkPipelineStageFlags, slink:VkSemaphore, elink:VkStructureType, flink:vkQueueSubmit
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#VkSubmitInfo
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]