LWJGL 3.3.3 · org.lwjgl.vulkan.VkCopyImageToImageInfoEXT

Structure specifying parameters of an image to image host copy command.

Description

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

Valid Usage

srcImage and dstImage must have been created with identical image creation parameters

If srcImage is sparse then all memory ranges accessed by the copy command must be bound as described in Binding Resource Memory
If the stencil aspect of srcImage is accessed, and srcImage was not created with separate stencil usage, the image must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT_EXT set in VkImageCreateInfo::usage
If the stencil aspect of srcImage is accessed, and srcImage was created with separate stencil usage, the image must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT_EXT set in VkImageStencilUsageCreateInfo::stencilUsage
If non-stencil aspects of srcImage are accessed, the image must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT_EXT set in VkImageCreateInfo::usage
If flags contains HOST_IMAGE_COPY_MEMCPY_EXT, the x, y, and z members of the srcOffset member of each element of pRegions must be 0
If flags contains HOST_IMAGE_COPY_MEMCPY_EXT, the extent member of each element of pRegions must equal the extents of srcImage identified by srcSubresource

If srcImage is non-sparse then the image or the specified disjoint plane must be bound completely and contiguously to a single VkDeviceMemory object
The srcSubresource.mipLevel member of each element of pRegions must be less than the mipLevels specified in VkImageCreateInfo when srcImage was created
The srcSubresource.baseArrayLayer + srcSubresource.layerCount of each element of pRegions , if srcSubresource.layerCount is not REMAINING_ARRAY_LAYERS and maintenance5 is not enabled, must be less than or equal to the arrayLayers specified in VkImageCreateInfo when srcImage was created
srcImage 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 srcSubresource of srcImage
For each element of pRegions, srcOffset.x and (extent.width + srcOffset.x) must both be greater than or equal to 0 and less than or equal to the width of the specified srcSubresource of srcImage
For each element of pRegions, srcOffset.y and (extent.height + srcOffset.y) must both be greater than or equal to 0 and less than or equal to the height of the specified srcSubresource of srcImage

If srcImage is of type IMAGE_TYPE_1D, then for each element of pRegions, srcOffset.y must be 0 and extent.height must be 1
For each element of pRegions, srcOffset.z and (extent.depth + srcOffset.z) must both be greater than or equal to 0 and less than or equal to the depth of the specified srcSubresource of srcImage
If srcImage is of type IMAGE_TYPE_1D or IMAGE_TYPE_2D, then for each element of pRegions, srcOffset.z must be 0 and extent.depth must be 1
For each element of pRegions, srcOffset.x must be a multiple of the texel block extent width of the VkFormat of srcImage
For each element of pRegions, srcOffset.y must be a multiple of the texel block extent height of the VkFormat of srcImage
For each element of pRegions, srcOffset.z must be a multiple of the texel block extent depth of the VkFormat of srcImage
For each element of pRegions, if the sum of srcOffset.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 srcImage
For each element of pRegions, if the sum of srcOffset.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 srcImage
For each element of pRegions, if the sum of srcOffset.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 srcImage
For each element of pRegions, srcSubresource.aspectMask must specify aspects present in srcImage
If srcImage has a multi-planar image format, then for each element of pRegions, srcSubresource.aspectMask must be a single valid multi-planar aspect mask bit
If srcImage is of type IMAGE_TYPE_3D, for each element of pRegions, srcSubresource.baseArrayLayer must be 0 and srcSubresource.layerCount must be 1

If dstImage is sparse then all memory ranges accessed by the copy command must be bound as described in Binding Resource Memory
If the stencil aspect of dstImage is accessed, and dstImage was not created with separate stencil usage, the image must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT_EXT set in VkImageCreateInfo::usage
If the stencil aspect of dstImage is accessed, and dstImage was created with separate stencil usage, the image must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT_EXT set in VkImageStencilUsageCreateInfo::stencilUsage
If non-stencil aspects of dstImage are accessed, the image must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT_EXT set in VkImageCreateInfo::usage
If flags contains HOST_IMAGE_COPY_MEMCPY_EXT, the x, y, and z members of the dstOffset member of each element of pRegions must be 0
If flags contains HOST_IMAGE_COPY_MEMCPY_EXT, the extent member of each element of pRegions must equal the extents of dstImage identified by dstSubresource

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
The dstSubresource.baseArrayLayer + dstSubresource.layerCount of each element of pRegions , if dstSubresource.layerCount is not REMAINING_ARRAY_LAYERS and maintenance5 is not enabled, 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
srcImageLayout must specify the current layout of the image subresources of srcImage specified in pRegions
dstImageLayout must specify the current layout of the image subresources of dstImage specified in pRegions
srcImageLayout must be one of the image layouts returned in VkPhysicalDeviceHostImageCopyPropertiesEXT::pCopySrcLayouts
dstImageLayout must be one of the image layouts returned in VkPhysicalDeviceHostImageCopyPropertiesEXT::pCopyDstLayouts

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_COPY_IMAGE_TO_IMAGE_INFO_EXT
pNext must be NULL
flags must be a valid combination of VkHostImageCopyFlagBitsEXT values
srcImage must be a valid VkImage handle
srcImageLayout must be a valid VkImageLayout value
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 VkImageCopy2 structures
regionCount must be greater than 0
Both of dstImage, and srcImage must have been created, allocated, or retrieved from the same VkDevice

Layout


struct VkCopyImageToImageInfoEXT {
    VkStructureType sType;
    void const * pNext;
    VkHostImageCopyFlagsEXT flags;
    VkImage srcImage;
    VkImageLayout srcImageLayout;
    VkImage dstImage;
    VkImageLayout dstImageLayout;
    uint32_t regionCount;
    VkImageCopy2 const * pRegions;
}

Modifier and Type	Class and Description
public static class	VkCopyImageToImageInfoEXT.Buffer An array of `VkCopyImageToImageInfoEXT` structs.

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	DSTIMAGE The struct member offsets.
public static final int	DSTIMAGELAYOUT The struct member offsets.
public static final int	FLAGS The struct member offsets.
public static final int	PNEXT The struct member offsets.
public static final int	PREGIONS The struct member offsets.
public static final int	REGIONCOUNT The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	SRCIMAGE The struct member offsets.
public static final int	SRCIMAGELAYOUT The struct member offsets.
public static final int	STYPE The struct member offsets.

Access	Constructor and Description
protected	VkCopyImageToImageInfoEXT(long address, ByteBuffer container)
public	VkCopyImageToImageInfoEXT(ByteBuffer container) Creates a `VkCopyImageToImageInfoEXT` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkCopyImageToImageInfoEXT	calloc() Returns a new `VkCopyImageToImageInfoEXT` instance allocated with `memCalloc`.
public static VkCopyImageToImageInfoEXT.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkCopyImageToImageInfoEXT.Buffer` instance allocated with `memCalloc`.
public static VkCopyImageToImageInfoEXT	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkCopyImageToImageInfoEXT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkCopyImageToImageInfoEXT.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkCopyImageToImageInfoEXT.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected VkCopyImageToImageInfoEXT	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static VkCopyImageToImageInfoEXT	create() Returns a new `VkCopyImageToImageInfoEXT` instance allocated with `BufferUtils`.
public static VkCopyImageToImageInfoEXT	create(long address) Returns a new `VkCopyImageToImageInfoEXT` instance for the specified memory address.
public static VkCopyImageToImageInfoEXT.Buffer	create(int the buffer capacity capacity) Returns a new `VkCopyImageToImageInfoEXT.Buffer` instance allocated with `BufferUtils`.
public static VkCopyImageToImageInfoEXT.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkCopyImageToImageInfoEXT.Buffer` instance at the specified memory.
public static VkCopyImageToImageInfoEXT	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkCopyImageToImageInfoEXT.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public long	dstImage() the destination image.
public VkCopyImageToImageInfoEXT	dstImage(long value) Sets the specified value to the `dstImage` field.
public int	dstImageLayout() the layout of the destination image subresources for the copy.
public VkCopyImageToImageInfoEXT	dstImageLayout(int value) Sets the specified value to the `dstImageLayout` field.
public int	flags() a bitmask of `VkHostImageCopyFlagBitsEXT` values describing additional copy parameters.
public VkCopyImageToImageInfoEXT	flags(int value) Sets the specified value to the `flags` field.
public static VkCopyImageToImageInfoEXT	malloc() Returns a new `VkCopyImageToImageInfoEXT` instance allocated with `memAlloc`.
public static VkCopyImageToImageInfoEXT.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkCopyImageToImageInfoEXT.Buffer` instance allocated with `memAlloc`.
public static VkCopyImageToImageInfoEXT	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkCopyImageToImageInfoEXT` instance allocated on the specified `MemoryStack`.
public static VkCopyImageToImageInfoEXT.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkCopyImageToImageInfoEXT.Buffer` instance allocated on the specified `MemoryStack`.
public static long	ndstImage(long struct) Unsafe version of `dstImage`.
public static void	ndstImage(long struct, long value) Unsafe version of `dstImage`.
public static int	ndstImageLayout(long struct) Unsafe version of `dstImageLayout`.
public static void	ndstImageLayout(long struct, int value) Unsafe version of `dstImageLayout`.
public static int	nflags(long struct) Unsafe version of `flags`.
public static void	nflags(long struct, int value) Unsafe version of `flags`.
public static long	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, long value) Unsafe version of `pNext`.
public static VkImageCopy2.Buffer	npRegions(long struct) Unsafe version of `pRegions`.
public static void	npRegions(long struct, VkImageCopy2.Buffer value) Unsafe version of `pRegions`.
public static int	nregionCount(long struct) Unsafe version of `regionCount`.
public static void	nregionCount(long struct, int value) Sets the specified value to the `regionCount` field of the specified `struct`.
public static long	nsrcImage(long struct) Unsafe version of `srcImage`.
public static void	nsrcImage(long struct, long value) Unsafe version of `srcImage`.
public static int	nsrcImageLayout(long struct) Unsafe version of `srcImageLayout`.
public static void	nsrcImageLayout(long struct, int value) Unsafe version of `srcImageLayout`.
public static int	nsType(long struct) Unsafe version of `sType`.
public static void	nsType(long struct, int value) Unsafe version of `sType`.
public long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkCopyImageToImageInfoEXT	pNext(long value) Sets the specified value to the `pNext` field.
public VkImageCopy2.Buffer	pRegions() a pointer to an array of `VkImageCopy2` structures specifying the regions to copy.
public VkCopyImageToImageInfoEXT	pRegions(VkImageCopy2.Buffer value) Sets the address of the specified `VkImageCopy2.Buffer` to the `pRegions` field.
public int	regionCount() the number of regions to copy.
public VkCopyImageToImageInfoEXT	set(int sType, long pNext, int flags, long srcImage, int srcImageLayout, long dstImage, int dstImageLayout, VkImageCopy2.Buffer pRegions) Initializes this struct with the specified values.
public VkCopyImageToImageInfoEXT	Returns: this struct set(VkCopyImageToImageInfoEXT the source struct src) Copies the specified struct data to this struct.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public long	srcImage() the source image.
public VkCopyImageToImageInfoEXT	srcImage(long value) Sets the specified value to the `srcImage` field.
public int	srcImageLayout() the layout of the source image subresources for the copy.
public VkCopyImageToImageInfoEXT	srcImageLayout(int value) Sets the specified value to the `srcImageLayout` field.
public int	sType() a `VkStructureType` value identifying this structure.
public VkCopyImageToImageInfoEXT	sType(int value) Sets the specified value to the `sType` field.
public VkCopyImageToImageInfoEXT	sType$Default() Sets the `STRUCTURE_TYPE_COPY_IMAGE_TO_IMAGE_INFO_EXT` value to the `sType` field.
public static void	validate(long the struct to validate struct) Validates pointer members that should not be `NULL`.

public Class VkCopyImageToImageInfoEXT

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary