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

All Implemented Interfaces:

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

Direct Known Subclasses:

VkCopyBufferInfo2KHR
```
public class VkCopyBufferInfo2
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying parameters of a buffer copy command.
Description

Members defined by this structure with the same name as parameters in CmdCopyBuffer have the identical effect to those parameters; the child structure VkBufferCopy2 is a variant of VkBufferCopy which includes sType and pNext parameters, allowing it to be extended.

Valid Usage
- The srcOffset member of each element of pRegions must be less than the size of srcBuffer
- The dstOffset member of each element of pRegions must be less than the size of dstBuffer
- The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
- The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
- The union of the source regions, and the union of the destination regions, specified by the elements of pRegions, must not overlap in memory
- srcBuffer must have been created with BUFFER_USAGE_TRANSFER_SRC_BIT usage flag
- If srcBuffer is non-sparse then it must be bound completely and contiguously to a single VkDeviceMemory object
- dstBuffer must have been created with BUFFER_USAGE_TRANSFER_DST_BIT usage flag
- If dstBuffer is non-sparse then it must be bound completely and contiguously to a single VkDeviceMemory object
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_COPY_BUFFER_INFO_2
- pNext must be NULL
- srcBuffer must be a valid VkBuffer handle
- dstBuffer must be a valid VkBuffer handle
- pRegions must be a valid pointer to an array of regionCount valid VkBufferCopy2 structures
- regionCount must be greater than 0
- Both of dstBuffer, and srcBuffer must have been created, allocated, or retrieved from the same VkDevice
See Also

VkBufferCopy2, CmdCopyBuffer2, CmdCopyBuffer2KHR

Layout
```
 struct VkCopyBufferInfo2 {
     VkStructureType sType();
     void const * pNext();
     VkBuffer srcBuffer();
     VkBuffer dstBuffer();
     uint32_t regionCount();
     VkBufferCopy2 const * pRegions();
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VkCopyBufferInfo2.Buffer
An array of VkCopyBufferInfo2 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`	`DSTBUFFER PNEXT PREGIONS REGIONCOUNT`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`SRCBUFFER 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

VkCopyBufferInfo2(java.nio.ByteBuffer container)
Creates a VkCopyBufferInfo2 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
`static VkCopyBufferInfo2`	`calloc()`	Returns a new `VkCopyBufferInfo2` instance allocated with `memCalloc`.
`static VkCopyBufferInfo2.Buffer`	`calloc(int capacity)`	Returns a new `VkCopyBufferInfo2.Buffer` instance allocated with `memCalloc`.
`static VkCopyBufferInfo2.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkCopyBufferInfo2.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkCopyBufferInfo2`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkCopyBufferInfo2` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkCopyBufferInfo2`	`create()`	Returns a new `VkCopyBufferInfo2` instance allocated with `BufferUtils`.
`static VkCopyBufferInfo2.Buffer`	`create(int capacity)`	Returns a new `VkCopyBufferInfo2.Buffer` instance allocated with `BufferUtils`.
`static VkCopyBufferInfo2`	`create(long address)`	Returns a new `VkCopyBufferInfo2` instance for the specified memory address.
`static VkCopyBufferInfo2.Buffer`	`create(long address, int capacity)`	Create a `VkCopyBufferInfo2.Buffer` instance at the specified memory.
`static VkCopyBufferInfo2`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkCopyBufferInfo2.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`long`	`dstBuffer()`	the destination buffer.
`VkCopyBufferInfo2`	`dstBuffer(long value)`	Sets the specified value to the `dstBuffer()` field.
`static VkCopyBufferInfo2`	`malloc()`	Returns a new `VkCopyBufferInfo2` instance allocated with `memAlloc`.
`static VkCopyBufferInfo2.Buffer`	`malloc(int capacity)`	Returns a new `VkCopyBufferInfo2.Buffer` instance allocated with `memAlloc`.
`static VkCopyBufferInfo2.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkCopyBufferInfo2.Buffer` instance allocated on the specified `MemoryStack`.
`static VkCopyBufferInfo2`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkCopyBufferInfo2` instance allocated on the specified `MemoryStack`.
`static long`	`ndstBuffer(long struct)`	Unsafe version of `dstBuffer()`.
`static void`	`ndstBuffer(long struct, long value)`	Unsafe version of `dstBuffer`.
`static long`	`npNext(long struct)`	Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)`	Unsafe version of `pNext`.
`static VkBufferCopy2.Buffer`	`npRegions(long struct)`	Unsafe version of `pRegions()`.
`static void`	`npRegions(long struct, VkBufferCopy2.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`	`nsrcBuffer(long struct)`	Unsafe version of `srcBuffer()`.
`static void`	`nsrcBuffer(long struct, long value)`	Unsafe version of `srcBuffer`.
`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.
`VkCopyBufferInfo2`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`VkBufferCopy2.Buffer`	`pRegions()`	a pointer to an array of `VkBufferCopy2` structures specifying the regions to copy.
`VkCopyBufferInfo2`	`pRegions(VkBufferCopy2.Buffer value)`	Sets the address of the specified `VkBufferCopy2.Buffer` to the `pRegions()` field.
`int`	`regionCount()`	the number of regions to copy.
`VkCopyBufferInfo2`	`set(int sType, long pNext, long srcBuffer, long dstBuffer, VkBufferCopy2.Buffer pRegions)`	Initializes this struct with the specified values.
`VkCopyBufferInfo2`	`set(VkCopyBufferInfo2 src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`long`	`srcBuffer()`	the source buffer.
`VkCopyBufferInfo2`	`srcBuffer(long value)`	Sets the specified value to the `srcBuffer()` field.
`int`	`sType()`	the type of this structure.
`VkCopyBufferInfo2`	`sType(int value)`	Sets the specified value to the `sType()` field.
`VkCopyBufferInfo2`	`sType$Default()`	Sets the `STRUCTURE_TYPE_COPY_BUFFER_INFO_2` value to the `sType()` field.
`static void`	`validate(long struct)`	Validates pointer members that should not be `NULL`.

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, SRCBUFFER, DSTBUFFER, REGIONCOUNT, PREGIONS
    
    The struct member offsets.
- Constructor Detail
  - VkCopyBufferInfo2
```
public VkCopyBufferInfo2(java.nio.ByteBuffer container)
```
    Creates a VkCopyBufferInfo2 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.
  - srcBuffer
```
public long srcBuffer()
```
    the source buffer.
  - dstBuffer
```
public long dstBuffer()
```
    the destination buffer.
  - regionCount
```
public int regionCount()
```
    the number of regions to copy.
  - pRegions
```
public VkBufferCopy2.Buffer pRegions()
```
    a pointer to an array of VkBufferCopy2 structures specifying the regions to copy.
  - sType
```
public VkCopyBufferInfo2 sType(int value)
```
    Sets the specified value to the sType() field.
  - sType$Default
```
public VkCopyBufferInfo2 sType$Default()
```
    Sets the STRUCTURE_TYPE_COPY_BUFFER_INFO_2 value to the sType() field.
  - pNext
```
public VkCopyBufferInfo2 pNext(long value)
```
    Sets the specified value to the pNext() field.
  - srcBuffer
```
public VkCopyBufferInfo2 srcBuffer(long value)
```
    Sets the specified value to the srcBuffer() field.
  - dstBuffer
```
public VkCopyBufferInfo2 dstBuffer(long value)
```
    Sets the specified value to the dstBuffer() field.
  - pRegions
```
public VkCopyBufferInfo2 pRegions(VkBufferCopy2.Buffer value)
```
    Sets the address of the specified VkBufferCopy2.Buffer to the pRegions() field.
  - set
```
public VkCopyBufferInfo2 set(int sType,
                             long pNext,
                             long srcBuffer,
                             long dstBuffer,
                             VkBufferCopy2.Buffer pRegions)
```
    Initializes this struct with the specified values.
  - set
```
public VkCopyBufferInfo2 set(VkCopyBufferInfo2 src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkCopyBufferInfo2 malloc()
```
    Returns a new VkCopyBufferInfo2 instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkCopyBufferInfo2 calloc()
```
    Returns a new VkCopyBufferInfo2 instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkCopyBufferInfo2 create()
```
    Returns a new VkCopyBufferInfo2 instance allocated with BufferUtils.
  - create
```
public static VkCopyBufferInfo2 create(long address)
```
    Returns a new VkCopyBufferInfo2 instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkCopyBufferInfo2 createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkCopyBufferInfo2.Buffer malloc(int capacity)
```
    Returns a new VkCopyBufferInfo2.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkCopyBufferInfo2.Buffer calloc(int capacity)
```
    Returns a new VkCopyBufferInfo2.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkCopyBufferInfo2.Buffer create(int capacity)
```
    Returns a new VkCopyBufferInfo2.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkCopyBufferInfo2.Buffer create(long address,
                                              int capacity)
```
    Create a VkCopyBufferInfo2.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkCopyBufferInfo2.Buffer createSafe(long address,
                                                  int capacity)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkCopyBufferInfo2 malloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkCopyBufferInfo2 instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - calloc
```
public static VkCopyBufferInfo2 calloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkCopyBufferInfo2 instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - malloc
```
public static VkCopyBufferInfo2.Buffer malloc(int capacity,
                                              org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkCopyBufferInfo2.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - calloc
```
public static VkCopyBufferInfo2.Buffer calloc(int capacity,
                                              org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkCopyBufferInfo2.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().
  - nsrcBuffer
```
public static long nsrcBuffer(long struct)
```
    Unsafe version of srcBuffer().
  - ndstBuffer
```
public static long ndstBuffer(long struct)
```
    Unsafe version of dstBuffer().
  - nregionCount
```
public static int nregionCount(long struct)
```
    Unsafe version of regionCount().
  - npRegions
```
public static VkBufferCopy2.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.
  - nsrcBuffer
```
public static void nsrcBuffer(long struct,
                              long value)
```
    Unsafe version of srcBuffer.
  - ndstBuffer
```
public static void ndstBuffer(long struct,
                              long value)
```
    Unsafe version of dstBuffer.
  - 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,
                             VkBufferCopy2.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 VkCopyBufferInfo2

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, SRCBUFFER, DSTBUFFER, REGIONCOUNT, PREGIONS

Constructor Detail

VkCopyBufferInfo2

Method Detail

sizeof

sType

pNext

srcBuffer

dstBuffer

regionCount

pRegions

sType

sType$Default

pNext

srcBuffer

dstBuffer

pRegions

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nsType

npNext

nsrcBuffer

ndstBuffer

nregionCount

npRegions

nsType

npNext

nsrcBuffer

ndstBuffer

nregionCount

npRegions

validate