VkDecompressMemoryInfoEXT(3)

Name

VkDecompressMemoryInfoEXT - Structure specifying decompression memory info

C Specification

The VkDecompressMemoryInfoEXT structure is defined as:

// Provided by VK_EXT_memory_decompression
typedef struct VkDecompressMemoryInfoEXT {
    VkStructureType                        sType;
    const void*                            pNext;
    VkMemoryDecompressionMethodFlagsEXT    decompressionMethod;
    uint32_t                               regionCount;
    const VkDecompressMemoryRegionEXT*     pRegions;
} VkDecompressMemoryInfoEXT;

Members

  • sType is a VkStructureType value identifying this structure.

  • pNext is NULL or a pointer to a structure extending this structure.

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

  • regionCount is the number of regions to decompress.

  • pRegions is a pointer to an array of VkDecompressMemoryRegionEXT structures specifying the regions to decompress.

Description

Each memory region specified in pRegions is decompressed from the source to the destination address based on the decompression method specified in decompressionMethod. If any of the specified source and destination regions overlap in memory, then the results of decompression are undefined.

Valid Usage

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

  • VUID-VkDecompressMemoryInfoEXT-decompressionMethod-11762
    If decompressionMethod is VK_MEMORY_DECOMPRESSION_METHOD_GDEFLATE_1_0_BIT_EXT, then for each element of pRegions, decompressedSize must be less than or equal to 65536 bytes

  • VUID-VkDecompressMemoryInfoEXT-decompressionMethod-11763
    decompressionMethod must be a valid bit specified in VkPhysicalDeviceMemoryDecompressionPropertiesEXT::decompressionMethods

Valid Usage (Implicit)

  • VUID-VkDecompressMemoryInfoEXT-sType-sType
    sType must be VK_STRUCTURE_TYPE_DECOMPRESS_MEMORY_INFO_EXT

  • VUID-VkDecompressMemoryInfoEXT-pNext-pNext
    pNext must be NULL

  • VUID-VkDecompressMemoryInfoEXT-decompressionMethod-parameter
    decompressionMethod must be a valid combination of VkMemoryDecompressionMethodFlagBitsEXT values

  • VUID-VkDecompressMemoryInfoEXT-decompressionMethod-requiredbitmask
    decompressionMethod must not be 0

  • VUID-VkDecompressMemoryInfoEXT-pRegions-parameter
    pRegions must be a valid pointer to an array of regionCount VkDecompressMemoryRegionEXT structures

  • VUID-VkDecompressMemoryInfoEXT-regionCount-arraylength
    regionCount must be greater than 0

See Also

VK_EXT_memory_decompression, VkDecompressMemoryRegionEXT, VkMemoryDecompressionMethodFlagsEXT, VkStructureType, vkCmdDecompressMemoryEXT

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.