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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

Direct Known Subclasses:

VkBufferImageCopy2KHR
```
public class VkBufferImageCopy2
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying a buffer image copy operation.
Description

This structure is functionally identical to VkBufferImageCopy, but adds sType and pNext parameters, allowing it to be more easily extended.

Valid Usage
- bufferRowLength must be 0, or greater than or equal to the width member of imageExtent
- bufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
- The aspectMask member of imageSubresource must only have a single bit set
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_BUFFER_IMAGE_COPY_2
- pNext must be NULL or a pointer to a valid instance of VkCopyCommandTransformInfoQCOM
- The sType value of each struct in the pNext chain must be unique
- imageSubresource must be a valid VkImageSubresourceLayers structure
See Also

VkCopyBufferToImageInfo2, VkCopyImageToBufferInfo2, VkExtent3D, VkImageSubresourceLayers, VkOffset3D

Layout
```
 struct VkBufferImageCopy2 {
     VkStructureType sType();
     void const * pNext();
     VkDeviceSize bufferOffset();
     uint32_t bufferRowLength();
     uint32_t bufferImageHeight();
     VkImageSubresourceLayers imageSubresource();
     VkOffset3D imageOffset();
     VkExtent3D imageExtent();
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

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

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`BUFFERIMAGEHEIGHT BUFFEROFFSET BUFFERROWLENGTH IMAGEEXTENT IMAGEOFFSET IMAGESUBRESOURCE PNEXT`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static 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
`VkBufferImageCopy2(java.nio.ByteBuffer container)`	Creates a `VkBufferImageCopy2` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`bufferImageHeight()`	see `bufferRowLength`
`VkBufferImageCopy2`	`bufferImageHeight(int value)`	Sets the specified value to the `bufferImageHeight()` field.
`long`	`bufferOffset()`	the offset in bytes from the start of the buffer object where the image data is copied from or to.
`VkBufferImageCopy2`	`bufferOffset(long value)`	Sets the specified value to the `bufferOffset()` field.
`int`	`bufferRowLength()`	`bufferRowLength` and `bufferImageHeight` specify in texels a subregion of a larger two- or three-dimensional image in buffer memory, and control the addressing calculations.
`VkBufferImageCopy2`	`bufferRowLength(int value)`	Sets the specified value to the `bufferRowLength()` field.
`static VkBufferImageCopy2`	`calloc()`	Returns a new `VkBufferImageCopy2` instance allocated with `memCalloc`.
`static VkBufferImageCopy2.Buffer`	`calloc(int capacity)`	Returns a new `VkBufferImageCopy2.Buffer` instance allocated with `memCalloc`.
`static VkBufferImageCopy2.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkBufferImageCopy2.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkBufferImageCopy2`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkBufferImageCopy2` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkBufferImageCopy2`	`create()`	Returns a new `VkBufferImageCopy2` instance allocated with `BufferUtils`.
`static VkBufferImageCopy2.Buffer`	`create(int capacity)`	Returns a new `VkBufferImageCopy2.Buffer` instance allocated with `BufferUtils`.
`static VkBufferImageCopy2`	`create(long address)`	Returns a new `VkBufferImageCopy2` instance for the specified memory address.
`static VkBufferImageCopy2.Buffer`	`create(long address, int capacity)`	Create a `VkBufferImageCopy2.Buffer` instance at the specified memory.
`static VkBufferImageCopy2`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkBufferImageCopy2.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`VkExtent3D`	`imageExtent()`	the size in texels of the image to copy in `width`, `height` and `depth`.
`VkBufferImageCopy2`	`imageExtent(java.util.function.Consumer<VkExtent3D> consumer)`	Passes the `imageExtent()` field to the specified `Consumer`.
`VkBufferImageCopy2`	`imageExtent(VkExtent3D value)`	Copies the specified `VkExtent3D` to the `imageExtent()` field.
`VkOffset3D`	`imageOffset()`	selects the initial `x`, `y`, `z` offsets in texels of the sub-region of the source or destination image data.
`VkBufferImageCopy2`	`imageOffset(java.util.function.Consumer<VkOffset3D> consumer)`	Passes the `imageOffset()` field to the specified `Consumer`.
`VkBufferImageCopy2`	`imageOffset(VkOffset3D value)`	Copies the specified `VkOffset3D` to the `imageOffset()` field.
`VkImageSubresourceLayers`	`imageSubresource()`	a `VkImageSubresourceLayers` used to specify the specific image subresources of the image used for the source or destination image data.
`VkBufferImageCopy2`	`imageSubresource(java.util.function.Consumer<VkImageSubresourceLayers> consumer)`	Passes the `imageSubresource()` field to the specified `Consumer`.
`VkBufferImageCopy2`	`imageSubresource(VkImageSubresourceLayers value)`	Copies the specified `VkImageSubresourceLayers` to the `imageSubresource()` field.
`static VkBufferImageCopy2`	`malloc()`	Returns a new `VkBufferImageCopy2` instance allocated with `memAlloc`.
`static VkBufferImageCopy2.Buffer`	`malloc(int capacity)`	Returns a new `VkBufferImageCopy2.Buffer` instance allocated with `memAlloc`.
`static VkBufferImageCopy2.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkBufferImageCopy2.Buffer` instance allocated on the specified `MemoryStack`.
`static VkBufferImageCopy2`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkBufferImageCopy2` instance allocated on the specified `MemoryStack`.
`static int`	`nbufferImageHeight(long struct)`	Unsafe version of `bufferImageHeight()`.
`static void`	`nbufferImageHeight(long struct, int value)`	Unsafe version of `bufferImageHeight`.
`static long`	`nbufferOffset(long struct)`	Unsafe version of `bufferOffset()`.
`static void`	`nbufferOffset(long struct, long value)`	Unsafe version of `bufferOffset`.
`static int`	`nbufferRowLength(long struct)`	Unsafe version of `bufferRowLength()`.
`static void`	`nbufferRowLength(long struct, int value)`	Unsafe version of `bufferRowLength`.
`static VkExtent3D`	`nimageExtent(long struct)`	Unsafe version of `imageExtent()`.
`static void`	`nimageExtent(long struct, VkExtent3D value)`	Unsafe version of `imageExtent`.
`static VkOffset3D`	`nimageOffset(long struct)`	Unsafe version of `imageOffset()`.
`static void`	`nimageOffset(long struct, VkOffset3D value)`	Unsafe version of `imageOffset`.
`static VkImageSubresourceLayers`	`nimageSubresource(long struct)`	Unsafe version of `imageSubresource()`.
`static void`	`nimageSubresource(long struct, VkImageSubresourceLayers value)`	Unsafe version of `imageSubresource`.
`static long`	`npNext(long struct)`	Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)`	Unsafe version of `pNext`.
`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.
`VkBufferImageCopy2`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`VkBufferImageCopy2`	`pNext(VkCopyCommandTransformInfoQCOM value)`	Prepends the specified `VkCopyCommandTransformInfoQCOM` value to the `pNext` chain.
`VkBufferImageCopy2`	`set(int sType, long pNext, long bufferOffset, int bufferRowLength, int bufferImageHeight, VkImageSubresourceLayers imageSubresource, VkOffset3D imageOffset, VkExtent3D imageExtent)`	Initializes this struct with the specified values.
`VkBufferImageCopy2`	`set(VkBufferImageCopy2 src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()`	the type of this structure.
`VkBufferImageCopy2`	`sType(int value)`	Sets the specified value to the `sType()` field.
`VkBufferImageCopy2`	`sType$Default()`	Sets the `STRUCTURE_TYPE_BUFFER_IMAGE_COPY_2` value to the `sType()` field.

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

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

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

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

- Field Detail
  - SIZEOF
    
    The struct size in bytes.
  - ALIGNOF
    
    The struct alignment in bytes.
  - STYPE, PNEXT, BUFFEROFFSET, BUFFERROWLENGTH, BUFFERIMAGEHEIGHT, IMAGESUBRESOURCE, IMAGEOFFSET, IMAGEEXTENT
    
    The struct member offsets.
- Constructor Detail
  - VkBufferImageCopy2
```
public VkBufferImageCopy2(java.nio.ByteBuffer container)
```
    Creates a VkBufferImageCopy2 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()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - sType
```
public int sType()
```
    the type of this structure.
  - pNext
```
public long pNext()
```
    NULL or a pointer to a structure extending this structure.
  - bufferOffset
```
public long bufferOffset()
```
    the offset in bytes from the start of the buffer object where the image data is copied from or to.
  - bufferRowLength
```
public int bufferRowLength()
```
    bufferRowLength and bufferImageHeight specify in texels a subregion of a larger two- or three-dimensional image in buffer memory, and control the addressing calculations. If either of these values is zero, that aspect of the buffer memory is considered to be tightly packed according to the imageExtent.
  - bufferImageHeight
```
public int bufferImageHeight()
```
    see bufferRowLength
  - imageSubresource
```
public VkImageSubresourceLayers imageSubresource()
```
    a VkImageSubresourceLayers used to specify the specific image subresources of the image used for the source or destination image data.
  - imageOffset
```
public VkOffset3D imageOffset()
```
    selects the initial x, y, z offsets in texels of the sub-region of the source or destination image data.
  - imageExtent
```
public VkExtent3D imageExtent()
```
    the size in texels of the image to copy in width, height and depth.
  - sType
```
public VkBufferImageCopy2 sType(int value)
```
    Sets the specified value to the sType() field.
  - sType$Default
```
public VkBufferImageCopy2 sType$Default()
```
    Sets the STRUCTURE_TYPE_BUFFER_IMAGE_COPY_2 value to the sType() field.
  - pNext
```
public VkBufferImageCopy2 pNext(long value)
```
    Sets the specified value to the pNext() field.
  - pNext
```
public VkBufferImageCopy2 pNext(VkCopyCommandTransformInfoQCOM value)
```
    Prepends the specified VkCopyCommandTransformInfoQCOM value to the pNext chain.
  - bufferOffset
```
public VkBufferImageCopy2 bufferOffset(long value)
```
    Sets the specified value to the bufferOffset() field.
  - bufferRowLength
```
public VkBufferImageCopy2 bufferRowLength(int value)
```
    Sets the specified value to the bufferRowLength() field.
  - bufferImageHeight
```
public VkBufferImageCopy2 bufferImageHeight(int value)
```
    Sets the specified value to the bufferImageHeight() field.
  - imageSubresource
```
public VkBufferImageCopy2 imageSubresource(VkImageSubresourceLayers value)
```
    Copies the specified VkImageSubresourceLayers to the imageSubresource() field.
  - imageSubresource
```
public VkBufferImageCopy2 imageSubresource(java.util.function.Consumer<VkImageSubresourceLayers> consumer)
```
    Passes the imageSubresource() field to the specified Consumer.
  - imageOffset
```
public VkBufferImageCopy2 imageOffset(VkOffset3D value)
```
    Copies the specified VkOffset3D to the imageOffset() field.
  - imageOffset
```
public VkBufferImageCopy2 imageOffset(java.util.function.Consumer<VkOffset3D> consumer)
```
    Passes the imageOffset() field to the specified Consumer.
  - imageExtent
```
public VkBufferImageCopy2 imageExtent(VkExtent3D value)
```
    Copies the specified VkExtent3D to the imageExtent() field.
  - imageExtent
```
public VkBufferImageCopy2 imageExtent(java.util.function.Consumer<VkExtent3D> consumer)
```
    Passes the imageExtent() field to the specified Consumer.
  - set
```
public VkBufferImageCopy2 set(int sType,
                              long pNext,
                              long bufferOffset,
                              int bufferRowLength,
                              int bufferImageHeight,
                              VkImageSubresourceLayers imageSubresource,
                              VkOffset3D imageOffset,
                              VkExtent3D imageExtent)
```
    Initializes this struct with the specified values.
  - set
```
public VkBufferImageCopy2 set(VkBufferImageCopy2 src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkBufferImageCopy2 malloc()
```
    Returns a new VkBufferImageCopy2 instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkBufferImageCopy2 calloc()
```
    Returns a new VkBufferImageCopy2 instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkBufferImageCopy2 create()
```
    Returns a new VkBufferImageCopy2 instance allocated with BufferUtils.
  - create
```
public static VkBufferImageCopy2 create(long address)
```
    Returns a new VkBufferImageCopy2 instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkBufferImageCopy2 createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkBufferImageCopy2.Buffer malloc(int capacity)
```
    Returns a new VkBufferImageCopy2.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkBufferImageCopy2.Buffer calloc(int capacity)
```
    Returns a new VkBufferImageCopy2.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkBufferImageCopy2.Buffer create(int capacity)
```
    Returns a new VkBufferImageCopy2.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkBufferImageCopy2.Buffer create(long address,
                                               int capacity)
```
    Create a VkBufferImageCopy2.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkBufferImageCopy2.Buffer createSafe(long address,
                                                   int capacity)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkBufferImageCopy2 malloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBufferImageCopy2 instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - calloc
```
public static VkBufferImageCopy2 calloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBufferImageCopy2 instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - malloc
```
public static VkBufferImageCopy2.Buffer malloc(int capacity,
                                               org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBufferImageCopy2.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - calloc
```
public static VkBufferImageCopy2.Buffer calloc(int capacity,
                                               org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBufferImageCopy2.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
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - nbufferOffset
```
public static long nbufferOffset(long struct)
```
    Unsafe version of bufferOffset().
  - nbufferRowLength
```
public static int nbufferRowLength(long struct)
```
    Unsafe version of bufferRowLength().
  - nbufferImageHeight
```
public static int nbufferImageHeight(long struct)
```
    Unsafe version of bufferImageHeight().
  - nimageSubresource
```
public static VkImageSubresourceLayers nimageSubresource(long struct)
```
    Unsafe version of imageSubresource().
  - nimageOffset
```
public static VkOffset3D nimageOffset(long struct)
```
    Unsafe version of imageOffset().
  - nimageExtent
```
public static VkExtent3D nimageExtent(long struct)
```
    Unsafe version of imageExtent().
  - 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.
  - nbufferOffset
```
public static void nbufferOffset(long struct,
                                 long value)
```
    Unsafe version of bufferOffset.
  - nbufferRowLength
```
public static void nbufferRowLength(long struct,
                                    int value)
```
    Unsafe version of bufferRowLength.
  - nbufferImageHeight
```
public static void nbufferImageHeight(long struct,
                                      int value)
```
    Unsafe version of bufferImageHeight.
  - nimageSubresource
```
public static void nimageSubresource(long struct,
                                     VkImageSubresourceLayers value)
```
    Unsafe version of imageSubresource.
  - nimageOffset
```
public static void nimageOffset(long struct,
                                VkOffset3D value)
```
    Unsafe version of imageOffset.
  - nimageExtent
```
public static void nimageExtent(long struct,
                                VkExtent3D value)
```
    Unsafe version of imageExtent.

Class VkBufferImageCopy2

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested Class Summary

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

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

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

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

STYPE, PNEXT, BUFFEROFFSET, BUFFERROWLENGTH, BUFFERIMAGEHEIGHT, IMAGESUBRESOURCE, IMAGEOFFSET, IMAGEEXTENT

Constructor Detail

VkBufferImageCopy2

Method Detail

sizeof

sType

pNext

bufferOffset

bufferRowLength

bufferImageHeight

imageSubresource

imageOffset

imageExtent

sType

sType$Default

pNext

pNext

bufferOffset

bufferRowLength

bufferImageHeight

imageSubresource

imageSubresource

imageOffset

imageOffset

imageExtent

imageExtent

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nsType

npNext

nbufferOffset

nbufferRowLength

nbufferImageHeight

nimageSubresource

nimageOffset

nimageExtent

nsType

npNext

nbufferOffset

nbufferRowLength

nbufferImageHeight

nimageSubresource

nimageOffset

nimageExtent