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

63 lines
1.5 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/
vkCmdBindIndexBuffer(3)
=======================
Name
----
vkCmdBindIndexBuffer - Bind an index buffer to a command buffer.
C Specification
---------------
// refBegin vkCmdBindIndexBuffer Bind an index buffer to a command buffer.
To bind an index buffer to a command buffer, call:
include::../protos/vkCmdBindIndexBuffer.txt[]
Parameters
----------
* pname:commandBuffer is the command buffer into which the command is
recorded.
* pname:buffer is the buffer being bound.
* pname:offset is the starting offset in bytes within pname:buffer used in
index buffer address calculations.
* pname:indexType selects whether indices are treated as 16 bits or 32
bits. Possible values include:
+
--
// refBegin VkIndexType - type of index buffer indices
include::../enums/VkIndexType.txt[]
--
Description
-----------
include::../validity/protos/vkCmdBindIndexBuffer.txt[]
See Also
--------
slink:VkBuffer, slink:VkCommandBuffer, basetype:VkDeviceSize, elink:VkIndexType
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkCmdBindIndexBuffer
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]