org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCopyImageToImageInfo>

org.lwjgl.vulkan.VkCopyImageToImageInfo

All Implemented Interfaces:: AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

Direct Known Subclasses:: VkCopyImageToImageInfoEXT

public class VkCopyImageToImageInfo extends org.lwjgl.system.Struct<VkCopyImageToImageInfo> implements org.lwjgl.system.NativeResource

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

Description

vkCopyImageToImage 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, srcImage must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT set in VkImageCreateInfo::usage
If the stencil aspect of srcImage is accessed, and srcImage was created with separate stencil usage, srcImage must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT set in VkImageStencilUsageCreateInfo::stencilUsage
If non-stencil aspects of srcImage are accessed, srcImage must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT set in VkImageCreateInfo::usage
If flags contains HOST_IMAGE_COPY_MEMCPY, 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, 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
If srcSubresource.layerCount is not REMAINING_ARRAY_LAYERS, srcSubresource.baseArrayLayer + srcSubresource.layerCount of each element of pRegions 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, if VkCopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR or SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, srcOffset.x must be a multiple of the texel block extent width of the VkFormat of srcImage
For each element of pRegions, if VkCopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR or SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, and srcOffset.x does not equal the width of the subresource specified by srcSubresource, srcOffset.x must be a multiple of the texel block extent width of the VkFormat of srcImage
For each element of pRegions, if VkCopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR or SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, srcOffset.y must be a multiple of the texel block extent height of the VkFormat of srcImage
For each element of pRegions, if VkCopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR or SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, and srcOffset.y does not equal the height of the subresource specified by srcSubresource, 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 VkCopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR, 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 VkCopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, the difference of srcOffset.x and extent.height must be a multiple of the texel block extent width of the VkFormat of srcImage
For each element of pRegions, if VkCopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, the difference of srcOffset.x and extent.width must be a multiple of the texel block extent width of the VkFormat of srcImage
For each element of pRegions, if VkCopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, the sum of srcOffset.x and extent.height does not equal the width of the subresource specified by srcSubresource, extent.height must be a multiple of the texel block extent width of the VkFormat of srcImage
For each element of pRegions, if VkCopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR, and 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 VkCopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, the sum of srcOffset.y and extent.width does not equal the height of the subresource specified by srcSubresource, extent.width must be a multiple of the texel block extent height of the VkFormat of srcImage
For each element of pRegions, if VkCopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, the difference of srcOffset.y and extent.height must be a multiple of the texel block extent height of the VkFormat of srcImage
For each element of pRegions, if VkCopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, the difference of srcOffset.y and extent.width 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, dstImage must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT set in VkImageCreateInfo::usage
If the stencil aspect of dstImage is accessed, and dstImage was created with separate stencil usage, dstImage must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT set in VkImageStencilUsageCreateInfo::stencilUsage
If non-stencil aspects of dstImage are accessed, dstImage must have been created with IMAGE_USAGE_HOST_TRANSFER_BIT set in VkImageCreateInfo::usage
If flags contains HOST_IMAGE_COPY_MEMCPY, 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, 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
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, if VkCopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR or SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, dstOffset.x must be a multiple of the texel block extent width of the VkFormat of dstImage
For each element of pRegions, if VkCopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR or SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, and dstOffset.x does not equal the width of the subresource specified by dstSubresource, dstOffset.x must be a multiple of the texel block extent width of the VkFormat of dstImage
For each element of pRegions, if VkCopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR or SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, dstOffset.y must be a multiple of the texel block extent height of the VkFormat of dstImage
For each element of pRegions, if VkCopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR or SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, and dstOffset.y does not equal the height of the subresource specified by dstSubresource, 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 VkCopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR, the sum of dstOffset.x and extent.width does not equal the width of the subresource specified by dstSubresource, extent.width must be a multiple of the texel block extent width of the VkFormat of dstImage
For each element of pRegions, if VkCopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, the difference of dstOffset.x and extent.height must be a multiple of the texel block extent width of the VkFormat of dstImage
For each element of pRegions, if VkCopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, the difference of dstOffset.x and extent.width must be a multiple of the texel block extent width of the VkFormat of dstImage
For each element of pRegions, if VkCopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, the sum of dstOffset.x and extent.height does not equal the width of the subresource specified by dstSubresource, extent.height must be a multiple of the texel block extent width of the VkFormat of dstImage
For each element of pRegions, if VkCopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR, and the sum of dstOffset.y and extent.height does not equal the height of the subresource specified by dstSubresource, extent.height must be a multiple of the texel block extent height of the VkFormat of dstImage
For each element of pRegions, if VkCopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_90_BIT_KHR, the sum of dstOffset.y and extent.width does not equal the height of the subresource specified by dstSubresource, extent.width must be a multiple of the texel block extent height of the VkFormat of dstImage
For each element of pRegions, if VkCopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_180_BIT_KHR, the difference of dstOffset.y and extent.height must be a multiple of the texel block extent height of the VkFormat of dstImage
For each element of pRegions, if VkCopyCommandTransformInfoQCOM::transform is equal to SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, the difference of dstOffset.y and extent.width 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 VkPhysicalDeviceHostImageCopyProperties::pCopySrcLayouts
dstImageLayout must be one of the image layouts returned in VkPhysicalDeviceHostImageCopyProperties::pCopyDstLayouts

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_COPY_IMAGE_TO_IMAGE_INFO
pNext must be NULL
flags must be a valid combination of VkHostImageCopyFlagBits 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 VkCopyImageToImageInfo {
     VkStructureType sType();
     void const * pNext();
     VkHostImageCopyFlags flags();
     VkImage srcImage();
     VkImageLayout srcImageLayout();
     VkImage dstImage();
     VkImageLayout dstImageLayout();
     uint32_t regionCount();
     VkImageCopy2 const * pRegions();
 }

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

VkCopyImageToImageInfo.Buffer

An array of VkCopyImageToImageInfo structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default
Field Summary

Fields

Modifier and Type

Field

Description

static final int

ALIGNOF

The struct alignment in bytes.

static final int

DSTIMAGE

The struct member offsets.

static final int

DSTIMAGELAYOUT

The struct member offsets.

static final int

FLAGS

The struct member offsets.

static final int

PNEXT

The struct member offsets.

static final int

PREGIONS

The struct member offsets.

static final int

REGIONCOUNT

The struct member offsets.

static final int

SIZEOF

The struct size in bytes.

static final int

SRCIMAGE

The struct member offsets.

static final int

SRCIMAGELAYOUT

The struct member offsets.

static final int

STYPE

The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
Constructor Summary

Constructors

Constructor

Description

VkCopyImageToImageInfo(ByteBuffer container)

Creates a VkCopyImageToImageInfo instance at the current position of the specified ByteBuffer container.
Method Summary

Modifier and Type

Method

Description

static VkCopyImageToImageInfo

calloc()

Returns a new VkCopyImageToImageInfo instance allocated with memCalloc.

static VkCopyImageToImageInfo.Buffer

calloc(int capacity)

Returns a new VkCopyImageToImageInfo.Buffer instance allocated with memCalloc.

static VkCopyImageToImageInfo.Buffer

calloc(int capacity, org.lwjgl.system.MemoryStack stack)

Returns a new VkCopyImageToImageInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

static VkCopyImageToImageInfo

calloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkCopyImageToImageInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.

static VkCopyImageToImageInfo

create()

Returns a new VkCopyImageToImageInfo instance allocated with BufferUtils.

static VkCopyImageToImageInfo.Buffer

create(int capacity)

Returns a new VkCopyImageToImageInfo.Buffer instance allocated with BufferUtils.

static VkCopyImageToImageInfo

create(long address)

Returns a new VkCopyImageToImageInfo instance for the specified memory address.

static VkCopyImageToImageInfo.Buffer

create(long address, int capacity)

Create a VkCopyImageToImageInfo.Buffer instance at the specified memory.

static @Nullable VkCopyImageToImageInfo

createSafe(long address)

Like create, but returns null if address is NULL.

static @Nullable VkCopyImageToImageInfo.Buffer

createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

long

dstImage()

the destination image.

VkCopyImageToImageInfo

dstImage(long value)

Sets the specified value to the dstImage() field.

int

dstImageLayout()

the layout of the destination image subresources for the copy.

VkCopyImageToImageInfo

dstImageLayout(int value)

Sets the specified value to the dstImageLayout() field.

int

flags()

a bitmask of VkHostImageCopyFlagBits values describing additional copy parameters.

VkCopyImageToImageInfo

flags(int value)

Sets the specified value to the flags() field.

static VkCopyImageToImageInfo

malloc()

Returns a new VkCopyImageToImageInfo instance allocated with memAlloc.

static VkCopyImageToImageInfo.Buffer

malloc(int capacity)

Returns a new VkCopyImageToImageInfo.Buffer instance allocated with memAlloc.

static VkCopyImageToImageInfo.Buffer

malloc(int capacity, org.lwjgl.system.MemoryStack stack)

Returns a new VkCopyImageToImageInfo.Buffer instance allocated on the specified MemoryStack.

static VkCopyImageToImageInfo

malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkCopyImageToImageInfo instance allocated on the specified MemoryStack.

static long

ndstImage(long struct)

Unsafe version of dstImage().

static void

ndstImage(long struct, long value)

Unsafe version of dstImage.

static int

ndstImageLayout(long struct)

Unsafe version of dstImageLayout().

static void

ndstImageLayout(long struct, int value)

Unsafe version of dstImageLayout.

static int

nflags(long struct)

Unsafe version of flags().

static void

nflags(long struct, int value)

Unsafe version of flags.

static long

npNext(long struct)

Unsafe version of pNext().

static void

npNext(long struct, long value)

Unsafe version of pNext.

static VkImageCopy2.Buffer

npRegions(long struct)

Unsafe version of pRegions().

static void

npRegions(long struct, VkImageCopy2.Buffer value)

Unsafe version of pRegions.

static int

nregionCount(long struct)

Unsafe version of regionCount().

static void

nregionCount(long struct, int value)

Sets the specified value to the regionCount field of the specified struct.

static long

nsrcImage(long struct)

Unsafe version of srcImage().

static void

nsrcImage(long struct, long value)

Unsafe version of srcImage.

static int

nsrcImageLayout(long struct)

Unsafe version of srcImageLayout().

static void

nsrcImageLayout(long struct, int value)

Unsafe version of srcImageLayout.

static int

nsType(long struct)

Unsafe version of sType().

static void

nsType(long struct, int value)

Unsafe version of sType.

long

pNext()

NULL or a pointer to a structure extending this structure.

VkCopyImageToImageInfo

pNext(long value)

Sets the specified value to the pNext() field.

VkImageCopy2.Buffer

pRegions()

a pointer to an array of VkImageCopy2 structures specifying the regions to copy.

VkCopyImageToImageInfo

pRegions(VkImageCopy2.Buffer value)

Sets the address of the specified VkImageCopy2.Buffer to the pRegions() field.

int

regionCount()

the number of regions to copy.

VkCopyImageToImageInfo

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.

VkCopyImageToImageInfo

set(VkCopyImageToImageInfo src)

Copies the specified struct data to this struct.

int

sizeof()

long

srcImage()

the source image.

VkCopyImageToImageInfo

srcImage(long value)

Sets the specified value to the srcImage() field.

int

srcImageLayout()

the layout of the source image subresources for the copy.

VkCopyImageToImageInfo

srcImageLayout(int value)

Sets the specified value to the srcImageLayout() field.

int

sType()

a VkStructureType value identifying this structure.

VkCopyImageToImageInfo

sType(int value)

Sets the specified value to the sType() field.

VkCopyImageToImageInfo

sType$Default()

Sets the STRUCTURE_TYPE_COPY_IMAGE_TO_IMAGE_INFO value to the sType() field.

static void

validate(long struct)

Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

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.
- SRCIMAGE
  
  public static final int SRCIMAGE
  
  The struct member offsets.
- SRCIMAGELAYOUT
  
  public static final int SRCIMAGELAYOUT
  
  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
- VkCopyImageToImageInfo
  
  public VkCopyImageToImageInfo(ByteBuffer container)
  
  Creates a VkCopyImageToImageInfo 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
- sizeof
  
  public int sizeof()
  
  Specified by:
  
  sizeof in class org.lwjgl.system.Struct<VkCopyImageToImageInfo>
- sType
  
  public int sType()
  
  a VkStructureType value identifying this structure.
- pNext
  
  public long pNext()
  
  NULL or a pointer to a structure extending this structure.
- flags
  
  public int flags()
  
  a bitmask of VkHostImageCopyFlagBits values describing additional copy parameters.
- srcImage
  
  public long srcImage()
  
  the source image.
- srcImageLayout
  
  public int srcImageLayout()
  
  the layout of the source image subresources for the copy.
- dstImage
  
  public long dstImage()
  
  the destination image.
- dstImageLayout
  
  public int dstImageLayout()
  
  the layout of the destination image subresources for the copy.
- regionCount
  
  public int regionCount()
  
  the number of regions to copy.
- pRegions
  
  public VkImageCopy2.Buffer pRegions()
  
  a pointer to an array of VkImageCopy2 structures specifying the regions to copy.
- sType
  
  public VkCopyImageToImageInfo sType(int value)
  
  Sets the specified value to the sType() field.
- sType$Default
  
  public VkCopyImageToImageInfo sType$Default()
  
  Sets the STRUCTURE_TYPE_COPY_IMAGE_TO_IMAGE_INFO value to the sType() field.
- pNext
  
  public VkCopyImageToImageInfo pNext(long value)
  
  Sets the specified value to the pNext() field.
- flags
  
  public VkCopyImageToImageInfo flags(int value)
  
  Sets the specified value to the flags() field.
- srcImage
  
  public VkCopyImageToImageInfo srcImage(long value)
  
  Sets the specified value to the srcImage() field.
- srcImageLayout
  
  public VkCopyImageToImageInfo srcImageLayout(int value)
  
  Sets the specified value to the srcImageLayout() field.
- dstImage
  
  public VkCopyImageToImageInfo dstImage(long value)
  
  Sets the specified value to the dstImage() field.
- dstImageLayout
  
  public VkCopyImageToImageInfo dstImageLayout(int value)
  
  Sets the specified value to the dstImageLayout() field.
- pRegions
  
  public VkCopyImageToImageInfo pRegions(VkImageCopy2.Buffer value)
  
  Sets the address of the specified VkImageCopy2.Buffer to the pRegions() field.
- set
  
  public VkCopyImageToImageInfo 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.
- set
  
  public VkCopyImageToImageInfo set(VkCopyImageToImageInfo src)
  
  Copies the specified struct data to this struct.
  
  Parameters:
  
  src - the source struct
  
  Returns:
  
  this struct
- malloc
  
  public static VkCopyImageToImageInfo malloc()
  
  Returns a new VkCopyImageToImageInfo instance allocated with memAlloc. The instance must be explicitly freed.
- calloc
  
  public static VkCopyImageToImageInfo calloc()
  
  Returns a new VkCopyImageToImageInfo instance allocated with memCalloc. The instance must be explicitly freed.
- create
  
  public static VkCopyImageToImageInfo create()
  
  Returns a new VkCopyImageToImageInfo instance allocated with BufferUtils.
- create
  
  public static VkCopyImageToImageInfo create(long address)
  
  Returns a new VkCopyImageToImageInfo instance for the specified memory address.
- createSafe
  
  public static @Nullable VkCopyImageToImageInfo createSafe(long address)
  
  Like create, but returns null if address is NULL.
- malloc
  
  public static VkCopyImageToImageInfo.Buffer malloc(int capacity)
  
  Returns a new VkCopyImageToImageInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- calloc
  
  public static VkCopyImageToImageInfo.Buffer calloc(int capacity)
  
  Returns a new VkCopyImageToImageInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static VkCopyImageToImageInfo.Buffer create(int capacity)
  
  Returns a new VkCopyImageToImageInfo.Buffer instance allocated with BufferUtils.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static VkCopyImageToImageInfo.Buffer create(long address, int capacity)
  
  Create a VkCopyImageToImageInfo.Buffer instance at the specified memory.
  
  Parameters:
  
  address - the memory address
  
  capacity - the buffer capacity
- createSafe
  
  public static @Nullable VkCopyImageToImageInfo.Buffer createSafe(long address, int capacity)
  
  Like create, but returns null if address is NULL.
- malloc
  
  public static VkCopyImageToImageInfo malloc(org.lwjgl.system.MemoryStack stack)
  
  Returns a new VkCopyImageToImageInfo instance allocated on the specified MemoryStack.
  
  Parameters:
  
  stack - the stack from which to allocate
- calloc
  
  public static VkCopyImageToImageInfo calloc(org.lwjgl.system.MemoryStack stack)
  
  Returns a new VkCopyImageToImageInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
  
  Parameters:
  
  stack - the stack from which to allocate
- malloc
  
  public static VkCopyImageToImageInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
  
  Returns a new VkCopyImageToImageInfo.Buffer instance allocated on the specified MemoryStack.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- calloc
  
  public static VkCopyImageToImageInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
  
  Returns a new VkCopyImageToImageInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- nsType
  
  public static int nsType(long struct)
  
  Unsafe version of sType().
- npNext
  
  public static long npNext(long struct)
  
  Unsafe version of pNext().
- nflags
  
  public static int nflags(long struct)
  
  Unsafe version of flags().
- nsrcImage
  
  public static long nsrcImage(long struct)
  
  Unsafe version of srcImage().
- nsrcImageLayout
  
  public static int nsrcImageLayout(long struct)
  
  Unsafe version of srcImageLayout().
- ndstImage
  
  public static long ndstImage(long struct)
  
  Unsafe version of dstImage().
- ndstImageLayout
  
  public static int ndstImageLayout(long struct)
  
  Unsafe version of dstImageLayout().
- nregionCount
  
  public static int nregionCount(long struct)
  
  Unsafe version of regionCount().
- npRegions
  
  public static VkImageCopy2.Buffer npRegions(long struct)
  
  Unsafe version of pRegions().
- nsType
  
  public static void nsType(long struct, int value)
  
  Unsafe version of sType.
- npNext
  
  public static void npNext(long struct, long value)
  
  Unsafe version of pNext.
- nflags
  
  public static void nflags(long struct, int value)
  
  Unsafe version of flags.
- nsrcImage
  
  public static void nsrcImage(long struct, long value)
  
  Unsafe version of srcImage.
- nsrcImageLayout
  
  public static void nsrcImageLayout(long struct, int value)
  
  Unsafe version of srcImageLayout.
- ndstImage
  
  public static void ndstImage(long struct, long value)
  
  Unsafe version of dstImage.
- ndstImageLayout
  
  public static void ndstImageLayout(long struct, int value)
  
  Unsafe version of dstImageLayout.
- nregionCount
  
  public static void nregionCount(long struct, int value)
  
  Sets the specified value to the regionCount field of the specified struct.
- npRegions
  
  public static void npRegions(long struct, VkImageCopy2.Buffer value)
  
  Unsafe version of pRegions.
- validate
  
  public static void validate(long struct)
  
  Validates pointer members that should not be NULL.
  
  Parameters:
  
  struct - the struct to validate

Class VkCopyImageToImageInfo

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested Class Summary

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Details

SIZEOF

ALIGNOF

STYPE

PNEXT

FLAGS

SRCIMAGE

SRCIMAGELAYOUT

DSTIMAGE

DSTIMAGELAYOUT

REGIONCOUNT

PREGIONS

Constructor Details

VkCopyImageToImageInfo

Method Details

sizeof

sType

pNext

flags

srcImage

srcImageLayout

dstImage

dstImageLayout

regionCount

pRegions

sType

sType$Default

pNext

flags

srcImage

srcImageLayout

dstImage

dstImageLayout

pRegions

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nsType

npNext

nflags

nsrcImage

nsrcImageLayout

ndstImage

ndstImageLayout

nregionCount

npRegions

nsType

npNext

nflags

nsrcImage