Package org.lwjgl.vulkan

Class EXTHostImageCopy

java.lang.Object

org.lwjgl.vulkan.EXTHostImageCopy

public class EXTHostImageCopy
extends Object

This extension allows applications to copy data between host memory and images on the host processor, without staging the data through a GPU-accessible buffer. This removes the need to allocate and manage the buffer and its associated memory. On some architectures it may also eliminate an extra copy operation. This extension additionally allows applications to copy data between images on the host.

To support initializing a new image in preparation for a host copy, it is now possible to transition a new image to IMAGE_LAYOUT_GENERAL or other host-copyable layouts via TransitionImageLayoutEXT. Additionally, it is possible to perform copies that preserve the swizzling layout of the image by using the HOST_IMAGE_COPY_MEMCPY_EXT flag. In that case, the memory size needed for copies to or from a buffer can be retrieved by chaining VkSubresourceHostMemcpySizeEXT to pLayout in GetImageSubresourceLayout2EXT.

Name String

VK_EXT_host_image_copy

Extension Type

Device extension

Registered Extension Number

271

Revision

1

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2 or Version 1.1 and VK_KHR_copy_commands2 and VK_KHR_format_feature_flags2 or Version 1.3

Contact

• Shahbaz Youssefi syoussefi

Extension Proposal

VK_EXT_host_image_copy

Other Extension Metadata

Last Modified Date

2023-04-26

Contributors

• Shahbaz Youssefi, Google
• Faith Ekstrand, Collabora
• Hans-Kristian Arntzen, Valve
• Piers Daniell, NVIDIA
• Jan-Harald Fredriksen, Arm
• James Fitzpatrick, Imagination
• Daniel Story, Nintendo

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VK_EXT_HOST_IMAGE_COPY_EXTENSION_NAME	The extension name.
static final int	VK_EXT_HOST_IMAGE_COPY_SPEC_VERSION	The extension specification version.
static final long	VK_FORMAT_FEATURE_2_HOST_IMAGE_TRANSFER_BIT_EXT	Extends VkFormatFeatureFlagBits2.
static final int	VK_HOST_IMAGE_COPY_MEMCPY_EXT	VkHostImageCopyFlagBitsEXT - Bitmask specifying additional copy parameters
static final int	VK_IMAGE_USAGE_HOST_TRANSFER_BIT_EXT	Extends VkImageUsageFlagBits.
static final int	VK_STRUCTURE_TYPE_COPY_IMAGE_TO_IMAGE_INFO_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_COPY_IMAGE_TO_MEMORY_INFO_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_COPY_MEMORY_TO_IMAGE_INFO_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_HOST_IMAGE_COPY_DEVICE_PERFORMANCE_QUERY_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_HOST_IMAGE_LAYOUT_TRANSITION_INFO_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_IMAGE_TO_MEMORY_COPY_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_MEMORY_TO_IMAGE_COPY_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_FEATURES_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_PROPERTIES_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_SUBRESOURCE_HOST_MEMCPY_SIZE_EXT	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nvkCopyImageToImageEXT(org.lwjgl.vulkan.VkDevice device, long pCopyImageToImageInfo)	Unsafe version of: CopyImageToImageEXT
static int	nvkCopyImageToMemoryEXT(org.lwjgl.vulkan.VkDevice device, long pCopyImageToMemoryInfo)	Unsafe version of: CopyImageToMemoryEXT
static int	nvkCopyMemoryToImageEXT(org.lwjgl.vulkan.VkDevice device, long pCopyMemoryToImageInfo)	Unsafe version of: CopyMemoryToImageEXT
static void	nvkGetImageSubresourceLayout2EXT(org.lwjgl.vulkan.VkDevice device, long image, long pSubresource, long pLayout)	Unsafe version of: GetImageSubresourceLayout2EXT
static int	nvkTransitionImageLayoutEXT(org.lwjgl.vulkan.VkDevice device, int transitionCount, long pTransitions)	Unsafe version of: TransitionImageLayoutEXT
static int	vkCopyImageToImageEXT(org.lwjgl.vulkan.VkDevice device, VkCopyImageToImageInfoEXT pCopyImageToImageInfo)	Copy image data using the host.
static int	vkCopyImageToMemoryEXT(org.lwjgl.vulkan.VkDevice device, VkCopyImageToMemoryInfoEXT pCopyImageToMemoryInfo)	Copy image data into host memory.
static int	vkCopyMemoryToImageEXT(org.lwjgl.vulkan.VkDevice device, VkCopyMemoryToImageInfoEXT pCopyMemoryToImageInfo)	Copy data from host memory into an image.
static void	vkGetImageSubresourceLayout2EXT(org.lwjgl.vulkan.VkDevice device, long image, VkImageSubresource2KHR pSubresource, VkSubresourceLayout2KHR pLayout)	See GetImageSubresourceLayout2KHR.
static int	vkTransitionImageLayoutEXT(org.lwjgl.vulkan.VkDevice device, VkHostImageLayoutTransitionInfoEXT.Buffer pTransitions)	Perform an image layout transition on the host.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

VK_EXT_HOST_IMAGE_COPY_SPEC_VERSION

public static final int VK_EXT_HOST_IMAGE_COPY_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

VK_EXT_HOST_IMAGE_COPY_EXTENSION_NAME

public static final String VK_EXT_HOST_IMAGE_COPY_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_FEATURES_EXT

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_FEATURES_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_FEATURES_EXT
• STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_PROPERTIES_EXT
• STRUCTURE_TYPE_MEMORY_TO_IMAGE_COPY_EXT
• STRUCTURE_TYPE_IMAGE_TO_MEMORY_COPY_EXT
• STRUCTURE_TYPE_COPY_IMAGE_TO_MEMORY_INFO_EXT
• STRUCTURE_TYPE_COPY_MEMORY_TO_IMAGE_INFO_EXT
• STRUCTURE_TYPE_HOST_IMAGE_LAYOUT_TRANSITION_INFO_EXT
• STRUCTURE_TYPE_COPY_IMAGE_TO_IMAGE_INFO_EXT
• STRUCTURE_TYPE_SUBRESOURCE_HOST_MEMCPY_SIZE_EXT
• STRUCTURE_TYPE_HOST_IMAGE_COPY_DEVICE_PERFORMANCE_QUERY_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_PROPERTIES_EXT

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_PROPERTIES_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_FEATURES_EXT
• STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_PROPERTIES_EXT
• STRUCTURE_TYPE_MEMORY_TO_IMAGE_COPY_EXT
• STRUCTURE_TYPE_IMAGE_TO_MEMORY_COPY_EXT
• STRUCTURE_TYPE_COPY_IMAGE_TO_MEMORY_INFO_EXT
• STRUCTURE_TYPE_COPY_MEMORY_TO_IMAGE_INFO_EXT
• STRUCTURE_TYPE_HOST_IMAGE_LAYOUT_TRANSITION_INFO_EXT
• STRUCTURE_TYPE_COPY_IMAGE_TO_IMAGE_INFO_EXT
• STRUCTURE_TYPE_SUBRESOURCE_HOST_MEMCPY_SIZE_EXT
• STRUCTURE_TYPE_HOST_IMAGE_COPY_DEVICE_PERFORMANCE_QUERY_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_MEMORY_TO_IMAGE_COPY_EXT

public static final int VK_STRUCTURE_TYPE_MEMORY_TO_IMAGE_COPY_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_FEATURES_EXT
• STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_PROPERTIES_EXT
• STRUCTURE_TYPE_MEMORY_TO_IMAGE_COPY_EXT
• STRUCTURE_TYPE_IMAGE_TO_MEMORY_COPY_EXT
• STRUCTURE_TYPE_COPY_IMAGE_TO_MEMORY_INFO_EXT
• STRUCTURE_TYPE_COPY_MEMORY_TO_IMAGE_INFO_EXT
• STRUCTURE_TYPE_HOST_IMAGE_LAYOUT_TRANSITION_INFO_EXT
• STRUCTURE_TYPE_COPY_IMAGE_TO_IMAGE_INFO_EXT
• STRUCTURE_TYPE_SUBRESOURCE_HOST_MEMCPY_SIZE_EXT
• STRUCTURE_TYPE_HOST_IMAGE_COPY_DEVICE_PERFORMANCE_QUERY_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_IMAGE_TO_MEMORY_COPY_EXT

public static final int VK_STRUCTURE_TYPE_IMAGE_TO_MEMORY_COPY_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_FEATURES_EXT
• STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_PROPERTIES_EXT
• STRUCTURE_TYPE_MEMORY_TO_IMAGE_COPY_EXT
• STRUCTURE_TYPE_IMAGE_TO_MEMORY_COPY_EXT
• STRUCTURE_TYPE_COPY_IMAGE_TO_MEMORY_INFO_EXT
• STRUCTURE_TYPE_COPY_MEMORY_TO_IMAGE_INFO_EXT
• STRUCTURE_TYPE_HOST_IMAGE_LAYOUT_TRANSITION_INFO_EXT
• STRUCTURE_TYPE_COPY_IMAGE_TO_IMAGE_INFO_EXT
• STRUCTURE_TYPE_SUBRESOURCE_HOST_MEMCPY_SIZE_EXT
• STRUCTURE_TYPE_HOST_IMAGE_COPY_DEVICE_PERFORMANCE_QUERY_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_COPY_IMAGE_TO_MEMORY_INFO_EXT

public static final int VK_STRUCTURE_TYPE_COPY_IMAGE_TO_MEMORY_INFO_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_FEATURES_EXT
• STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_PROPERTIES_EXT
• STRUCTURE_TYPE_MEMORY_TO_IMAGE_COPY_EXT
• STRUCTURE_TYPE_IMAGE_TO_MEMORY_COPY_EXT
• STRUCTURE_TYPE_COPY_IMAGE_TO_MEMORY_INFO_EXT
• STRUCTURE_TYPE_COPY_MEMORY_TO_IMAGE_INFO_EXT
• STRUCTURE_TYPE_HOST_IMAGE_LAYOUT_TRANSITION_INFO_EXT
• STRUCTURE_TYPE_COPY_IMAGE_TO_IMAGE_INFO_EXT
• STRUCTURE_TYPE_SUBRESOURCE_HOST_MEMCPY_SIZE_EXT
• STRUCTURE_TYPE_HOST_IMAGE_COPY_DEVICE_PERFORMANCE_QUERY_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_COPY_MEMORY_TO_IMAGE_INFO_EXT

public static final int VK_STRUCTURE_TYPE_COPY_MEMORY_TO_IMAGE_INFO_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_FEATURES_EXT
• STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_PROPERTIES_EXT
• STRUCTURE_TYPE_MEMORY_TO_IMAGE_COPY_EXT
• STRUCTURE_TYPE_IMAGE_TO_MEMORY_COPY_EXT
• STRUCTURE_TYPE_COPY_IMAGE_TO_MEMORY_INFO_EXT
• STRUCTURE_TYPE_COPY_MEMORY_TO_IMAGE_INFO_EXT
• STRUCTURE_TYPE_HOST_IMAGE_LAYOUT_TRANSITION_INFO_EXT
• STRUCTURE_TYPE_COPY_IMAGE_TO_IMAGE_INFO_EXT
• STRUCTURE_TYPE_SUBRESOURCE_HOST_MEMCPY_SIZE_EXT
• STRUCTURE_TYPE_HOST_IMAGE_COPY_DEVICE_PERFORMANCE_QUERY_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_HOST_IMAGE_LAYOUT_TRANSITION_INFO_EXT

public static final int VK_STRUCTURE_TYPE_HOST_IMAGE_LAYOUT_TRANSITION_INFO_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_FEATURES_EXT
• STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_PROPERTIES_EXT
• STRUCTURE_TYPE_MEMORY_TO_IMAGE_COPY_EXT
• STRUCTURE_TYPE_IMAGE_TO_MEMORY_COPY_EXT
• STRUCTURE_TYPE_COPY_IMAGE_TO_MEMORY_INFO_EXT
• STRUCTURE_TYPE_COPY_MEMORY_TO_IMAGE_INFO_EXT
• STRUCTURE_TYPE_HOST_IMAGE_LAYOUT_TRANSITION_INFO_EXT
• STRUCTURE_TYPE_COPY_IMAGE_TO_IMAGE_INFO_EXT
• STRUCTURE_TYPE_SUBRESOURCE_HOST_MEMCPY_SIZE_EXT
• STRUCTURE_TYPE_HOST_IMAGE_COPY_DEVICE_PERFORMANCE_QUERY_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_COPY_IMAGE_TO_IMAGE_INFO_EXT

public static final int VK_STRUCTURE_TYPE_COPY_IMAGE_TO_IMAGE_INFO_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_FEATURES_EXT
• STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_PROPERTIES_EXT
• STRUCTURE_TYPE_MEMORY_TO_IMAGE_COPY_EXT
• STRUCTURE_TYPE_IMAGE_TO_MEMORY_COPY_EXT
• STRUCTURE_TYPE_COPY_IMAGE_TO_MEMORY_INFO_EXT
• STRUCTURE_TYPE_COPY_MEMORY_TO_IMAGE_INFO_EXT
• STRUCTURE_TYPE_HOST_IMAGE_LAYOUT_TRANSITION_INFO_EXT
• STRUCTURE_TYPE_COPY_IMAGE_TO_IMAGE_INFO_EXT
• STRUCTURE_TYPE_SUBRESOURCE_HOST_MEMCPY_SIZE_EXT
• STRUCTURE_TYPE_HOST_IMAGE_COPY_DEVICE_PERFORMANCE_QUERY_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_SUBRESOURCE_HOST_MEMCPY_SIZE_EXT

public static final int VK_STRUCTURE_TYPE_SUBRESOURCE_HOST_MEMCPY_SIZE_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_FEATURES_EXT
• STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_PROPERTIES_EXT
• STRUCTURE_TYPE_MEMORY_TO_IMAGE_COPY_EXT
• STRUCTURE_TYPE_IMAGE_TO_MEMORY_COPY_EXT
• STRUCTURE_TYPE_COPY_IMAGE_TO_MEMORY_INFO_EXT
• STRUCTURE_TYPE_COPY_MEMORY_TO_IMAGE_INFO_EXT
• STRUCTURE_TYPE_HOST_IMAGE_LAYOUT_TRANSITION_INFO_EXT
• STRUCTURE_TYPE_COPY_IMAGE_TO_IMAGE_INFO_EXT
• STRUCTURE_TYPE_SUBRESOURCE_HOST_MEMCPY_SIZE_EXT
• STRUCTURE_TYPE_HOST_IMAGE_COPY_DEVICE_PERFORMANCE_QUERY_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_HOST_IMAGE_COPY_DEVICE_PERFORMANCE_QUERY_EXT

public static final int VK_STRUCTURE_TYPE_HOST_IMAGE_COPY_DEVICE_PERFORMANCE_QUERY_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_FEATURES_EXT
• STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_PROPERTIES_EXT
• STRUCTURE_TYPE_MEMORY_TO_IMAGE_COPY_EXT
• STRUCTURE_TYPE_IMAGE_TO_MEMORY_COPY_EXT
• STRUCTURE_TYPE_COPY_IMAGE_TO_MEMORY_INFO_EXT
• STRUCTURE_TYPE_COPY_MEMORY_TO_IMAGE_INFO_EXT
• STRUCTURE_TYPE_HOST_IMAGE_LAYOUT_TRANSITION_INFO_EXT
• STRUCTURE_TYPE_COPY_IMAGE_TO_IMAGE_INFO_EXT
• STRUCTURE_TYPE_SUBRESOURCE_HOST_MEMCPY_SIZE_EXT
• STRUCTURE_TYPE_HOST_IMAGE_COPY_DEVICE_PERFORMANCE_QUERY_EXT

See Also:

• Constant Field Values

VK_IMAGE_USAGE_HOST_TRANSFER_BIT_EXT

public static final int VK_IMAGE_USAGE_HOST_TRANSFER_BIT_EXT

Extends VkImageUsageFlagBits.

See Also:

• Constant Field Values

VK_FORMAT_FEATURE_2_HOST_IMAGE_TRANSFER_BIT_EXT

public static final long VK_FORMAT_FEATURE_2_HOST_IMAGE_TRANSFER_BIT_EXT

Extends VkFormatFeatureFlagBits2.

See Also:

• Constant Field Values

VK_HOST_IMAGE_COPY_MEMCPY_EXT

public static final int VK_HOST_IMAGE_COPY_MEMCPY_EXT

VkHostImageCopyFlagBitsEXT - Bitmask specifying additional copy parameters

Description

• HOST_IMAGE_COPY_MEMCPY_EXT specifies that no memory layout swizzling is to be applied during data copy. For copies between memory and images, this flag indicates that image data in host memory is swizzled in exactly the same way as the image data on the device. Using this flag indicates that the implementations may use a simple memory copy to transfer the data between the host memory and the device memory. The format of the swizzled data in host memory is platform dependent and is not defined in this specification.

See Also:

• Constant Field Values

Method Details

nvkCopyMemoryToImageEXT

public static int nvkCopyMemoryToImageEXT(org.lwjgl.vulkan.VkDevice device,
 long pCopyMemoryToImageInfo)

Unsafe version of: CopyMemoryToImageEXT

vkCopyMemoryToImageEXT

public static int vkCopyMemoryToImageEXT(org.lwjgl.vulkan.VkDevice device,
 VkCopyMemoryToImageInfoEXT pCopyMemoryToImageInfo)

Copy data from host memory into an image.

C Specification

To copy data from host memory to an image object, call:

 VkResult vkCopyMemoryToImageEXT(
     VkDevice                                    device,
     const VkCopyMemoryToImageInfoEXT*           pCopyMemoryToImageInfo);

Description

This command is functionally similar to CmdCopyBufferToImage2, except it is executed on the host and reads from host memory instead of a buffer. The memory of pCopyMemoryToImageInfo→dstImage is accessed by the host as if coherent.

Note

Because queue submissions automatically make host memory visible to the device, there would not be a need for a memory barrier before using the results of this copy operation on the device.

Valid Usage

• The hostImageCopy feature must be enabled

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pCopyMemoryToImageInfo must be a valid pointer to a valid VkCopyMemoryToImageInfoEXT structure

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_INITIALIZATION_FAILED
• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_MEMORY_MAP_FAILED

See Also

VkCopyMemoryToImageInfoEXT

Parameters:

device - the device which owns pCopyMemoryToImageInfo→dstImage.

pCopyMemoryToImageInfo - a pointer to a VkCopyMemoryToImageInfoEXT structure describing the copy parameters.

nvkCopyImageToMemoryEXT

public static int nvkCopyImageToMemoryEXT(org.lwjgl.vulkan.VkDevice device,
 long pCopyImageToMemoryInfo)

Unsafe version of: CopyImageToMemoryEXT

vkCopyImageToMemoryEXT

public static int vkCopyImageToMemoryEXT(org.lwjgl.vulkan.VkDevice device,
 VkCopyImageToMemoryInfoEXT pCopyImageToMemoryInfo)

Copy image data into host memory.

C Specification

To copy data from an image object to host memory, call:

 VkResult vkCopyImageToMemoryEXT(
     VkDevice                                    device,
     const VkCopyImageToMemoryInfoEXT*           pCopyImageToMemoryInfo);

Description

This command is functionally similar to CmdCopyImageToBuffer2, except it is executed on the host and writes to host memory instead of a buffer. The memory of pCopyImageToMemoryInfo→srcImage is accessed by the host as if coherent.

Note

If the device has written to the image memory, it is not automatically made available to the host. Before this copy command can be called, a memory barrier for this image must have been issued on the device with the second synchronization scope including PIPELINE_STAGE_HOST_BIT and ACCESS_HOST_READ_BIT.

Valid Usage

• The hostImageCopy feature must be enabled

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pCopyImageToMemoryInfo must be a valid pointer to a valid VkCopyImageToMemoryInfoEXT structure

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_INITIALIZATION_FAILED
• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_MEMORY_MAP_FAILED

See Also

VkCopyImageToMemoryInfoEXT

Parameters:

device - the device which owns pCopyImageToMemoryInfo→srcImage.

pCopyImageToMemoryInfo - a pointer to a VkCopyImageToMemoryInfoEXT structure describing the copy parameters.

nvkCopyImageToImageEXT

public static int nvkCopyImageToImageEXT(org.lwjgl.vulkan.VkDevice device,
 long pCopyImageToImageInfo)

Unsafe version of: CopyImageToImageEXT

vkCopyImageToImageEXT

public static int vkCopyImageToImageEXT(org.lwjgl.vulkan.VkDevice device,
 VkCopyImageToImageInfoEXT pCopyImageToImageInfo)

Copy image data using the host.

C Specification

To copy data from an image object to another image object using the host, call:

 VkResult vkCopyImageToImageEXT(
     VkDevice                                    device,
     const VkCopyImageToImageInfoEXT*            pCopyImageToImageInfo);

Description

This command is functionally similar to CmdCopyImage2, except it is executed on the host. The memory of pCopyImageToImageInfo→srcImage and pCopyImageToImageInfo→dstImage is accessed by the host as if coherent.

Note

If the device has written to the memory of pCopyImageToImageInfo→srcImage, it is not automatically made available to the host. Before this copy command can be called, a memory barrier for this image must have been issued on the device with the second synchronization scope including PIPELINE_STAGE_HOST_BIT and ACCESS_HOST_READ_BIT.

Because queue submissions automatically make host memory visible to the device, there would not be a need for a memory barrier before using the results of this copy operation in pCopyMemoryToImageInfo→dstImage on the device.

Valid Usage

• The hostImageCopy feature must be enabled

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pCopyImageToImageInfo must be a valid pointer to a valid VkCopyImageToImageInfoEXT structure

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_INITIALIZATION_FAILED
• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_MEMORY_MAP_FAILED

See Also

VkCopyImageToImageInfoEXT

Parameters:

device - the device which owns pCopyImageToImageInfo→srcImage and pCopyImageToImageInfo→dstImage.

pCopyImageToImageInfo - a pointer to a VkCopyImageToImageInfoEXT structure describing the copy parameters.

nvkTransitionImageLayoutEXT

public static int nvkTransitionImageLayoutEXT(org.lwjgl.vulkan.VkDevice device,
 int transitionCount,
 long pTransitions)

Unsafe version of: TransitionImageLayoutEXT

Parameters:

transitionCount - the number of image layout transitions to perform.

vkTransitionImageLayoutEXT

public static int vkTransitionImageLayoutEXT(org.lwjgl.vulkan.VkDevice device,
 VkHostImageLayoutTransitionInfoEXT.Buffer pTransitions)

Perform an image layout transition on the host.

C Specification

To perform an image layout transition on the host, call:

 VkResult vkTransitionImageLayoutEXT(
     VkDevice                                    device,
     uint32_t                                    transitionCount,
     const VkHostImageLayoutTransitionInfoEXT*   pTransitions);

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pTransitions must be a valid pointer to an array of transitionCount valid VkHostImageLayoutTransitionInfoEXT structures
• transitionCount must be greater than 0

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_INITIALIZATION_FAILED
• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_MEMORY_MAP_FAILED

See Also

VkHostImageLayoutTransitionInfoEXT

Parameters:

device - the device which owns pTransitions[i].image.

pTransitions - a pointer to an array of VkHostImageLayoutTransitionInfoEXT structures specifying the image and subresource ranges within them to transition.

nvkGetImageSubresourceLayout2EXT

public static void nvkGetImageSubresourceLayout2EXT(org.lwjgl.vulkan.VkDevice device,
 long image,
 long pSubresource,
 long pLayout)

Unsafe version of: GetImageSubresourceLayout2EXT

vkGetImageSubresourceLayout2EXT

public static void vkGetImageSubresourceLayout2EXT(org.lwjgl.vulkan.VkDevice device,
 long image,
 VkImageSubresource2KHR pSubresource,
 VkSubresourceLayout2KHR pLayout)

See GetImageSubresourceLayout2KHR.

Parameters:

device - the logical device that owns the image.

image - the image whose layout is being queried.

pSubresource - a pointer to a VkImageSubresource2KHR structure selecting a specific image for the image subresource.

pLayout - a pointer to a VkSubresourceLayout2KHR structure in which the layout is returned.