VkDecompressMemoryRegionNV(3)

Name

VkDecompressMemoryRegionNV - Structure specifying decompression region parameters

C Specification

The VkDecompressMemoryRegionNV structure is defined as:

// Provided by VK_NV_memory_decompression
typedef struct VkDecompressMemoryRegionNV {
    VkDeviceAddress                       srcAddress;
    VkDeviceAddress                       dstAddress;
    VkDeviceSize                          compressedSize;
    VkDeviceSize                          decompressedSize;
    VkMemoryDecompressionMethodFlagsNV    decompressionMethod;
} VkDecompressMemoryRegionNV;

Members

  • srcAddress is the address where compressed data is stored.

  • dstAddress is the destination address where decompressed data will be written.

  • compressedSize is the size of compressed data in bytes.

  • decompressedSize is the size of decompressed data in bytes.

  • decompressionMethod is a bitmask of VkMemoryDecompressionMethodFlagBitsNV with a single bit set specifying the method used to decompress data.

Description

Valid Usage

  • VUID-VkDecompressMemoryRegionNV-decompressionMethod-07690
    The decompressionMethod must have a single bit set

  • VUID-VkDecompressMemoryRegionNV-srcAddress-07685
    srcAddress must be 4 byte aligned

  • VUID-VkDecompressMemoryRegionNV-srcAddress-07686
    The memory range defined by srcAddress and compressedSize must be contained within the size of the buffer bound to srcAddress, minus the offset of srcAddress from the base address of that buffer

  • VUID-VkDecompressMemoryRegionNV-dstAddress-07687
    dstAddress must be 4 byte aligned

  • VUID-VkDecompressMemoryRegionNV-dstAddress-07688
    The memory range defined by dstAddress and decompressedSize must be contained within the size of the buffer bound to dstAddress, minus the offset of dstAddress from the base address of that buffer

  • VUID-VkDecompressMemoryRegionNV-decompressedSize-07689
    decompressedSize must be large enough to hold the decompressed data based on the decompressionMethod

  • VUID-VkDecompressMemoryRegionNV-compressedSize-11795
    compressedSize must not be zero

  • VUID-VkDecompressMemoryRegionNV-decompressedSize-11796
    decompressedSize must not be zero

  • VUID-VkDecompressMemoryRegionNV-srcAddress-07691
    The memory range defined by srcAddress and compressedSize must not overlap the memory range defined by dstAddress and decompressedSize

See Also

VK_NV_memory_decompression, VkDeviceAddress, VkDeviceSize, VkMemoryDecompressionMethodFlagsEXT, vkCmdDecompressMemoryNV

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.