vkCmdDispatch(3)
=================

Name
----
vkCmdDispatch - Dispatch compute work items.

C Specification
---------------

include::../protos/vkCmdDispatch.txt[]

Parameters
----------

pname:commandBuffer::
    Command buffer upon which to execute the command.

pname:x::
    Number of workgroups to dispatch in the X dimension.

pname:y::
    Number of workgroups to dispatch in the Y dimension.

pname:z::
    Number of workgroups to dispatch in the Z dimension.

Description
-----------

fname:vkCmdDispatch dispatches a pname:x by pname:y by pname:z group of compute workgroups.
Two- and one-dimensional work groups can be dispatched by setting the pname:z, or
pname:y and pname:z parameters to 1, respectively. The size of each workgroup is
determined by the pipeline bound to the ename:VK_PIPELINE_BIND_POINT_COMPUTE bind point
on the command buffer specified by pname:commandBuffer.

include::../validity/protos/vkCmdDispatch.txt[]

Notes
-----

Although fname:vkCmdDispatch does not generate errors or return a value, enabled
validation layers may detect possible error conditions or potentially undefined
behavior and report this via some other means.

See Also
--------

flink:vkCmdDispatchIndirect

include::footer.txt[]