Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkBufferCopy2

extends Struct<VkBufferCopy2>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkBufferCopy2KHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying a buffer copy operation.
Valid Usage
Valid Usage (Implicit)
See Also

VkCopyBufferInfo2

Layout


struct VkBufferCopy2 {
    VkStructureType sType;
    void const * pNext;
    VkDeviceSize srcOffset;
    VkDeviceSize dstOffset;
    VkDeviceSize size;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkBufferCopy2.Buffer

An array of VkBufferCopy2 structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DSTOFFSET

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SRCOFFSET

The struct member offsets.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkBufferCopy2(long address, ByteBuffer container)

public
VkBufferCopy2(ByteBuffer container)

Creates a VkBufferCopy2 instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkBufferCopy2
calloc()

Returns a new VkBufferCopy2 instance allocated with memCalloc.

public static VkBufferCopy2.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkBufferCopy2.Buffer instance allocated with memCalloc.

public static VkBufferCopy2
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkBufferCopy2.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected VkBufferCopy2
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkBufferCopy2
create()

Returns a new VkBufferCopy2 instance allocated with BufferUtils.

public static VkBufferCopy2
create(long address)

Returns a new VkBufferCopy2 instance for the specified memory address.

public static VkBufferCopy2.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkBufferCopy2.Buffer instance allocated with BufferUtils.

public static VkBufferCopy2.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkBufferCopy2.Buffer instance at the specified memory.

public static VkBufferCopy2
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkBufferCopy2.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public long
dstOffset()

the starting offset in bytes from the start of dstBuffer.

public VkBufferCopy2
dstOffset(long value)

Sets the specified value to the dstOffset field.

public static VkBufferCopy2
malloc()

Returns a new VkBufferCopy2 instance allocated with memAlloc.

public static VkBufferCopy2.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkBufferCopy2.Buffer instance allocated with memAlloc.

public static VkBufferCopy2
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkBufferCopy2 instance allocated on the specified MemoryStack.

public static VkBufferCopy2.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static long
ndstOffset(long struct)

Unsafe version of dstOffset.

public static void
ndstOffset(long struct, long value)

Unsafe version of dstOffset.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static long
nsize(long struct)

Unsafe version of size.

public static void
nsize(long struct, long value)

Unsafe version of size.

public static long
nsrcOffset(long struct)

Unsafe version of srcOffset.

public static void
nsrcOffset(long struct, long value)

Unsafe version of srcOffset.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkBufferCopy2
pNext(long value)

Sets the specified value to the pNext field.

public VkBufferCopy2
set(int sType, long pNext, long srcOffset, long dstOffset, long size)

Initializes this struct with the specified values.

public VkBufferCopy2

Returns:

this struct
set
(VkBufferCopy2
the source struct
src
)

Copies the specified struct data to this struct.

public long
size()

the number of bytes to copy.

public VkBufferCopy2
size(long value)

Sets the specified value to the size field.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public long
srcOffset()

the starting offset in bytes from the start of srcBuffer.

public VkBufferCopy2
srcOffset(long value)

Sets the specified value to the srcOffset field.

public int
sType()

a VkStructureType value identifying this structure.

public VkBufferCopy2
sType(int value)

Sets the specified value to the sType field.

public VkBufferCopy2
sType$Default()

Sets the STRUCTURE_TYPE_BUFFER_COPY_2 value to the sType field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

DSTOFFSETback to summary
public static final int DSTOFFSET

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEback to summary
public static final int SIZE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SRCOFFSETback to summary
public static final int SRCOFFSET

The struct member offsets.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkBufferCopy2back to summary
protected VkBufferCopy2(long address, ByteBuffer container)
VkBufferCopy2back to summary
public VkBufferCopy2(ByteBuffer container)

Creates a VkBufferCopy2 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

callocback to summary
public static VkBufferCopy2 calloc()

Returns a new VkBufferCopy2 instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkBufferCopy2.Buffer calloc(int capacity)

Returns a new VkBufferCopy2.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkBufferCopy2 calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkBufferCopy2.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VkBufferCopy2 create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkBufferCopy2 create()

Returns a new VkBufferCopy2 instance allocated with BufferUtils.

createback to summary
public static VkBufferCopy2 create(long address)

Returns a new VkBufferCopy2 instance for the specified memory address.

createback to summary
public static VkBufferCopy2.Buffer create(int capacity)

Returns a new VkBufferCopy2.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkBufferCopy2.Buffer create(long address, int capacity)

Create a VkBufferCopy2.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkBufferCopy2 createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkBufferCopy2.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
dstOffsetback to summary
public long dstOffset()

the starting offset in bytes from the start of dstBuffer.

Annotations
@NativeType:VkDeviceSize
dstOffsetback to summary
public VkBufferCopy2 dstOffset(long value)

Sets the specified value to the dstOffset field.

mallocback to summary
public static VkBufferCopy2 malloc()

Returns a new VkBufferCopy2 instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkBufferCopy2.Buffer malloc(int capacity)

Returns a new VkBufferCopy2.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkBufferCopy2 malloc(MemoryStack stack)

Returns a new VkBufferCopy2 instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkBufferCopy2.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ndstOffsetback to summary
public static long ndstOffset(long struct)

Unsafe version of dstOffset.

ndstOffsetback to summary
public static void ndstOffset(long struct, long value)

Unsafe version of dstOffset.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsizeback to summary
public static long nsize(long struct)

Unsafe version of size.

nsizeback to summary
public static void nsize(long struct, long value)

Unsafe version of size.

nsrcOffsetback to summary
public static long nsrcOffset(long struct)

Unsafe version of srcOffset.

nsrcOffsetback to summary
public static void nsrcOffset(long struct, long value)

Unsafe version of srcOffset.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkBufferCopy2 pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkBufferCopy2 set(int sType, long pNext, long srcOffset, long dstOffset, long size)

Initializes this struct with the specified values.

setback to summary
public VkBufferCopy2 set(VkBufferCopy2 src)

Copies the specified struct data to this struct.

Parameters
src:VkBufferCopy2

the source struct

Returns:VkBufferCopy2

this struct

sizeback to summary
public long size()

the number of bytes to copy.

Annotations
@NativeType:VkDeviceSize
sizeback to summary
public VkBufferCopy2 size(long value)

Sets the specified value to the size field.

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
srcOffsetback to summary
public long srcOffset()

the starting offset in bytes from the start of srcBuffer.

Annotations
@NativeType:VkDeviceSize
srcOffsetback to summary
public VkBufferCopy2 srcOffset(long value)

Sets the specified value to the srcOffset field.

sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkBufferCopy2 sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkBufferCopy2 sType$Default()

Sets the STRUCTURE_TYPE_BUFFER_COPY_2 value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkBufferCopy2.Buffer

extends StructBuffer<VkBufferCopy2, VkBufferCopy2.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkBufferCopy2KHR.Buffer

An array of VkBufferCopy2 structs.

Field Summary

Modifier and TypeField and Description
private static final VkBufferCopy2

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkBufferCopy2.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

the value of the VkBufferCopy2#dstOffset field.
dstOffset
()

public VkBufferCopy2.Buffer
dstOffset(long value)

Sets the specified value to the VkBufferCopy2#dstOffset field.

protected VkBufferCopy2
public long

Returns:

the value of the VkBufferCopy2#pNext field.
pNext
()

public VkBufferCopy2.Buffer
pNext(long value)

Sets the specified value to the VkBufferCopy2#pNext field.

protected VkBufferCopy2.Buffer
public long

Returns:

the value of the VkBufferCopy2#size field.
size
()

public VkBufferCopy2.Buffer
size(long value)

Sets the specified value to the VkBufferCopy2#size field.

public long

Returns:

the value of the VkBufferCopy2#srcOffset field.
srcOffset
()

public VkBufferCopy2.Buffer
srcOffset(long value)

Sets the specified value to the VkBufferCopy2#srcOffset field.

public int

Returns:

the value of the VkBufferCopy2#sType field.
sType
()

public VkBufferCopy2.Buffer
sType(int value)

Sets the specified value to the VkBufferCopy2#sType field.

public VkBufferCopy2.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkBufferCopy2 ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkBufferCopy2.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkBufferCopy2#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

dstOffsetback to summary
public long dstOffset()
Returns:long

the value of the VkBufferCopy2#dstOffset field.

Annotations
@NativeType:VkDeviceSize
dstOffsetback to summary
public VkBufferCopy2.Buffer dstOffset(long value)

Sets the specified value to the VkBufferCopy2#dstOffset field.

getElementFactoryback to summary
protected VkBufferCopy2 getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkBufferCopy2#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkBufferCopy2.Buffer pNext(long value)

Sets the specified value to the VkBufferCopy2#pNext field.

selfback to summary
protected VkBufferCopy2.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sizeback to summary
public long size()
Returns:long

the value of the VkBufferCopy2#size field.

Annotations
@NativeType:VkDeviceSize
sizeback to summary
public VkBufferCopy2.Buffer size(long value)

Sets the specified value to the VkBufferCopy2#size field.

srcOffsetback to summary
public long srcOffset()
Returns:long

the value of the VkBufferCopy2#srcOffset field.

Annotations
@NativeType:VkDeviceSize
srcOffsetback to summary
public VkBufferCopy2.Buffer srcOffset(long value)

Sets the specified value to the VkBufferCopy2#srcOffset field.

sTypeback to summary
public int sType()
Returns:int

the value of the VkBufferCopy2#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkBufferCopy2.Buffer sType(int value)

Sets the specified value to the VkBufferCopy2#sType field.

sType$Defaultback to summary
public VkBufferCopy2.Buffer sType$Default()

Sets the STRUCTURE_TYPE_BUFFER_COPY_2 value to the VkBufferCopy2#sType field.