Class VkCopyMemoryIndirectInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCopyMemoryIndirectInfoKHR>

org.lwjgl.vulkan.VkCopyMemoryIndirectInfoKHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkCopyMemoryIndirectInfoKHR
extends Struct<VkCopyMemoryIndirectInfoKHR>
implements NativeResource

struct VkCopyMemoryIndirectInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkAddressCopyFlagsKHR srcCopyFlags;
    VkAddressCopyFlagsKHR dstCopyFlags;
    uint32_t copyCount;
    VkStridedDeviceAddressRangeKHR copyAddressRange;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkCopyMemoryIndirectInfoKHR.Buffer	An array of VkCopyMemoryIndirectInfoKHR structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	COPYADDRESSRANGE	The struct member offsets.
static final int	COPYCOUNT	The struct member offsets.
static final int	DSTCOPYFLAGS	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SRCCOPYFLAGS	The struct member offsets.
static final int	STYPE	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkCopyMemoryIndirectInfoKHR	calloc()	Returns a new VkCopyMemoryIndirectInfoKHR instance allocated with memCalloc.
static VkCopyMemoryIndirectInfoKHR.Buffer	calloc(int capacity)	Returns a new VkCopyMemoryIndirectInfoKHR.Buffer instance allocated with memCalloc.
static VkCopyMemoryIndirectInfoKHR.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkCopyMemoryIndirectInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkCopyMemoryIndirectInfoKHR	calloc(MemoryStack stack)	Returns a new VkCopyMemoryIndirectInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
VkStridedDeviceAddressRangeKHR	copyAddressRange()
VkCopyMemoryIndirectInfoKHR	copyAddressRange(Consumer<VkStridedDeviceAddressRangeKHR> consumer)	Passes the copyAddressRange field to the specified Consumer.
VkCopyMemoryIndirectInfoKHR	copyAddressRange(VkStridedDeviceAddressRangeKHR value)	Copies the specified VkStridedDeviceAddressRangeKHR to the copyAddressRange field.
int	copyCount()
VkCopyMemoryIndirectInfoKHR	copyCount(int value)	Sets the specified value to the copyCount field.
static VkCopyMemoryIndirectInfoKHR	create()	Returns a new VkCopyMemoryIndirectInfoKHR instance allocated with BufferUtils.
static VkCopyMemoryIndirectInfoKHR.Buffer	create(int capacity)	Returns a new VkCopyMemoryIndirectInfoKHR.Buffer instance allocated with BufferUtils.
static VkCopyMemoryIndirectInfoKHR	create(long address)	Returns a new VkCopyMemoryIndirectInfoKHR instance for the specified memory address.
static VkCopyMemoryIndirectInfoKHR.Buffer	create(long address, int capacity)	Create a VkCopyMemoryIndirectInfoKHR.Buffer instance at the specified memory.
static @Nullable VkCopyMemoryIndirectInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkCopyMemoryIndirectInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	dstCopyFlags()
VkCopyMemoryIndirectInfoKHR	dstCopyFlags(int value)	Sets the specified value to the dstCopyFlags field.
static VkCopyMemoryIndirectInfoKHR	malloc()	Returns a new VkCopyMemoryIndirectInfoKHR instance allocated with memAlloc.
static VkCopyMemoryIndirectInfoKHR.Buffer	malloc(int capacity)	Returns a new VkCopyMemoryIndirectInfoKHR.Buffer instance allocated with memAlloc.
static VkCopyMemoryIndirectInfoKHR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkCopyMemoryIndirectInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkCopyMemoryIndirectInfoKHR	malloc(MemoryStack stack)	Returns a new VkCopyMemoryIndirectInfoKHR instance allocated on the specified MemoryStack.
static VkStridedDeviceAddressRangeKHR	ncopyAddressRange(long struct)	Unsafe version of copyAddressRange().
static void	ncopyAddressRange(long struct, VkStridedDeviceAddressRangeKHR value)	Unsafe version of copyAddressRange.
static int	ncopyCount(long struct)	Unsafe version of copyCount().
static void	ncopyCount(long struct, int value)	Unsafe version of copyCount.
static int	ndstCopyFlags(long struct)	Unsafe version of dstCopyFlags().
static void	ndstCopyFlags(long struct, int value)	Unsafe version of dstCopyFlags.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsrcCopyFlags(long struct)	Unsafe version of srcCopyFlags().
static void	nsrcCopyFlags(long struct, int value)	Unsafe version of srcCopyFlags.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()
VkCopyMemoryIndirectInfoKHR	pNext(long value)	Sets the specified value to the pNext field.
VkCopyMemoryIndirectInfoKHR	set(int sType, long pNext, int srcCopyFlags, int dstCopyFlags, int copyCount, VkStridedDeviceAddressRangeKHR copyAddressRange)	Initializes this struct with the specified values.
VkCopyMemoryIndirectInfoKHR	set(VkCopyMemoryIndirectInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	srcCopyFlags()
VkCopyMemoryIndirectInfoKHR	srcCopyFlags(int value)	Sets the specified value to the srcCopyFlags field.
int	sType()
VkCopyMemoryIndirectInfoKHR	sType(int value)	Sets the specified value to the sType field.
VkCopyMemoryIndirectInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_COPY_MEMORY_INDIRECT_INFO_KHR value to the sType field.

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

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

SRCCOPYFLAGS

public static final int SRCCOPYFLAGS

The struct member offsets.

DSTCOPYFLAGS

public static final int DSTCOPYFLAGS

The struct member offsets.

COPYCOUNT

public static final int COPYCOUNT

The struct member offsets.

COPYADDRESSRANGE

public static final int COPYADDRESSRANGE

The struct member offsets.

Constructor Details

VkCopyMemoryIndirectInfoKHR

public VkCopyMemoryIndirectInfoKHR(ByteBuffer container)

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

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkCopyMemoryIndirectInfoKHR>

sType

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

Returns:

the value of the sType field.

pNext

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

Returns:

the value of the pNext field.

srcCopyFlags

@NativeType("VkAddressCopyFlagsKHR")
public int srcCopyFlags()

Returns:

the value of the srcCopyFlags field.

dstCopyFlags

@NativeType("VkAddressCopyFlagsKHR")
public int dstCopyFlags()

Returns:

the value of the dstCopyFlags field.

copyCount

@NativeType("uint32_t")
public int copyCount()

Returns:

the value of the copyCount field.

copyAddressRange

public VkStridedDeviceAddressRangeKHR copyAddressRange()

Returns:

a VkStridedDeviceAddressRangeKHR view of the copyAddressRange field.

sType

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

Sets the specified value to the sType field.

sType$Default

public VkCopyMemoryIndirectInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_COPY_MEMORY_INDIRECT_INFO_KHR value to the sType field.

pNext

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

Sets the specified value to the pNext field.

srcCopyFlags

public VkCopyMemoryIndirectInfoKHR srcCopyFlags(@NativeType("VkAddressCopyFlagsKHR")
 int value)

Sets the specified value to the srcCopyFlags field.

dstCopyFlags

public VkCopyMemoryIndirectInfoKHR dstCopyFlags(@NativeType("VkAddressCopyFlagsKHR")
 int value)

Sets the specified value to the dstCopyFlags field.

copyCount

public VkCopyMemoryIndirectInfoKHR copyCount(@NativeType("uint32_t")
 int value)

Sets the specified value to the copyCount field.

copyAddressRange

public VkCopyMemoryIndirectInfoKHR copyAddressRange(VkStridedDeviceAddressRangeKHR value)

Copies the specified VkStridedDeviceAddressRangeKHR to the copyAddressRange field.

copyAddressRange

public VkCopyMemoryIndirectInfoKHR copyAddressRange(Consumer<VkStridedDeviceAddressRangeKHR> consumer)

Passes the copyAddressRange field to the specified Consumer.

set

public VkCopyMemoryIndirectInfoKHR set(int sType,
 long pNext,
 int srcCopyFlags,
 int dstCopyFlags,
 int copyCount,
 VkStridedDeviceAddressRangeKHR copyAddressRange)

Initializes this struct with the specified values.

set

public VkCopyMemoryIndirectInfoKHR set(VkCopyMemoryIndirectInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkCopyMemoryIndirectInfoKHR malloc()

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

calloc

public static VkCopyMemoryIndirectInfoKHR calloc()

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

create

public static VkCopyMemoryIndirectInfoKHR create()

Returns a new VkCopyMemoryIndirectInfoKHR instance allocated with BufferUtils.

create

public static VkCopyMemoryIndirectInfoKHR create(long address)

Returns a new VkCopyMemoryIndirectInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkCopyMemoryIndirectInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkCopyMemoryIndirectInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkCopyMemoryIndirectInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkCopyMemoryIndirectInfoKHR.Buffer create(int capacity)

Returns a new VkCopyMemoryIndirectInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkCopyMemoryIndirectInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkCopyMemoryIndirectInfoKHR malloc(MemoryStack stack)

Returns a new VkCopyMemoryIndirectInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkCopyMemoryIndirectInfoKHR calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkCopyMemoryIndirectInfoKHR.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

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nsrcCopyFlags

public static int nsrcCopyFlags(long struct)

Unsafe version of srcCopyFlags().

ndstCopyFlags

public static int ndstCopyFlags(long struct)

Unsafe version of dstCopyFlags().

ncopyCount

public static int ncopyCount(long struct)

Unsafe version of copyCount().

ncopyAddressRange

public static VkStridedDeviceAddressRangeKHR ncopyAddressRange(long struct)

Unsafe version of copyAddressRange().

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.

nsrcCopyFlags

public static void nsrcCopyFlags(long struct,
 int value)

Unsafe version of srcCopyFlags.

ndstCopyFlags

public static void ndstCopyFlags(long struct,
 int value)

Unsafe version of dstCopyFlags.

ncopyCount

public static void ncopyCount(long struct,
 int value)

Unsafe version of copyCount.

ncopyAddressRange

public static void ncopyAddressRange(long struct,
 VkStridedDeviceAddressRangeKHR value)

Unsafe version of copyAddressRange.