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

59 lines
1.3 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/
vkCmdDispatch(3)
================
Name
----
vkCmdDispatch - Dispatch compute work items.
C Specification
---------------
// refBegin vkCmdDispatch Dispatch compute work items.
To record a dispatch, call:
include::../protos/vkCmdDispatch.txt[]
Parameters
----------
* pname:commandBuffer is the command buffer into which the command will be
recorded.
* pname:x is the number of local workgroups to dispatch in the X dimension.
* pname:y is the number of local workgroups to dispatch in the Y dimension.
* pname:z is the number of local workgroups to dispatch in the Z dimension.
Description
-----------
When the command is executed, a global workgroup consisting of
latexmath:[$x \times y \times z$] local workgroups is assembled.
include::../validity/protos/vkCmdDispatch.txt[]
See Also
--------
slink:VkCommandBuffer
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkCmdDispatch
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]