Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkCopyBufferInfo2

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

Structure specifying parameters of a buffer copy command.
Valid Usage
Valid Usage (Implicit)
See Also

VkBufferCopy2, CmdCopyBuffer2, CmdCopyBuffer2KHR

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DSTBUFFER

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
PREGIONS

The struct member offsets.

public static final int
REGIONCOUNT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SRCBUFFER

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
VkCopyBufferInfo2(long address, ByteBuffer container)

public
VkCopyBufferInfo2(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkCopyBufferInfo2
calloc()

Returns a new VkCopyBufferInfo2 instance allocated with memCalloc.

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

Returns a new VkCopyBufferInfo2.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkCopyBufferInfo2
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 VkCopyBufferInfo2
create()

Returns a new VkCopyBufferInfo2 instance allocated with BufferUtils.

public static VkCopyBufferInfo2
create(long address)

Returns a new VkCopyBufferInfo2 instance for the specified memory address.

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

Returns a new VkCopyBufferInfo2.Buffer instance allocated with BufferUtils.

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

Create a VkCopyBufferInfo2.Buffer instance at the specified memory.

public static VkCopyBufferInfo2
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
dstBuffer()

the destination buffer.

public VkCopyBufferInfo2
dstBuffer(long value)

Sets the specified value to the dstBuffer field.

public static VkCopyBufferInfo2
malloc()

Returns a new VkCopyBufferInfo2 instance allocated with memAlloc.

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

Returns a new VkCopyBufferInfo2.Buffer instance allocated with memAlloc.

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

Returns a new VkCopyBufferInfo2 instance allocated on the specified MemoryStack.

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

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

public static long
ndstBuffer(long struct)

Unsafe version of dstBuffer.

public static void
ndstBuffer(long struct, long value)

Unsafe version of dstBuffer.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static VkBufferCopy2.Buffer
npRegions(long struct)

Unsafe version of pRegions.

public static void
npRegions(long struct, VkBufferCopy2.Buffer value)

Unsafe version of pRegions.

public static int
nregionCount(long struct)

Unsafe version of regionCount.

public static void
nregionCount(long struct, int value)

Sets the specified value to the regionCount field of the specified struct.

public static long
nsrcBuffer(long struct)

Unsafe version of srcBuffer.

public static void
nsrcBuffer(long struct, long value)

Unsafe version of srcBuffer.

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 VkCopyBufferInfo2
pNext(long value)

Sets the specified value to the pNext field.

public VkBufferCopy2.Buffer
pRegions()

a pointer to an array of VkBufferCopy2 structures specifying the regions to copy.

public VkCopyBufferInfo2
pRegions(VkBufferCopy2.Buffer value)

Sets the address of the specified VkBufferCopy2.Buffer to the pRegions field.

public int
regionCount()

the number of regions to copy.

public VkCopyBufferInfo2
set(int sType, long pNext, long srcBuffer, long dstBuffer, VkBufferCopy2.Buffer pRegions)

Initializes this struct with the specified values.

public VkCopyBufferInfo2

Returns:

this struct
set
(VkCopyBufferInfo2
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

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

Returns sizeof(struct).
public long
srcBuffer()

the source buffer.

public VkCopyBufferInfo2
srcBuffer(long value)

Sets the specified value to the srcBuffer field.

public int
sType()

a VkStructureType value identifying this structure.

public VkCopyBufferInfo2
sType(int value)

Sets the specified value to the sType field.

public VkCopyBufferInfo2
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

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.

DSTBUFFERback to summary
public static final int DSTBUFFER

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

PREGIONSback to summary
public static final int PREGIONS

The struct member offsets.

REGIONCOUNTback to summary
public static final int REGIONCOUNT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SRCBUFFERback to summary
public static final int SRCBUFFER

The struct member offsets.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkCopyBufferInfo2back to summary
protected VkCopyBufferInfo2(long address, ByteBuffer container)
VkCopyBufferInfo2back to summary
public VkCopyBufferInfo2(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

callocback to summary
public static VkCopyBufferInfo2 calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkCopyBufferInfo2 calloc(MemoryStack stack)

Returns a new VkCopyBufferInfo2 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 VkCopyBufferInfo2.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkCopyBufferInfo2.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 VkCopyBufferInfo2 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 VkCopyBufferInfo2 create()

Returns a new VkCopyBufferInfo2 instance allocated with BufferUtils.

createback to summary
public static VkCopyBufferInfo2 create(long address)

Returns a new VkCopyBufferInfo2 instance for the specified memory address.

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

Returns a new VkCopyBufferInfo2.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkCopyBufferInfo2.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkCopyBufferInfo2 createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
dstBufferback to summary
public long dstBuffer()

the destination buffer.

Annotations
@NativeType:VkBuffer
dstBufferback to summary
public VkCopyBufferInfo2 dstBuffer(long value)

Sets the specified value to the dstBuffer field.

mallocback to summary
public static VkCopyBufferInfo2 malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkCopyBufferInfo2 malloc(MemoryStack stack)

Returns a new VkCopyBufferInfo2 instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ndstBufferback to summary
public static long ndstBuffer(long struct)

Unsafe version of dstBuffer.

ndstBufferback to summary
public static void ndstBuffer(long struct, long value)

Unsafe version of dstBuffer.

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.

npRegionsback to summary
public static VkBufferCopy2.Buffer npRegions(long struct)

Unsafe version of pRegions.

npRegionsback to summary
public static void npRegions(long struct, VkBufferCopy2.Buffer value)

Unsafe version of pRegions.

nregionCountback to summary
public static int nregionCount(long struct)

Unsafe version of regionCount.

nregionCountback to summary
public static void nregionCount(long struct, int value)

Sets the specified value to the regionCount field of the specified struct.

nsrcBufferback to summary
public static long nsrcBuffer(long struct)

Unsafe version of srcBuffer.

nsrcBufferback to summary
public static void nsrcBuffer(long struct, long value)

Unsafe version of srcBuffer.

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 VkCopyBufferInfo2 pNext(long value)

Sets the specified value to the pNext field.

pRegionsback to summary
public VkBufferCopy2.Buffer pRegions()

a pointer to an array of VkBufferCopy2 structures specifying the regions to copy.

Annotations
@NativeType:VkBufferCopy2 const *
pRegionsback to summary
public VkCopyBufferInfo2 pRegions(VkBufferCopy2.Buffer value)

Sets the address of the specified VkBufferCopy2.Buffer to the pRegions field.

regionCountback to summary
public int regionCount()

the number of regions to copy.

Annotations
@NativeType:uint32_t
setback to summary
public VkCopyBufferInfo2 set(int sType, long pNext, long srcBuffer, long dstBuffer, VkBufferCopy2.Buffer pRegions)

Initializes this struct with the specified values.

setback to summary
public VkCopyBufferInfo2 set(VkCopyBufferInfo2 src)

Copies the specified struct data to this struct.

Parameters
src:VkCopyBufferInfo2

the source struct

Returns:VkCopyBufferInfo2

this struct

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
srcBufferback to summary
public long srcBuffer()

the source buffer.

Annotations
@NativeType:VkBuffer
srcBufferback to summary
public VkCopyBufferInfo2 srcBuffer(long value)

Sets the specified value to the srcBuffer field.

sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_COPY_BUFFER_INFO_2 value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkCopyBufferInfo2.Buffer

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

An array of VkCopyBufferInfo2 structs.

Field Summary

Modifier and TypeField and Description
private static final VkCopyBufferInfo2

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkCopyBufferInfo2.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 VkCopyBufferInfo2#dstBuffer field.
dstBuffer
()

public VkCopyBufferInfo2.Buffer
dstBuffer(long value)

Sets the specified value to the VkCopyBufferInfo2#dstBuffer field.

protected VkCopyBufferInfo2
public long

Returns:

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

public VkCopyBufferInfo2.Buffer
pNext(long value)

Sets the specified value to the VkCopyBufferInfo2#pNext field.

public VkBufferCopy2.Buffer

Returns:

a VkBufferCopy2.Buffer view of the struct array pointed to by the VkCopyBufferInfo2#pRegions field.
pRegions
()

public VkCopyBufferInfo2.Buffer
pRegions(VkBufferCopy2.Buffer value)

Sets the address of the specified VkBufferCopy2.Buffer to the VkCopyBufferInfo2#pRegions field.

public int

Returns:

the value of the VkCopyBufferInfo2#regionCount field.
regionCount
()

protected VkCopyBufferInfo2.Buffer
public long

Returns:

the value of the VkCopyBufferInfo2#srcBuffer field.
srcBuffer
()

public VkCopyBufferInfo2.Buffer
srcBuffer(long value)

Sets the specified value to the VkCopyBufferInfo2#srcBuffer field.

public int

Returns:

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

public VkCopyBufferInfo2.Buffer
sType(int value)

Sets the specified value to the VkCopyBufferInfo2#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkCopyBufferInfo2 ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkCopyBufferInfo2.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 VkCopyBufferInfo2#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

dstBufferback to summary
public long dstBuffer()
Returns:long

the value of the VkCopyBufferInfo2#dstBuffer field.

Annotations
@NativeType:VkBuffer
dstBufferback to summary
public VkCopyBufferInfo2.Buffer dstBuffer(long value)

Sets the specified value to the VkCopyBufferInfo2#dstBuffer field.

getElementFactoryback to summary
protected VkCopyBufferInfo2 getElementFactory()

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

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

the value of the VkCopyBufferInfo2#pNext field.

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

Sets the specified value to the VkCopyBufferInfo2#pNext field.

pRegionsback to summary
public VkBufferCopy2.Buffer pRegions()
Returns:VkBufferCopy2.Buffer

a VkBufferCopy2.Buffer view of the struct array pointed to by the VkCopyBufferInfo2#pRegions field.

Annotations
@NativeType:VkBufferCopy2 const *
pRegionsback to summary
public VkCopyBufferInfo2.Buffer pRegions(VkBufferCopy2.Buffer value)

Sets the address of the specified VkBufferCopy2.Buffer to the VkCopyBufferInfo2#pRegions field.

regionCountback to summary
public int regionCount()
Returns:int

the value of the VkCopyBufferInfo2#regionCount field.

Annotations
@NativeType:uint32_t
selfback to summary
protected VkCopyBufferInfo2.Buffer self()

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

Annotations
@Override
srcBufferback to summary
public long srcBuffer()
Returns:long

the value of the VkCopyBufferInfo2#srcBuffer field.

Annotations
@NativeType:VkBuffer
srcBufferback to summary
public VkCopyBufferInfo2.Buffer srcBuffer(long value)

Sets the specified value to the VkCopyBufferInfo2#srcBuffer field.

sTypeback to summary
public int sType()
Returns:int

the value of the VkCopyBufferInfo2#sType field.

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

Sets the specified value to the VkCopyBufferInfo2#sType field.

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

Sets the STRUCTURE_TYPE_COPY_BUFFER_INFO_2 value to the VkCopyBufferInfo2#sType field.