vkCmdPushDataEXT(3)

Name

vkCmdPushDataEXT - Update the values of push data

C Specification

To update push data when using descriptor heaps, call:

// Provided by VK_EXT_descriptor_heap
void vkCmdPushDataEXT(
    VkCommandBuffer                             commandBuffer,
    const VkPushDataInfoEXT*                    pPushDataInfo);

Parameters

commandBuffer is the command buffer in which the push data update will be recorded.
pPushDataInfo is a pointer to a VkPushDataInfoEXT structure.

Description

When vkCmdPushDataEXT is recorded, it immediately invalidates all non-heap descriptor state. Similarly, recording any non-heap descriptor state commands immediately invalidates state set by this command.

All push data is available to all shaders using the existing PushConstant Storage Class.

Device addresses in push data are intended as the fast path for shader-constant data that does not fit into push data directly. These addresses can also be mapped to an existing buffer declaration in the shader using set and binding decorations, which will be the preferred path for some implementations initially, though such implementations are expected to lean less on this mechanism over time.

Valid Usage (Implicit)

VUID-vkCmdPushDataEXT-commandBuffer-parameter
commandBuffer must be a valid VkCommandBuffer handle
VUID-vkCmdPushDataEXT-pPushDataInfo-parameter
pPushDataInfo must be a valid pointer to a valid VkPushDataInfoEXT structure
VUID-vkCmdPushDataEXT-commandBuffer-recording
commandBuffer must be in the recording state
VUID-vkCmdPushDataEXT-commandBuffer-cmdpool
The VkCommandPool that commandBuffer was allocated from must support VK_QUEUE_COMPUTE_BIT, or VK_QUEUE_GRAPHICS_BIT operations
VUID-vkCmdPushDataEXT-videocoding
This command must only be called outside of a video coding scope

Host Synchronization

Host access to commandBuffer must be externally synchronized
Host access to the VkCommandPool that commandBuffer was allocated from must be externally synchronized