C Specification

The VkCopyDeviceMemoryImageInfoKHR structure is defined as:

// Provided by VK_KHR_device_address_commands
typedef struct VkCopyDeviceMemoryImageInfoKHR {
    VkStructureType                      sType;
    const void*                          pNext;
    VkImage                              image;
    uint32_t                             regionCount;
    const VkDeviceMemoryImageCopyKHR*    pRegions;
} VkCopyDeviceMemoryImageInfoKHR;

Members

  • sType is a VkStructureType value identifying this structure.

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

  • image is the base image accessed by the copy command.

  • regionCount is the number of copies to be performed.

  • pRegions is a pointer to an array of VkDeviceMemoryImageCopyKHR structures describing individual copy operations between two memory ranges.

Description

Valid Usage

  • VUID-VkCopyDeviceMemoryImageInfoKHR-addressRange-13026
    The range of memory backing the address range defined by the addressRange member of any element of pRegions must not overlap the memory backing the address range defined by the addressRange of any other element of pRegions

  • VUID-VkCopyDeviceMemoryImageInfoKHR-addressRange-13027
    The range of memory backing the address range defined by the addressRange member of any element of pRegions must not overlap the memory backing any texels in image defined by the imageSubresource, imageOffset, and imageExtent members of any element of pRegions

  • VUID-VkCopyDeviceMemoryImageInfoKHR-imageLayout-13028
    The imageLayout member of each element of pRegions must specify the layout of the image subresource specified for that element of pRegions at the time this command is executed on a VkDevice

  • VUID-VkCopyDeviceMemoryImageInfoKHR-image-07966
    If image is non-sparse then the image or each specified disjoint plane must be bound completely and contiguously to a single VkDeviceMemory object

  • VUID-VkCopyDeviceMemoryImageInfoKHR-imageSubresource-07967
    The imageSubresource.mipLevel member of each element of pRegions must be less than the mipLevels specified in VkImageCreateInfo when image was created

  • VUID-VkCopyDeviceMemoryImageInfoKHR-imageSubresource-07968
    If imageSubresource.layerCount is not VK_REMAINING_ARRAY_LAYERS, imageSubresource.baseArrayLayer + imageSubresource.layerCount of each element of pRegions must be less than or equal to the arrayLayers specified in VkImageCreateInfo when image was created

  • VUID-VkCopyDeviceMemoryImageInfoKHR-image-07969
    image must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT

  • VUID-VkCopyDeviceMemoryImageInfoKHR-image-07973
    image must have a sample count equal to VK_SAMPLE_COUNT_1_BIT

  • VUID-VkCopyDeviceMemoryImageInfoKHR-addressRowLength-09106
    For each element of pRegions, addressRowLength must be a multiple of the texel block extent width of the VkFormat of image

  • VUID-VkCopyDeviceMemoryImageInfoKHR-addressImageHeight-09107
    For each element of pRegions, addressImageHeight must be a multiple of the texel block extent height of the VkFormat of image

  • VUID-VkCopyDeviceMemoryImageInfoKHR-addressRowLength-09108
    For each element of pRegions, addressRowLength divided by the texel block extent width and then multiplied by the texel block size of image must be less than or equal to 231-1

  • VUID-VkCopyDeviceMemoryImageInfoKHR-image-13029
    If image does not have either a depth/stencil format or a multi-planar format, then for each element of pRegions, addressRange.address must be a multiple of the texel block size

  • VUID-VkCopyDeviceMemoryImageInfoKHR-image-13030
    If image has a multi-planar format, then for each element of pRegions, addressRange.address must be a multiple of the element size of the compatible format for the format and the aspectMask of the imageSubresource as defined in https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#formats-compatible-planes

  • VUID-VkCopyDeviceMemoryImageInfoKHR-image-13031
    If image has a depth/stencil format, the addressRange.address member of any element of pRegions must be a multiple of 4

  • VUID-VkCopyDeviceMemoryImageInfoKHR-pRegions-13032
    The image region specified by each element of pRegions that does not contain VkCopyCommandTransformInfoQCOM in its pNext chain must be contained within the specified imageSubresource of image

  • VUID-VkCopyDeviceMemoryImageInfoKHR-pRegions-13033
    If the image region specified by each element of pRegions contains VkCopyCommandTransformInfoQCOM in its pNext chain, the rotated image region must be contained within image

  • VUID-VkCopyDeviceMemoryImageInfoKHR-pRegions-13034
    If any element of pRegions contains VkCopyCommandTransformInfoQCOM in its pNext chain, then image must have a 1x1x1 texel block extent

  • VUID-VkCopyDeviceMemoryImageInfoKHR-pRegions-13035
    If any element of pRegions contains VkCopyCommandTransformInfoQCOM in its pNext chain, then image must be of type VK_IMAGE_TYPE_2D

  • VUID-VkCopyDeviceMemoryImageInfoKHR-pRegions-13036
    If any element of pRegions contains VkCopyCommandTransformInfoQCOM in its pNext chain, then image must not have a multi-planar format

Valid Usage (Implicit)

  • VUID-VkCopyDeviceMemoryImageInfoKHR-sType-sType
    sType must be VK_STRUCTURE_TYPE_COPY_DEVICE_MEMORY_IMAGE_INFO_KHR

  • VUID-VkCopyDeviceMemoryImageInfoKHR-pNext-pNext
    pNext must be NULL

  • VUID-VkCopyDeviceMemoryImageInfoKHR-image-parameter
    image must be a valid VkImage handle

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

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

See Also

VK_KHR_device_address_commands, VkDeviceMemoryImageCopyKHR, VkImage, VkStructureType, vkCmdCopyImageToMemoryKHR, vkCmdCopyMemoryToImageKHR

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.

Copyright

Copyright 2014-2026 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0