java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkImageCopy

All Implemented Interfaces:

java.lang.AutoCloseable, NativeResource, Pointer
```
public class VkImageCopy
extends Struct
```
Khronos Reference Page
Vulkan Specification
Specifies the image regions to copy.

Valid Usage
- srcSubresource must be a valid VkImageSubresourceLayers structure
- dstSubresource must be a valid VkImageSubresourceLayers structure
- The aspectMask member of srcSubresource and dstSubresource must match
- The layerCount member of srcSubresource and dstSubresource must match
- If either of the calling command's srcImage or dstImage parameters are of VkImageType IMAGE_TYPE_3D, the baseArrayLayer and layerCount members of both srcSubresource and dstSubresource must be 0 and 1, respectively
- The aspectMask member of srcSubresource must specify aspects present in the calling command's srcImage
- The aspectMask member of dstSubresource must specify aspects present in the calling command's dstImage
- srcOffset.x and (extent.width + srcOffset.x) must both be greater than or equal to 0 and less than or equal to the source image subresource width
- srcOffset.y and (extent.height + srcOffset.y) must both be greater than or equal to 0 and less than or equal to the source image subresource height
- srcOffset.z and (extent.depth + srcOffset.z) must both be greater than or equal to 0 and less than or equal to the source image subresource depth
- dstOffset.x and (extent.width + dstOffset.x) must both be greater than or equal to 0 and less than or equal to the destination image subresource width
- dstOffset.y and (extent.height + dstOffset.y) must both be greater than or equal to 0 and less than or equal to the destination image subresource height
- dstOffset.z and (extent.depth + dstOffset.z) must both be greater than or equal to 0 and less than or equal to the destination image subresource depth
- If the calling command's srcImage is a compressed format image:
- If the calling command's dstImage is a compressed format image:
- srcOffset, dstOffset, and extent must respect the image transfer granularity requirements of the queue family that it will be submitted against, as described in Physical Device Enumeration
Member documentation
- srcSubresource – a VkImageSubresourceLayers structure specifying the image subresource of the image used for the source image data
- srcOffset – selects the initial x, y, and z offsets in texels of the sub-regions of the source image data
- dstSubresource – an VkImageSubresourceLayers structure specifying the image subresource of the image used for the destination image data
- dstOffset – selects the initial x, y, and z offsets in texels of the sub-regions of the destination image data
- extent – the size in texels of the source image to copy in width, height and depth
Layout
```
struct VkImageCopy {
    VkImageSubresourceLayers srcSubresource;
    VkOffset3D srcOffset;
    VkImageSubresourceLayers dstSubresource;
    VkOffset3D dstOffset;
    VkExtent3D extent;
}
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkImageCopy.Buffer
An array of VkImageCopy structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  Pointer.Default

Field Summary

Fields
Modifier and Type Field and Description

static int SIZEOF
The struct size in bytes.
- Fields inherited from interface org.lwjgl.system.Pointer
  POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description

VkImageCopy(java.nio.ByteBuffer container)
Creates a VkImageCopy instance at the current position of the specified ByteBuffer container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkImageCopy`	`calloc()` Returns a new `VkImageCopy` instance allocated with `memCalloc`.
`static VkImageCopy.Buffer`	`calloc(int capacity)` Returns a new `VkImageCopy.Buffer` instance allocated with `memCalloc`.
`static VkImageCopy`	`callocStack()` Returns a new `VkImageCopy` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkImageCopy.Buffer`	`callocStack(int capacity)` Returns a new `VkImageCopy.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkImageCopy.Buffer`	`callocStack(int capacity, MemoryStack stack)` Returns a new `VkImageCopy.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkImageCopy`	`callocStack(MemoryStack stack)` Returns a new `VkImageCopy` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkImageCopy`	`create()` Returns a new `VkImageCopy` instance allocated with `BufferUtils`.
`static VkImageCopy.Buffer`	`create(int capacity)` Returns a new `VkImageCopy.Buffer` instance allocated with `BufferUtils`.
`static VkImageCopy`	`create(long address)` Returns a new `VkImageCopy` instance for the specified memory address or `null` if the address is `NULL`.
`static VkImageCopy.Buffer`	`create(long address, int capacity)` Create a `VkImageCopy.Buffer` instance at the specified memory.
`VkOffset3D`	`dstOffset()` Returns a `VkOffset3D` view of the `dstOffset` field.
`VkImageCopy`	`dstOffset(VkOffset3D value)` Copies the specified `VkOffset3D` to the `dstOffset` field.
`VkImageSubresourceLayers`	`dstSubresource()` Returns a `VkImageSubresourceLayers` view of the `dstSubresource` field.
`VkImageCopy`	`dstSubresource(VkImageSubresourceLayers value)` Copies the specified `VkImageSubresourceLayers` to the `dstSubresource` field.
`VkExtent3D`	`extent()` Returns a `VkExtent3D` view of the `extent` field.
`VkImageCopy`	`extent(VkExtent3D value)` Copies the specified `VkExtent3D` to the `extent` field.
`static VkImageCopy`	`malloc()` Returns a new `VkImageCopy` instance allocated with `memAlloc`.
`static VkImageCopy.Buffer`	`malloc(int capacity)` Returns a new `VkImageCopy.Buffer` instance allocated with `memAlloc`.
`static VkImageCopy`	`mallocStack()` Returns a new `VkImageCopy` instance allocated on the thread-local `MemoryStack`.
`static VkImageCopy.Buffer`	`mallocStack(int capacity)` Returns a new `VkImageCopy.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkImageCopy.Buffer`	`mallocStack(int capacity, MemoryStack stack)` Returns a new `VkImageCopy.Buffer` instance allocated on the specified `MemoryStack`.
`static VkImageCopy`	`mallocStack(MemoryStack stack)` Returns a new `VkImageCopy` instance allocated on the specified `MemoryStack`.
`VkImageCopy`	`nset(long struct)` Unsafe version of `set`.
`VkImageCopy`	`set(VkImageCopy src)` Copies the specified struct data to this struct.
`VkImageCopy`	`set(VkImageSubresourceLayers srcSubresource, VkOffset3D srcOffset, VkImageSubresourceLayers dstSubresource, VkOffset3D dstOffset, VkExtent3D extent)` Initializes this struct with the specified values.
`int`	`sizeof()` Returns the `sizeof(struct)`.
`VkOffset3D`	`srcOffset()` Returns a `VkOffset3D` view of the `srcOffset` field.
`VkImageCopy`	`srcOffset(VkOffset3D value)` Copies the specified `VkOffset3D` to the `srcOffset` field.
`VkImageSubresourceLayers`	`srcSubresource()` Returns a `VkImageSubresourceLayers` view of the `srcSubresource` field.
`VkImageCopy`	`srcSubresource(VkImageSubresourceLayers value)` Copies the specified `VkImageSubresourceLayers` to the `srcSubresource` field.

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

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
- Constructor Detail
  - VkImageCopy
```
public VkImageCopy(java.nio.ByteBuffer container)
```
    Creates a VkImageCopy 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 Detail
  - sizeof
```
public int sizeof()
```
    Description copied from class: Struct
    
    Returns the sizeof(struct).
    
    Specified by:
    
    sizeof in class Struct
  - srcSubresource
```
public VkImageSubresourceLayers srcSubresource()
```
    Returns a VkImageSubresourceLayers view of the srcSubresource field.
  - srcOffset
```
public VkOffset3D srcOffset()
```
    Returns a VkOffset3D view of the srcOffset field.
  - dstSubresource
```
public VkImageSubresourceLayers dstSubresource()
```
    Returns a VkImageSubresourceLayers view of the dstSubresource field.
  - dstOffset
```
public VkOffset3D dstOffset()
```
    Returns a VkOffset3D view of the dstOffset field.
  - extent
```
public VkExtent3D extent()
```
    Returns a VkExtent3D view of the extent field.
  - srcSubresource
```
public VkImageCopy srcSubresource(VkImageSubresourceLayers value)
```
    Copies the specified VkImageSubresourceLayers to the srcSubresource field.
  - srcOffset
```
public VkImageCopy srcOffset(VkOffset3D value)
```
    Copies the specified VkOffset3D to the srcOffset field.
  - dstSubresource
```
public VkImageCopy dstSubresource(VkImageSubresourceLayers value)
```
    Copies the specified VkImageSubresourceLayers to the dstSubresource field.
  - dstOffset
```
public VkImageCopy dstOffset(VkOffset3D value)
```
    Copies the specified VkOffset3D to the dstOffset field.
  - extent
```
public VkImageCopy extent(VkExtent3D value)
```
    Copies the specified VkExtent3D to the extent field.
  - set
```
public VkImageCopy set(VkImageSubresourceLayers srcSubresource,
                       VkOffset3D srcOffset,
                       VkImageSubresourceLayers dstSubresource,
                       VkOffset3D dstOffset,
                       VkExtent3D extent)
```
    Initializes this struct with the specified values.
  - nset
```
public VkImageCopy nset(long struct)
```
    Unsafe version of set.
  - set
```
public VkImageCopy set(VkImageCopy src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkImageCopy malloc()
```
    Returns a new VkImageCopy instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkImageCopy calloc()
```
    Returns a new VkImageCopy instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkImageCopy create()
```
    Returns a new VkImageCopy instance allocated with BufferUtils.
  - create
```
public static VkImageCopy create(long address)
```
    Returns a new VkImageCopy instance for the specified memory address or null if the address is NULL.
  - malloc
```
public static VkImageCopy.Buffer malloc(int capacity)
```
    Returns a new VkImageCopy.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkImageCopy.Buffer calloc(int capacity)
```
    Returns a new VkImageCopy.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkImageCopy.Buffer create(int capacity)
```
    Returns a new VkImageCopy.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkImageCopy.Buffer create(long address,
                                        int capacity)
```
    Create a VkImageCopy.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkImageCopy mallocStack()
```
    Returns a new VkImageCopy instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkImageCopy callocStack()
```
    Returns a new VkImageCopy instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkImageCopy mallocStack(MemoryStack stack)
```
    Returns a new VkImageCopy instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkImageCopy callocStack(MemoryStack stack)
```
    Returns a new VkImageCopy instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkImageCopy.Buffer mallocStack(int capacity)
```
    Returns a new VkImageCopy.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkImageCopy.Buffer callocStack(int capacity)
```
    Returns a new VkImageCopy.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkImageCopy.Buffer mallocStack(int capacity,
                                             MemoryStack stack)
```
    Returns a new VkImageCopy.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkImageCopy.Buffer callocStack(int capacity,
                                             MemoryStack stack)
```
    Returns a new VkImageCopy.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity

Class VkImageCopy

Valid Usage

Member documentation

Layout

Nested Class Summary

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 Detail

SIZEOF

Constructor Detail

VkImageCopy

Method Detail

sizeof

srcSubresource

srcOffset

dstSubresource

dstOffset

extent

srcSubresource

srcOffset

dstSubresource

dstOffset

extent

set

nset

set

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack