C Specification

To refresh a list of objects as a pipelined operation, call:

// Provided by VK_KHR_object_refresh
void vkCmdRefreshObjectsKHR(
    VkCommandBuffer                             commandBuffer,
    const VkRefreshObjectListKHR*               pRefreshObjects);

Parameters

  • commandBuffer is the command buffer into which the command will be recorded.

  • pRefreshObjects is a pointer to a VkRefreshObjectListKHR structure specifying the list of objects to refresh.

Description

The access scope for object refreshes falls under the VK_ACCESS_TRANSFER_WRITE_BIT, and the pipeline stages for identifying the synchronization scope must include VK_PIPELINE_STAGE_TRANSFER_BIT.

Note

If an implementation does not store a supplied object’s internal data in SEU-susceptible memory, it may ignore the refresh command for that object.

Valid Usage (Implicit)
  • VUID-vkCmdRefreshObjectsKHR-commandBuffer-parameter
    commandBuffer must be a valid VkCommandBuffer handle

  • VUID-vkCmdRefreshObjectsKHR-pRefreshObjects-parameter
    pRefreshObjects must be a valid pointer to a valid VkRefreshObjectListKHR structure

  • VUID-vkCmdRefreshObjectsKHR-commandBuffer-recording
    commandBuffer must be in the recording state

  • VUID-vkCmdRefreshObjectsKHR-commandBuffer-cmdpool
    The VkCommandPool that commandBuffer was allocated from must support graphics, compute, or transfer operations

  • VUID-vkCmdRefreshObjectsKHR-renderpass
    This command must only be called outside of a render pass instance

Host Synchronization
  • Host access to commandBuffer must be externally synchronized

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

Command Properties
Command Buffer Levels Render Pass Scope Supported Queue Types Command Type

Primary
Secondary

Outside

Graphics
Compute
Transfer

Action

See Also

Document Notes

For more information, see the Vulkan Specification

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.

Copyright 2014-2023 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0