public Class NVCopyMemoryIndirect

The extension name.

The extension specification version.

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_COPY_MEMORY_INDIRECT_FEATURES_NV
• STRUCTURE_TYPE_PHYSICAL_DEVICE_COPY_MEMORY_INDIRECT_PROPERTIES_NV

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_COPY_MEMORY_INDIRECT_FEATURES_NV
• STRUCTURE_TYPE_PHYSICAL_DEVICE_COPY_MEMORY_INDIRECT_PROPERTIES_NV

Unsafe version of: CmdCopyMemoryToImageIndirectNV

Parameters

copyCount:int

the number of copies to execute, and can be zero.

Copy data between memory regions.

C Specification

To copy data between two memory regions by specifying copy parameters indirectly in a buffer, call:

void vkCmdCopyMemoryIndirectNV(
    VkCommandBuffer                             commandBuffer,
    VkDeviceAddress                             copyBufferAddress,
    uint32_t                                    copyCount,
    uint32_t                                    stride);

Description

Each region read from copyBufferAddress is copied from the source region to the specified destination region. The results are undefined if any of the source and destination regions overlap in memory.

Valid Usage

• The indirectCopy feature must be enabled
• copyBufferAddress must be 4 byte aligned
• stride must be a multiple of 4 and must be greater than or equal to sizeof(VkCopyMemoryIndirectCommandNV)
• The VkCommandPool that commandBuffer was allocated from must support at least one of the VkPhysicalDeviceCopyMemoryIndirectPropertiesNV::supportedQueues

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support transfer, 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 VkCommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

Parameters

commandBuffer:VkCommandBuffer

the command buffer into which the command will be recorded.

copyBufferAddress:long

the buffer address specifying the copy parameters. This buffer is laid out in memory as an array of VkCopyMemoryIndirectCommandNV structures.

copyCount:int

the number of copies to execute, and can be zero.

stride:int

the stride in bytes between successive sets of copy parameters.

Copy data from a memory region into an image.

C Specification

To copy data from a memory region to an image object by specifying copy parameters in a buffer, call:

void vkCmdCopyMemoryToImageIndirectNV(
    VkCommandBuffer                             commandBuffer,
    VkDeviceAddress                             copyBufferAddress,
    uint32_t                                    copyCount,
    uint32_t                                    stride,
    VkImage                                     dstImage,
    VkImageLayout                               dstImageLayout,
    const VkImageSubresourceLayers*             pImageSubresources);

Description

Each region in copyBufferAddress is copied from the source memory region to an image region in the destination image. If the destination image is of type IMAGE_TYPE_3D, the starting slice and number of slices to copy are specified in pImageSubresources::baseArrayLayer and pImageSubresources::layerCount respectively. The copy must be performed on a queue that supports indirect copy operations, see VkPhysicalDeviceCopyMemoryIndirectPropertiesNV.

Valid Usage

• The indirectCopy feature must be enabled
• dstImage must not be a protected image
• The aspectMask member for every subresource in pImageSubresources must only have a single bit set
• The image region specified by each element in copyBufferAddress must be a region that is contained within dstImage
• dstImage must have been created with IMAGE_USAGE_TRANSFER_DST_BIT usage flag
• If dstImage is non-sparse then it must be bound completely and contiguously to a single VkDeviceMemory object

• dstImage must have a sample count equal to SAMPLE_COUNT_1_BIT
• dstImageLayout must specify the layout of the image subresources of dstImage at the time this command is executed on a VkDevice
• dstImageLayout must be IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, IMAGE_LAYOUT_GENERAL, or IMAGE_LAYOUT_SHARED_PRESENT_KHR
• The specified mipLevel of each region must be less than the mipLevels specified in VkImageCreateInfo when dstImage was created
• If layerCount is not REMAINING_ARRAY_LAYERS, the specified baseArrayLayer + layerCount of each region must be less than or equal to the arrayLayers specified in VkImageCreateInfo when dstImage was created
• The imageOffset and imageExtent members of each region must respect the image transfer granularity requirements of commandBuffer’s command pool’s queue family, as described in VkQueueFamilyProperties
• dstImage must not have been created with flags containing IMAGE_CREATE_SUBSAMPLED_BIT_EXT
• If the queue family used to create the VkCommandPool which commandBuffer was allocated from does not support QUEUE_GRAPHICS_BIT, for each region, the aspectMask member of pImageSubresources must not be IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT
• For each region in copyBufferAddress, imageOffset.y and (imageExtent.height + imageOffset.y) must both be greater than or equal to 0 and less than or equal to the height of the specified subresource
• offset must be 4 byte aligned
• stride must be a multiple of 4 and must be greater than or equal to sizeof(VkCopyMemoryToImageIndirectCommandNV)

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle
• dstImage must be a valid VkImage handle
• dstImageLayout must be a valid VkImageLayout value
• pImageSubresources must be a valid pointer to an array of copyCount valid VkImageSubresourceLayers structures
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support transfer, 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
• copyCount must be greater than 0
• Both of commandBuffer, and dstImage must have been created, allocated, or retrieved from the same VkDevice

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

See Also

VkImageSubresourceLayers

Parameters

commandBuffer:VkCommandBuffer

the command buffer into which the command will be recorded.

copyBufferAddress:long

the buffer address specifying the copy parameters. This buffer is laid out in memory as an array of VkCopyMemoryToImageIndirectCommandNV structures.

stride:int

the byte stride between successive sets of copy parameters.

dstImage:long

the destination image.

dstImageLayout:int

the layout of the destination image subresources for the copy.

pImageSubresources:VkImageSubresourceLayers.Buffer

a pointer to an array of size copyCount of VkImageSubresourceLayers used to specify the specific image subresource of the destination image data for that copy.