Movatterモバイル変換

[0]ホーム
URL:

Vulkan API Reference Pageslatest

VkCopyImageToBufferInfo2(3)

Name

VkCopyImageToBufferInfo2 - Structure specifying parameters of an image to buffer copy command

C Specification

TheVkCopyImageToBufferInfo2 structure is defined as:

// Provided by VK_VERSION_1_3typedef struct VkCopyImageToBufferInfo2 {    VkStructureType              sType;    const void*                  pNext;    VkImage                      srcImage;    VkImageLayout                srcImageLayout;    VkBuffer                     dstBuffer;    uint32_t                     regionCount;    const VkBufferImageCopy2*    pRegions;} VkCopyImageToBufferInfo2;
// Provided by VK_KHR_copy_commands2// Equivalent to VkCopyImageToBufferInfo2typedef VkCopyImageToBufferInfo2 VkCopyImageToBufferInfo2KHR;

Members

  • sType is aVkStructureType value identifying this structure.

  • pNext isNULL or a pointer to a structure extending thisstructure.

  • srcImage is the source image.

  • srcImageLayout is the layout of the source image subresources forthe copy.

  • dstBuffer is the destination buffer.

  • regionCount is the number of regions to copy.

  • pRegions is a pointer to an array ofVkBufferImageCopy2structures specifying the regions to copy.

Description

Valid Usage

  • VUID-VkCopyImageToBufferInfo2-pRegions-00183
    dstBuffermust be large enough to contain all buffer locationsthat are accessed according toBuffer and Image Addressing, for each element ofpRegions

  • VUID-VkCopyImageToBufferInfo2-pRegions-00184
    The union of all source regions, and the union of all destinationregions, specified by the elements ofpRegions,must not overlapin memory

  • VUID-VkCopyImageToBufferInfo2-srcImage-00186
    srcImagemust have been created with theVK_IMAGE_USAGE_TRANSFER_SRC_BIT usage flag set

  • VUID-VkCopyImageToBufferInfo2-srcImage-01998
    Theformat features ofsrcImagemust containVK_FORMAT_FEATURE_TRANSFER_SRC_BIT

  • VUID-VkCopyImageToBufferInfo2-dstBuffer-00191
    dstBuffermust have been created with theVK_BUFFER_USAGE_TRANSFER_DST_BIT usage flag set

  • VUID-VkCopyImageToBufferInfo2-dstBuffer-00192
    IfdstBuffer is non-sparse then itmust be bound completely andcontiguously to a singleVkDeviceMemory object

  • VUID-VkCopyImageToBufferInfo2-srcImageLayout-00189
    srcImageLayoutmust specify the layout of the image subresourcesofsrcImage specified inpRegions at the time this commandis executed on aVkDevice

  • VUID-VkCopyImageToBufferInfo2-srcImageLayout-01397
    srcImageLayoutmust beVK_IMAGE_LAYOUT_SHARED_PRESENT_KHR,VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, orVK_IMAGE_LAYOUT_GENERAL

  • VUID-VkCopyImageToBufferInfo2-srcImage-07966
    IfsrcImage is non-sparse then the imageor each specifieddisjoint planemust be bound completely and contiguously to a singleVkDeviceMemory object

  • VUID-VkCopyImageToBufferInfo2-imageSubresource-07967
    TheimageSubresource.mipLevel member of each element ofpRegionsmust be less than themipLevels specified inVkImageCreateInfo whensrcImage was created

  • VUID-VkCopyImageToBufferInfo2-imageSubresource-07968
    IfimageSubresource.layerCount is notVK_REMAINING_ARRAY_LAYERS,imageSubresource.baseArrayLayer +imageSubresource.layerCount of each element ofpRegionsmust be less than or equal to thearrayLayers specified inVkImageCreateInfo whensrcImage was created

  • VUID-VkCopyImageToBufferInfo2-srcImage-07969
    srcImagemust not have been created withflagscontainingVK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT

  • VUID-VkCopyImageToBufferInfo2-srcImage-07973
    srcImagemust have a sample count equal toVK_SAMPLE_COUNT_1_BIT

  • VUID-VkCopyImageToBufferInfo2-bufferRowLength-09106
    For each element ofpRegions,bufferRowLengthmust be amultiple of thetexel block extent width of theVkFormat ofsrcImage

  • VUID-VkCopyImageToBufferInfo2-bufferImageHeight-09107
    For each element ofpRegions,bufferImageHeightmust be amultiple of thetexel block extent height of theVkFormat ofsrcImage

  • VUID-VkCopyImageToBufferInfo2-bufferRowLength-09108
    For each element ofpRegions,bufferRowLength divided bythetexel block extent width and thenmultiplied by the texel block size ofsrcImagemust be lessthan or equal to231-1

  • VUID-VkCopyImageToBufferInfo2-srcImage-07975
    IfsrcImage does not have either a depth/stencil formator amulti-planar format,then for each element ofpRegions,bufferOffsetmust be amultiple of thetexel block size

  • VUID-VkCopyImageToBufferInfo2-srcImage-07976
    IfsrcImage has amulti-planar format, then for each element ofpRegions,bufferOffsetmust be a multiple of the element size of the compatible format for theformat and theaspectMask of theimageSubresource as definedinCompatible Formats of Planes of Multi-Planar Formats

  • VUID-VkCopyImageToBufferInfo2-srcImage-07978
    IfsrcImage has a depth/stencil format, thebufferOffsetmember of any element ofpRegionsmust be a multiple of4

  • VUID-VkCopyImageToBufferInfo2-imageOffset-00197
    For each element ofpRegions not containingVkCopyCommandTransformInfoQCOM in itspNext chain,imageOffset.x and(imageExtent.width +imageOffset.x)must both be greater than or equal to0 andless than or equal to the width of the specifiedimageSubresourceofsrcImage

  • VUID-VkCopyImageToBufferInfo2-imageOffset-00198
    For each element ofpRegions not containingVkCopyCommandTransformInfoQCOM in itspNext chain,imageOffset.y and(imageExtent.height +imageOffset.y)must both be greater than or equal to0 andless than or equal to the height of the specifiedimageSubresourceofsrcImage

Valid Usage (Implicit)

  • VUID-VkCopyImageToBufferInfo2-sType-sType
    sTypemust beVK_STRUCTURE_TYPE_COPY_IMAGE_TO_BUFFER_INFO_2

  • VUID-VkCopyImageToBufferInfo2-pNext-pNext
    pNextmust beNULL

  • VUID-VkCopyImageToBufferInfo2-srcImage-parameter
    srcImagemust be a validVkImage handle

  • VUID-VkCopyImageToBufferInfo2-srcImageLayout-parameter
    srcImageLayoutmust be a validVkImageLayout value

  • VUID-VkCopyImageToBufferInfo2-dstBuffer-parameter
    dstBuffermust be a validVkBuffer handle

  • VUID-VkCopyImageToBufferInfo2-pRegions-parameter
    pRegionsmust be a valid pointer to an array ofregionCount validVkBufferImageCopy2 structures

  • VUID-VkCopyImageToBufferInfo2-regionCount-arraylength
    regionCountmust be greater than0

  • VUID-VkCopyImageToBufferInfo2-commonparent
    Both ofdstBuffer, andsrcImagemust have been created, allocated, or retrieved from the sameVkDevice

See Also

Document Notes

For more information, see theVulkan Specification.

This page is extracted from the Vulkan Specification.Fixes and changes should be made to the Specification, not directly.

[8]ページ先頭
©2009-2026 Movatter.jp