Vulkan.Extensions.VK_EXT_memory_decompression

vkCmdDecompressMemoryEXT - Decompress data between memory regions

Valid Usage

• The memoryDecompression feature must be enabled

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pDecompressMemoryInfoEXT must be a valid pointer to a valid DecompressMemoryInfoEXT structure

• commandBuffer must be in the recording state

• The CommandPool that commandBuffer was allocated from must support QUEUE_COMPUTE_BIT, or QUEUE_GRAPHICS_BIT operations

• This command must only be called outside of a render pass instance

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

• 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 CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

Conditional Rendering

vkCmdDecompressMemoryEXT is not affected by conditional rendering

See Also

VK_EXT_memory_decompression, CommandBuffer, DecompressMemoryInfoEXT

vkCmdDecompressMemoryIndirectCountEXT - Indirect decompress data between memory regions

Description

Each region specified in indirectCommandsAddress is decompressed from the source to destination region based on the specified decompressionMethod.

Valid Usage

• The memoryDecompression feature must be enabled

• indirectCommandsAddress must be a device address allocated to the application from a buffer created with the BUFFER_USAGE_INDIRECT_BUFFER_BIT usage flag set

• indirectCommandsAddress must be a multiple of 4

• indirectCommandsCountAddress must be a device address allocated to the application from a buffer created with the BUFFER_USAGE_INDIRECT_BUFFER_BIT usage flag set

• indirectCommandsCountAddress must be a multiple of 4

• The count stored in indirectCommandsCountAddress must be less than or equal to PhysicalDeviceMemoryDecompressionPropertiesEXT::maxDecompressionIndirectCount

• All device addresses between indirectCommandsAddress and indirectCommandsAddress + (stride × (count stored in indirectCommandsCountAddress)) - 1 must be in the buffer device address range of the same buffer

• The decompressionMethod must have a single bit set

• stride must be a multiple of 4 and must be greater than or equal to sizeof(DecompressMemoryRegionEXT)

• maxDecompressionCount must be less than or equal to PhysicalDeviceMemoryDecompressionPropertiesEXT::maxDecompressionIndirectCount

• If decompressionMethod is MEMORY_DECOMPRESSION_METHOD_GDEFLATE_1_0_BIT_EXT, then all values in DecompressMemoryRegionEXT::decompressedSize must be less than or equal to 65536 bytes

• decompressionMethod must be a valid bit specified in PhysicalDeviceMemoryDecompressionPropertiesEXT::decompressionMethods

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• decompressionMethod must be a valid combination of MemoryDecompressionMethodFlagBitsEXT values

• decompressionMethod must not be 0

• indirectCommandsAddress must be a valid DeviceAddress value

• indirectCommandsCountAddress must be a valid DeviceAddress value

• commandBuffer must be in the recording state

• The CommandPool that commandBuffer was allocated from must support QUEUE_COMPUTE_BIT, or QUEUE_GRAPHICS_BIT operations

• This command must only be called outside of a render pass instance

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

• 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 CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

Conditional Rendering

vkCmdDecompressMemoryIndirectCountEXT is not affected by conditional rendering

See Also

VK_EXT_memory_decompression, CommandBuffer, DeviceAddress, MemoryDecompressionMethodFlagsEXT

VkPhysicalDeviceMemoryDecompressionFeaturesEXT - Structure describing if memory decompression is supported by an implementation

Members

This structure describes the following features:

Description

If the PhysicalDeviceMemoryDecompressionFeaturesEXT structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. If the application wishes to use a Device with any features described by PhysicalDeviceMemoryDecompressionFeaturesEXT, it must add an instance of the structure, with the desired feature members set to TRUE, to the pNext chain of DeviceCreateInfo when creating the Device.

Structure Chaining

Extends the structures

• DeviceCreateInfo

• PhysicalDeviceFeatures2

See Also

VK_EXT_memory_decompression, VK_NV_memory_decompression, Bool32, StructureType

VkPhysicalDeviceMemoryDecompressionPropertiesEXT - Structure describing supported memory decompression methods by an implementation

Description

If memoryDecompression feature is supported, decompressionMethods must have at least one bit set.

If the PhysicalDeviceMemoryDecompressionPropertiesEXT structure is included in the pNext chain of the PhysicalDeviceProperties2 structure passed to getPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

Structure Chaining

Extends the structure

• PhysicalDeviceProperties2

See Also

VK_EXT_memory_decompression, VK_NV_memory_decompression, MemoryDecompressionMethodFlagsEXT, StructureType

VkDecompressMemoryRegionEXT - Structure specifying decompression region

Description

Accesses to compressed and decompressed data specified in srcAddress and dstAddress must be synchronized with the PIPELINE_STAGE_2_MEMORY_DECOMPRESSION_BIT_EXT pipeline stage with access type of ACCESS_2_MEMORY_DECOMPRESSION_READ_BIT_EXT or ACCESS_2_MEMORY_DECOMPRESSION_WRITE_BIT_EXT.

Valid Usage

• srcAddress must be 4 byte aligned

• 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

• dstAddress must be 4 byte aligned

• 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

• decompressedSize must be large enough to hold the decompressed data based on the decompressionMethod

• compressedSize must not be zero

• decompressedSize must not be zero

• The memory range defined by srcAddress and compressedSize must not overlap the memory range defined by dstAddress and decompressedSize

• srcAddress must be a device address allocated to the application from a buffer created with the BUFFER_USAGE_2_MEMORY_DECOMPRESSION_BIT_EXT usage flag set

• dstAddress must be a device address allocated to the application from a buffer created with the BUFFER_USAGE_2_MEMORY_DECOMPRESSION_BIT_EXT usage flag set

Valid Usage (Implicit)

• srcAddress must be a valid DeviceAddress value

• dstAddress must be a valid DeviceAddress value

See Also

VK_EXT_memory_decompression, DecompressMemoryInfoEXT, DeviceAddress, DeviceSize

VkDecompressMemoryInfoEXT - Structure specifying decompression memory info

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

• The decompressionMethod must have a single bit set

• If decompressionMethod is MEMORY_DECOMPRESSION_METHOD_GDEFLATE_1_0_BIT_EXT, then for each element of pRegions, decompressedSize must be less than or equal to 65536 bytes

• decompressionMethod must be a valid bit specified in PhysicalDeviceMemoryDecompressionPropertiesEXT::decompressionMethods

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DECOMPRESS_MEMORY_INFO_EXT

• pNext must be NULL

• decompressionMethod must be a valid combination of MemoryDecompressionMethodFlagBitsEXT values

• decompressionMethod must not be 0

• pRegions must be a valid pointer to an array of regionCount DecompressMemoryRegionEXT structures

• regionCount must be greater than 0

See Also

VK_EXT_memory_decompression, DecompressMemoryRegionEXT, MemoryDecompressionMethodFlagsEXT, StructureType, cmdDecompressMemoryEXT

VkMemoryDecompressionMethodFlagBitsEXT - List the supported memory decompression methods

Description

• MEMORY_DECOMPRESSION_METHOD_GDEFLATE_1_0_BIT_EXT specifies that the GDeflate 1.0 algorithm is used to decompress data.

See Also

VK_EXT_memory_decompression, VK_NV_memory_decompression, MemoryDecompressionMethodFlagsEXT