Package org.lwjgl.vulkan

Class VkCopyMemoryToImageInfoEXT

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkCopyMemoryToImageInfoEXT>
org.lwjgl.vulkan.VkCopyMemoryToImageInfoEXT
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkCopyMemoryToImageInfoEXT extends org.lwjgl.system.Struct<VkCopyMemoryToImageInfoEXT> implements org.lwjgl.system.NativeResource
Structure specifying parameters of host memory to image copy command.
Description

vkCopyMemoryToImageEXT does not check whether the device memory associated with dstImage is currently in use before performing the copy. The application must guarantee that any previously submitted command that reads from or writes to the copy regions has completed before the host performs the copy.

Copy regions for the image must be aligned to a multiple of the texel block extent in each dimension, except at the edges of the image, where region extents must match the edge of the image.

Valid Usage
  • If dstImage is non-sparse then the image or the specified disjoint plane must be bound completely and contiguously to a single VkDeviceMemory object
  • The dstSubresource.mipLevel member of each element of pRegions must be less than the mipLevels specified in VkImageCreateInfo when dstImage was created
  • If dstSubresource.layerCount is not REMAINING_ARRAY_LAYERS, dstSubresource.baseArrayLayer + dstSubresource.layerCount of each element of pRegions must be less than or equal to the arrayLayers specified in VkImageCreateInfo when dstImage was created
  • dstImage must not have been created with flags containing IMAGE_CREATE_SUBSAMPLED_BIT_EXT
  • The image region specified by each element of pRegions must be contained within the specified dstSubresource of dstImage
  • For each element of pRegions, dstOffset.x and (extent.width + dstOffset.x) must both be greater than or equal to 0 and less than or equal to the width of the specified dstSubresource of dstImage
  • For each element of pRegions, dstOffset.y and (extent.height + dstOffset.y) must both be greater than or equal to 0 and less than or equal to the height of the specified dstSubresource of dstImage
  • If dstImage is of type IMAGE_TYPE_1D, then for each element of pRegions, dstOffset.y must be 0 and extent.height must be 1
  • For each element of pRegions, dstOffset.z and (extent.depth + dstOffset.z) must both be greater than or equal to 0 and less than or equal to the depth of the specified dstSubresource of dstImage
  • If dstImage is of type IMAGE_TYPE_1D or IMAGE_TYPE_2D, then for each element of pRegions, dstOffset.z must be 0 and extent.depth must be 1
  • For each element of pRegions, dstOffset.x must be a multiple of the texel block extent width of the VkFormat of dstImage
  • For each element of pRegions, dstOffset.y must be a multiple of the texel block extent height of the VkFormat of dstImage
  • For each element of pRegions, dstOffset.z must be a multiple of the texel block extent depth of the VkFormat of dstImage
  • For each element of pRegions, if the sum of dstOffset.x and extent.width does not equal the width of the subresource specified by srcSubresource, extent.width must be a multiple of the texel block extent width of the VkFormat of dstImage
  • For each element of pRegions, if the sum of dstOffset.y and extent.height does not equal the height of the subresource specified by srcSubresource, extent.height must be a multiple of the texel block extent height of the VkFormat of dstImage
  • For each element of pRegions, if the sum of dstOffset.z and extent.depth does not equal the depth of the subresource specified by srcSubresource, extent.depth must be a multiple of the texel block extent depth of the VkFormat of dstImage
  • For each element of pRegions, dstSubresource.aspectMask must specify aspects present in dstImage
  • If dstImage has a multi-planar image format, then for each element of pRegions, dstSubresource.aspectMask must be a single valid multi-planar aspect mask bit
  • If dstImage is of type IMAGE_TYPE_3D, for each element of pRegions, dstSubresource.baseArrayLayer must be 0 and dstSubresource.layerCount must be 1
  • For each element of pRegions, bufferRowLength must be a multiple of the texel block extent width of the VkFormat of dstImage
  • For each element of pRegions, bufferImageHeight must be a multiple of the texel block extent height of the VkFormat of dstImage
  • For each element of pRegions, bufferRowLength divided by the texel block extent width and then multiplied by the texel block size of dstImage must be less than or equal to 231-1
  • dstImageLayout must specify the current layout of the image subresources of dstImage specified in pRegions
  • dstImageLayout must be one of the image layouts returned in VkPhysicalDeviceHostImageCopyPropertiesEXT::pCopyDstLayouts
  • If flags includes HOST_IMAGE_COPY_MEMCPY_EXT, for each region in pRegions, memoryRowLength and memoryImageHeight must both be 0
Valid Usage (Implicit)
  • sType must be STRUCTURE_TYPE_COPY_MEMORY_TO_IMAGE_INFO_EXT
  • pNext must be NULL
  • flags must be a valid combination of VkHostImageCopyFlagBitsEXT values
  • dstImage must be a valid VkImage handle
  • dstImageLayout must be a valid VkImageLayout value
  • pRegions must be a valid pointer to an array of regionCount valid VkMemoryToImageCopyEXT structures
  • regionCount must be greater than 0
See Also

VkMemoryToImageCopyEXT, CopyMemoryToImageEXT

Layout


 struct VkCopyMemoryToImageInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkHostImageCopyFlagsEXT flags();
     VkImage dstImage();
     VkImageLayout dstImageLayout();
     uint32_t regionCount();
     VkMemoryToImageCopyEXT const * pRegions();
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • STYPE

      public static final int STYPE
      The struct member offsets.

    • PNEXT

      public static final int PNEXT
      The struct member offsets.

    • FLAGS

      public static final int FLAGS
      The struct member offsets.

    • DSTIMAGE

      public static final int DSTIMAGE
      The struct member offsets.

    • DSTIMAGELAYOUT

      public static final int DSTIMAGELAYOUT
      The struct member offsets.

    • REGIONCOUNT

      public static final int REGIONCOUNT
      The struct member offsets.

    • PREGIONS

      public static final int PREGIONS
      The struct member offsets.

  • Constructor Details

    • VkCopyMemoryToImageInfoEXT

      public VkCopyMemoryToImageInfoEXT(ByteBuffer container)
      Creates a VkCopyMemoryToImageInfoEXT instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

      The created instance holds a strong reference to the container object.

  • Method Details