vkCmdDecompressMemoryEXT(3)

Name

vkCmdDecompressMemoryEXT - Decompress data between memory regions

C Specification

To decompress memory containing compressed data, call:

// Provided by VK_EXT_memory_decompression
void vkCmdDecompressMemoryEXT(
    VkCommandBuffer                             commandBuffer,
    const VkDecompressMemoryInfoEXT*            pDecompressMemoryInfoEXT);

Parameters

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

  • pDecompressMemoryInfoEXT is a pointer to a VkDecompressMemoryInfoEXT structure describing the decompression parameters.

Description

Valid Usage
  • VUID-vkCmdDecompressMemoryEXT-memoryDecompression-11761
    The memoryDecompression feature must be enabled

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

  • VUID-vkCmdDecompressMemoryEXT-pDecompressMemoryInfoEXT-parameter
    pDecompressMemoryInfoEXT must be a valid pointer to a valid VkDecompressMemoryInfoEXT structure

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

  • VUID-vkCmdDecompressMemoryEXT-commandBuffer-cmdpool
    The VkCommandPool that commandBuffer was allocated from must support VK_QUEUE_COMPUTE_BIT, or VK_QUEUE_GRAPHICS_BIT operations

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

  • VUID-vkCmdDecompressMemoryEXT-suspended
    This command must not be called between suspended render pass instances

  • VUID-vkCmdDecompressMemoryEXT-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

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

Primary
Secondary

Outside

Outside

VK_QUEUE_COMPUTE_BIT
VK_QUEUE_GRAPHICS_BIT

Action

Conditional Rendering

vkCmdDecompressMemoryEXT is not affected by conditional rendering

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.