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

67 lines
1.8 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/
vkCmdDrawIndirect(3)
====================
Name
----
vkCmdDrawIndirect - Issue an indirect draw into a command buffer.
C Specification
---------------
// refBegin vkCmdDrawIndirect Issue an indirect draw into a command buffer.
To record a non-indexed indirect draw, call:
include::../api/protos/vkCmdDrawIndirect.txt[]
Parameters
----------
* pname:commandBuffer is the command buffer into which the command is
recorded.
* pname:buffer is the buffer containing draw parameters.
* pname:offset is the byte offset into pname:buffer where parameters
begin.
* pname:drawCount is the number of draws to execute, and can: be zero.
* pname:stride is the byte stride between successive sets of draw
parameters.
Description
-----------
fname:vkCmdDrawIndirect behaves similarly to flink:vkCmdDraw except that the
parameters are read by the device from a buffer during execution.
pname:drawCount draws are executed by the command, with parameters taken
from pname:buffer starting at pname:offset and increasing by pname:stride
bytes for each successive draw. The parameters of each draw are encoded in
an array of slink:VkDrawIndirectCommand structures. If pname:drawCount is
less than or equal to one, pname:stride is ignored.
include::../validity/protos/vkCmdDrawIndirect.txt[]
See Also
--------
slink:VkBuffer, slink:VkCommandBuffer, basetype:VkDeviceSize
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkCmdDrawIndirect
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]