VkBufferCopy (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkBufferCopy
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying a buffer copy operation.
Valid Usage
- The size must be greater than 0
See Also

CmdCopyBuffer

Member documentation
- srcOffset – the starting offset in bytes from the start of srcBuffer.
- dstOffset – the starting offset in bytes from the start of dstBuffer.
- size – the number of bytes to copy.
Layout
```
 struct VkBufferCopy {
     VkDeviceSize srcOffset;
     VkDeviceSize dstOffset;
     VkDeviceSize size;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkBufferCopy.Buffer` An array of `VkBufferCopy` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`DSTOFFSET` The struct member offsets.
`static int`	`SIZE` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`SRCOFFSET` 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 and Description

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

Constructors
Constructor and Description
`VkBufferCopy(java.nio.ByteBuffer container)` Creates a `VkBufferCopy` 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 VkBufferCopy`	`calloc()` Returns a new `VkBufferCopy` instance allocated with `memCalloc`.
`static VkBufferCopy.Buffer`	`calloc(int capacity)` Returns a new `VkBufferCopy.Buffer` instance allocated with `memCalloc`.
`static VkBufferCopy`	`callocStack()` Returns a new `VkBufferCopy` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkBufferCopy.Buffer`	`callocStack(int capacity)` Returns a new `VkBufferCopy.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkBufferCopy.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkBufferCopy.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkBufferCopy`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkBufferCopy` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkBufferCopy`	`create()` Returns a new `VkBufferCopy` instance allocated with `BufferUtils`.
`static VkBufferCopy.Buffer`	`create(int capacity)` Returns a new `VkBufferCopy.Buffer` instance allocated with `BufferUtils`.
`static VkBufferCopy`	`create(long address)` Returns a new `VkBufferCopy` instance for the specified memory address.
`static VkBufferCopy.Buffer`	`create(long address, int capacity)` Create a `VkBufferCopy.Buffer` instance at the specified memory.
`static VkBufferCopy`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkBufferCopy.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`long`	`dstOffset()` Returns the value of the `dstOffset` field.
`VkBufferCopy`	`dstOffset(long value)` Sets the specified value to the `dstOffset` field.
`static VkBufferCopy`	`malloc()` Returns a new `VkBufferCopy` instance allocated with `memAlloc`.
`static VkBufferCopy.Buffer`	`malloc(int capacity)` Returns a new `VkBufferCopy.Buffer` instance allocated with `memAlloc`.
`static VkBufferCopy`	`mallocStack()` Returns a new `VkBufferCopy` instance allocated on the thread-local `MemoryStack`.
`static VkBufferCopy.Buffer`	`mallocStack(int capacity)` Returns a new `VkBufferCopy.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkBufferCopy.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkBufferCopy.Buffer` instance allocated on the specified `MemoryStack`.
`static VkBufferCopy`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkBufferCopy` instance allocated on the specified `MemoryStack`.
`static long`	`ndstOffset(long struct)` Unsafe version of `dstOffset()`.
`static void`	`ndstOffset(long struct, long value)` Unsafe version of `dstOffset`.
`static long`	`nsize(long struct)` Unsafe version of `size()`.
`static void`	`nsize(long struct, long value)` Unsafe version of `size`.
`static long`	`nsrcOffset(long struct)` Unsafe version of `srcOffset()`.
`static void`	`nsrcOffset(long struct, long value)` Unsafe version of `srcOffset`.
`VkBufferCopy`	`set(long srcOffset, long dstOffset, long size)` Initializes this struct with the specified values.
`VkBufferCopy`	`set(VkBufferCopy src)` Copies the specified struct data to this struct.
`long`	`size()` Returns the value of the `size` field.
`VkBufferCopy`	`size(long value)` Sets the specified value to the `size` field.
`int`	`sizeof()`
`long`	`srcOffset()` Returns the value of the `srcOffset` field.
`VkBufferCopy`	`srcOffset(long value)` Sets the specified value to the `srcOffset` field.

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

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 Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - SRCOFFSET
```
public static final int SRCOFFSET
```
    The struct member offsets.
  - DSTOFFSET
```
public static final int DSTOFFSET
```
    The struct member offsets.
  - SIZE
```
public static final int SIZE
```
    The struct member offsets.
- Constructor Detail
  - VkBufferCopy
```
public VkBufferCopy(java.nio.ByteBuffer container)
```
    Creates a VkBufferCopy 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
  - srcOffset
```
public long srcOffset()
```
    Returns the value of the srcOffset field.
  - dstOffset
```
public long dstOffset()
```
    Returns the value of the dstOffset field.
  - size
```
public long size()
```
    Returns the value of the size field.
  - srcOffset
```
public VkBufferCopy srcOffset(long value)
```
    Sets the specified value to the srcOffset field.
  - dstOffset
```
public VkBufferCopy dstOffset(long value)
```
    Sets the specified value to the dstOffset field.
  - size
```
public VkBufferCopy size(long value)
```
    Sets the specified value to the size field.
  - set
```
public VkBufferCopy set(long srcOffset,
                        long dstOffset,
                        long size)
```
    Initializes this struct with the specified values.
  - set
```
public VkBufferCopy set(VkBufferCopy src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkBufferCopy malloc()
```
    Returns a new VkBufferCopy instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkBufferCopy calloc()
```
    Returns a new VkBufferCopy instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkBufferCopy create()
```
    Returns a new VkBufferCopy instance allocated with BufferUtils.
  - create
```
public static VkBufferCopy create(long address)
```
    Returns a new VkBufferCopy instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkBufferCopy createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkBufferCopy.Buffer malloc(int capacity)
```
    Returns a new VkBufferCopy.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkBufferCopy.Buffer calloc(int capacity)
```
    Returns a new VkBufferCopy.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkBufferCopy.Buffer create(int capacity)
```
    Returns a new VkBufferCopy.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkBufferCopy.Buffer create(long address,
                                         int capacity)
```
    Create a VkBufferCopy.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkBufferCopy.Buffer createSafe(long address,
                                                       int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkBufferCopy mallocStack()
```
    Returns a new VkBufferCopy instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkBufferCopy callocStack()
```
    Returns a new VkBufferCopy instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkBufferCopy mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBufferCopy instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkBufferCopy callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBufferCopy instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkBufferCopy.Buffer mallocStack(int capacity)
```
    Returns a new VkBufferCopy.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkBufferCopy.Buffer callocStack(int capacity)
```
    Returns a new VkBufferCopy.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkBufferCopy.Buffer mallocStack(int capacity,
                                              org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBufferCopy.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkBufferCopy.Buffer callocStack(int capacity,
                                              org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBufferCopy.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
  - nsrcOffset
```
public static long nsrcOffset(long struct)
```
    Unsafe version of srcOffset().
  - ndstOffset
```
public static long ndstOffset(long struct)
```
    Unsafe version of dstOffset().
  - nsize
```
public static long nsize(long struct)
```
    Unsafe version of size().
  - nsrcOffset
```
public static void nsrcOffset(long struct,
                              long value)
```
    Unsafe version of srcOffset.
  - ndstOffset
```
public static void ndstOffset(long struct,
                              long value)
```
    Unsafe version of dstOffset.
  - nsize
```
public static void nsize(long struct,
                         long value)
```
    Unsafe version of size.

Class VkBufferCopy

Valid Usage

See Also

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

ALIGNOF

SRCOFFSET

DSTOFFSET

SIZE

Constructor Detail

VkBufferCopy

Method Detail

sizeof

srcOffset

dstOffset

size

srcOffset

dstOffset

size

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsrcOffset

ndstOffset

nsize

nsrcOffset

ndstOffset

nsize