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

79 lines
2.2 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/
vkCmdBindPipeline(3)
====================
Name
----
vkCmdBindPipeline - Bind a pipeline object to a command buffer.
C Specification
---------------
// refBegin vkCmdBindPipeline Bind a pipeline object to a command buffer.
Once a pipeline has been created, it can: be bound to the command buffer
using the command:
include::../api/protos/vkCmdBindPipeline.txt[]
Parameters
----------
* pname:commandBuffer is the command buffer that the pipeline will be
bound to.
* pname:pipelineBindPoint specifies the bind point, and must: have one of
the values
+
--
// refBegin VkPipelineBindPoint - specify the bind point of a pipeline object to a command buffer
include::../api/enums/VkPipelineBindPoint.txt[]
--
+
specifying whether pname:pipeline will be bound as a compute
(ename:VK_PIPELINE_BIND_POINT_COMPUTE) or graphics
(ename:VK_PIPELINE_BIND_POINT_GRAPHICS) pipeline. There are separate bind
points for each of graphics and compute, so binding one does not disturb the
other.
+
* pname:pipeline is the pipeline to be bound.
Description
-----------
Once bound, a pipeline binding affects subsequent graphics or compute
commands in the command buffer until a different pipeline is bound to the
bind point. The pipeline bound to ename:VK_PIPELINE_BIND_POINT_COMPUTE
controls the behavior of flink:vkCmdDispatch and
flink:vkCmdDispatchIndirect. The pipeline bound to
ename:VK_PIPELINE_BIND_POINT_GRAPHICS controls the behavior of
flink:vkCmdDraw, flink:vkCmdDrawIndexed, flink:vkCmdDrawIndirect, and
flink:vkCmdDrawIndexedIndirect. No other commands are affected by the
pipeline state.
include::../validity/protos/vkCmdBindPipeline.txt[]
See Also
--------
slink:VkCommandBuffer, slink:VkPipeline, elink:VkPipelineBindPoint
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkCmdBindPipeline
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]