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

63 lines
1.6 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/
vkCmdPushConstants(3)
=====================
Name
----
vkCmdPushConstants - Update the values of push constants.
C Specification
---------------
// refBegin vkCmdPushConstants Update the values of push constants.
To update push constants, call:
include::../api/protos/vkCmdPushConstants.txt[]
Parameters
----------
* pname:commandBuffer is the command buffer in which the push constant
update will be recorded.
* pname:layout is the pipeline layout used to program the push constant
updates.
* pname:stageFlags is a bitmask of elink:VkShaderStageFlagBits specifying
the shader stages that will use the push constants in the updated range.
* pname:offset is the start offset of the push constant range to update,
in units of bytes.
* pname:size is the size of the push constant range to update, in units of
bytes.
* pname:pValues is an array of pname:size bytes containing the new push
constant values.
Description
-----------
include::../validity/protos/vkCmdPushConstants.txt[]
See Also
--------
slink:VkCommandBuffer, slink:VkPipelineLayout, elink:VkShaderStageFlags
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkCmdPushConstants
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]