Class VkCopyBufferInfo2KHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCopyBufferInfo2>

org.lwjgl.vulkan.VkCopyBufferInfo2

org.lwjgl.vulkan.VkCopyBufferInfo2KHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkCopyBufferInfo2KHR
extends VkCopyBufferInfo2

struct VkCopyBufferInfo2KHR {
    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	VkCopyBufferInfo2KHR.Buffer	An array of VkCopyBufferInfo2KHR structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields inherited from class VkCopyBufferInfo2

ALIGNOF, DSTBUFFER, PNEXT, PREGIONS, REGIONCOUNT, SIZEOF, SRCBUFFER, STYPE

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkCopyBufferInfo2KHR(ByteBuffer container)	Creates a VkCopyBufferInfo2KHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkCopyBufferInfo2KHR	calloc()	Returns a new VkCopyBufferInfo2KHR instance allocated with memCalloc.
static VkCopyBufferInfo2KHR.Buffer	calloc(int capacity)	Returns a new VkCopyBufferInfo2KHR.Buffer instance allocated with memCalloc.
static VkCopyBufferInfo2KHR.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkCopyBufferInfo2KHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkCopyBufferInfo2KHR	calloc(MemoryStack stack)	Returns a new VkCopyBufferInfo2KHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkCopyBufferInfo2KHR	create()	Returns a new VkCopyBufferInfo2KHR instance allocated with BufferUtils.
static VkCopyBufferInfo2KHR.Buffer	create(int capacity)	Returns a new VkCopyBufferInfo2KHR.Buffer instance allocated with BufferUtils.
static VkCopyBufferInfo2KHR	create(long address)	Returns a new VkCopyBufferInfo2KHR instance for the specified memory address.
static VkCopyBufferInfo2KHR.Buffer	create(long address, int capacity)	Create a VkCopyBufferInfo2KHR.Buffer instance at the specified memory.
static @Nullable VkCopyBufferInfo2KHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkCopyBufferInfo2KHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkCopyBufferInfo2KHR	dstBuffer(long value)	Sets the specified value to the dstBuffer field.
static VkCopyBufferInfo2KHR	malloc()	Returns a new VkCopyBufferInfo2KHR instance allocated with memAlloc.
static VkCopyBufferInfo2KHR.Buffer	malloc(int capacity)	Returns a new VkCopyBufferInfo2KHR.Buffer instance allocated with memAlloc.
static VkCopyBufferInfo2KHR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkCopyBufferInfo2KHR.Buffer instance allocated on the specified MemoryStack.
static VkCopyBufferInfo2KHR	malloc(MemoryStack stack)	Returns a new VkCopyBufferInfo2KHR instance allocated on the specified MemoryStack.
VkCopyBufferInfo2KHR	pNext(long value)	Sets the specified value to the pNext field.
VkCopyBufferInfo2KHR	pRegions(VkBufferCopy2.Buffer value)	Sets the address of the specified VkBufferCopy2.Buffer to the pRegions field.
VkCopyBufferInfo2KHR	set(int sType, long pNext, long srcBuffer, long dstBuffer, VkBufferCopy2.Buffer pRegions)	Initializes this struct with the specified values.
VkCopyBufferInfo2KHR	set(VkCopyBufferInfo2KHR src)	Copies the specified struct data to this struct.
VkCopyBufferInfo2KHR	srcBuffer(long value)	Sets the specified value to the srcBuffer field.
VkCopyBufferInfo2KHR	sType(int value)	Sets the specified value to the sType field.
VkCopyBufferInfo2KHR	sType$Default()	Sets the STRUCTURE_TYPE_COPY_BUFFER_INFO_2 value to the sType field.

Methods inherited from class VkCopyBufferInfo2

dstBuffer, ndstBuffer, ndstBuffer, npNext, npNext, npRegions, npRegions, nregionCount, nregionCount, nsrcBuffer, nsrcBuffer, nsType, nsType, pNext, pRegions, regionCount, set, sizeof, srcBuffer, sType, validate

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NativeResource

close, free

Constructor Details

VkCopyBufferInfo2KHR

public VkCopyBufferInfo2KHR(ByteBuffer container)

Creates a VkCopyBufferInfo2KHR 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 Details

sType

public VkCopyBufferInfo2KHR sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

Overrides:

sType in class VkCopyBufferInfo2

sType$Default

public VkCopyBufferInfo2KHR sType$Default()

Sets the STRUCTURE_TYPE_COPY_BUFFER_INFO_2 value to the sType field.

Overrides:

sType$Default in class VkCopyBufferInfo2

pNext

public VkCopyBufferInfo2KHR pNext(@NativeType("void const *")
 long value)

Sets the specified value to the pNext field.

Overrides:

pNext in class VkCopyBufferInfo2

srcBuffer

public VkCopyBufferInfo2KHR srcBuffer(@NativeType("VkBuffer")
 long value)

Sets the specified value to the srcBuffer field.

Overrides:

srcBuffer in class VkCopyBufferInfo2

dstBuffer

public VkCopyBufferInfo2KHR dstBuffer(@NativeType("VkBuffer")
 long value)

Sets the specified value to the dstBuffer field.

Overrides:

dstBuffer in class VkCopyBufferInfo2

pRegions

public VkCopyBufferInfo2KHR pRegions(@NativeType("VkBufferCopy2 const *")
 VkBufferCopy2.Buffer value)

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

Overrides:

pRegions in class VkCopyBufferInfo2

set

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

Initializes this struct with the specified values.

Overrides:

set in class VkCopyBufferInfo2

set

public VkCopyBufferInfo2KHR set(VkCopyBufferInfo2KHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkCopyBufferInfo2KHR malloc()

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

calloc

public static VkCopyBufferInfo2KHR calloc()

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

create

public static VkCopyBufferInfo2KHR create()

Returns a new VkCopyBufferInfo2KHR instance allocated with BufferUtils.

create

public static VkCopyBufferInfo2KHR create(long address)

Returns a new VkCopyBufferInfo2KHR instance for the specified memory address.

createSafe

public static @Nullable VkCopyBufferInfo2KHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkCopyBufferInfo2KHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkCopyBufferInfo2KHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkCopyBufferInfo2KHR.Buffer create(int capacity)

Returns a new VkCopyBufferInfo2KHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkCopyBufferInfo2KHR.Buffer create(long address,
 int capacity)

Create a VkCopyBufferInfo2KHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkCopyBufferInfo2KHR.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkCopyBufferInfo2KHR malloc(MemoryStack stack)

Returns a new VkCopyBufferInfo2KHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkCopyBufferInfo2KHR calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkCopyBufferInfo2KHR.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkCopyBufferInfo2KHR.Buffer calloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate