vkCmdDecompressMemoryNV - Decompress data between memory regions

Description

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

Valid Usage

• The memoryDecompression feature must be enabled

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pDecompressMemoryRegions must be a valid pointer to an array of decompressRegionCount valid DecompressMemoryRegionNV structures
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics, or compute operations
• This command must only be called outside of a render pass instance
• This command must only be called outside of a video coding scope
• decompressRegionCount must be greater than 0

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

'

See Also

VK_NV_memory_decompression, CommandBuffer, DecompressMemoryRegionNV

vkCmdDecompressMemoryIndirectCountNV - Indirect decompress data between memory regions

Description

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

Valid Usage

• The memoryDecompression feature must be enabled

• If indirectCommandsAddress comes from a non-sparse buffer then it must be bound completely and contiguously to a single DeviceMemory object
• The Buffer that indirectCommandsAddress comes from must have been created with the BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
• offset must be a multiple of 4
• If indirectCommandsCountAddress comes from a non-sparse buffer then it must be bound completely and contiguously to a single DeviceMemory object
• The Buffer that indirectCommandsCountAddress comes from must have been created with the BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
• indirectCommandsCountAddress must be a multiple of 4
• The count stored in indirectCommandsCountAddress must be less than or equal to PhysicalDeviceMemoryDecompressionPropertiesNV::maxDecompressionIndirectCount
• stride must be a multiple of 4 and must be greater than or equal to sizeof(DecompressMemoryRegionNV)
• If the count stored in indirectCommandsCountAddress is equal to 1, (offset + sizeof(DecompressMemoryRegionNV)) must be less than or equal to the size of the Buffer that indirectCommandsAddress comes from
• If the count stored in indirectCommandsCountAddress is greater than 1, indirectCommandsAddress + sizeof(DecompressMemoryRegionNV) + (stride × (count stored in countBuffer - 1)) must be less than or equal to the last valid address in the Buffer that indirectCommandsAddress was created from

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics, or compute operations
• This command must only be called outside of a render pass instance
• 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

'

See Also

VK_NV_memory_decompression, CommandBuffer, DeviceAddress

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

Members

This structure describes the following features:

Description

If the PhysicalDeviceMemoryDecompressionFeaturesNV 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. PhysicalDeviceMemoryDecompressionFeaturesNV can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

See Also

VK_NV_memory_decompression, Bool32, StructureType

VkPhysicalDeviceMemoryDecompressionPropertiesNV - Structure describing supported memory decompression methods by an implementation

Description

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

Valid Usage (Implicit)

See Also

VK_NV_memory_decompression, MemoryDecompressionMethodFlagsNV, StructureType

VkDecompressMemoryRegionNV - Structure specifying decompression parameters

Valid Usage

• The srcAddress must be 4 byte aligned

• The memory in range srcAddress and srcAddress + compressedSize must be valid and bound to a DeviceMemory object
• The dstAddress must be 4 byte aligned
• If decompressionMethod is MEMORY_DECOMPRESSION_METHOD_GDEFLATE_1_0_BIT_NV, then decompressedSize must be less than or equal to 65536 bytes
• The memory in range dstAddress and dstAddress + decompressedSize must be valid and bound to a DeviceMemory object
• The decompressedSize must be large enough to hold the decompressed data based on the decompressionMethod
• The decompressionMethod must have a single bit set
• The srcAddress to srcAddress + compressedSize region must not overlap with the dstAddress and dstAddress + decompressedSize region

Valid Usage (Implicit)

• decompressionMethod must be a valid combination of MemoryDecompressionMethodFlagBitsNV values

• decompressionMethod must not be 0

See Also

VK_NV_memory_decompression, DeviceAddress, DeviceSize, MemoryDecompressionMethodFlagsNV, cmdDecompressMemoryNV

VkMemoryDecompressionMethodFlagBitsNV - List the supported memory decompression methods

See Also

VK_NV_memory_decompression