vkCmdDecompressMemoryNV(3)

# vkCmdDecompressMemoryNV(3) Manual Page

## Name

vkCmdDecompressMemoryNV - Decompress data between memory regions

Loading… please wait.

## C Specification

To decompress data between one or more memory regions call:

    // Provided by VK_NV_memory_decompression
    void vkCmdDecompressMemoryNV(
        VkCommandBuffer                             commandBuffer,
        uint32_t                                    decompressRegionCount,
        const VkDecompressMemoryRegionNV*           pDecompressMemoryRegions);

## Parameters

- `commandBuffer` is the command buffer into which the command will be recorded.

- `decompressRegionCount` is the number of memory regions to decompress.

- `pDecompressMemoryRegions` is a pointer to an array of `decompressRegionCount` VkDecompressMemoryRegionNV structures specifying decompression parameters.

## Description

Each region specified in `pDecompressMemoryRegions` is decompressed from the source to destination region based on the specified decompression method.

Valid Usage

- VUID-vkCmdDecompressMemoryNV-None-07684
  The `memoryDecompression` feature must be enabled

Valid Usage (Implicit)

- VUID-vkCmdDecompressMemoryNV-commandBuffer-parameter
  `commandBuffer` must be a valid VkCommandBuffer handle

- VUID-vkCmdDecompressMemoryNV-pDecompressMemoryRegions-parameter
  `pDecompressMemoryRegions` must be a valid pointer to an array of `decompressRegionCount` valid VkDecompressMemoryRegionNV structures

- VUID-vkCmdDecompressMemoryNV-commandBuffer-recording
  `commandBuffer` must be in the recording state

- VUID-vkCmdDecompressMemoryNV-commandBuffer-cmdpool
  The `VkCommandPool` that `commandBuffer` was allocated from must support graphics, or compute operations

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

- VUID-vkCmdDecompressMemoryNV-videocoding
  This command must only be called outside of a video coding scope

- VUID-vkCmdDecompressMemoryNV-decompressRegionCount-arraylength
  `decompressRegionCount` must be greater than `0`

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 | Graphics Compute | Action

## See Also

VK_NV_memory_decompression, VkCommandBuffer, VkDecompressMemoryRegionNV

## 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

Copyright 2014-2023 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0