Package org.lwjgl.vulkan

Class VkCopyMemoryIndirectCommandNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCopyMemoryIndirectCommandNV>

org.lwjgl.vulkan.VkCopyMemoryIndirectCommandNV

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkCopyMemoryIndirectCommandNV
extends org.lwjgl.system.Struct<VkCopyMemoryIndirectCommandNV>
implements org.lwjgl.system.NativeResource

Structure specifying indirect memory region copy operation.

Valid Usage

• The srcAddress must be 4 byte aligned
• The dstAddress must be 4 byte aligned
• The size must be 4 byte aligned

Layout

 struct VkCopyMemoryIndirectCommandNV {
     VkDeviceAddress srcAddress();
     VkDeviceAddress dstAddress();
     VkDeviceSize size();
 }

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DSTADDRESS	The struct member offsets.
static final int	SIZE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SRCADDRESS	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	Description
VkCopyMemoryIndirectCommandNV(ByteBuffer container)	Creates a VkCopyMemoryIndirectCommandNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkCopyMemoryIndirectCommandNV	calloc()	Returns a new VkCopyMemoryIndirectCommandNV instance allocated with memCalloc.
static VkCopyMemoryIndirectCommandNV.Buffer	calloc(int capacity)	Returns a new VkCopyMemoryIndirectCommandNV.Buffer instance allocated with memCalloc.
static VkCopyMemoryIndirectCommandNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkCopyMemoryIndirectCommandNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkCopyMemoryIndirectCommandNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkCopyMemoryIndirectCommandNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkCopyMemoryIndirectCommandNV	create()	Returns a new VkCopyMemoryIndirectCommandNV instance allocated with BufferUtils.
static VkCopyMemoryIndirectCommandNV.Buffer	create(int capacity)	Returns a new VkCopyMemoryIndirectCommandNV.Buffer instance allocated with BufferUtils.
static VkCopyMemoryIndirectCommandNV	create(long address)	Returns a new VkCopyMemoryIndirectCommandNV instance for the specified memory address.
static VkCopyMemoryIndirectCommandNV.Buffer	create(long address, int capacity)	Create a VkCopyMemoryIndirectCommandNV.Buffer instance at the specified memory.
static @Nullable VkCopyMemoryIndirectCommandNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkCopyMemoryIndirectCommandNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	dstAddress()	the starting address of the destination device memory to copy to.
VkCopyMemoryIndirectCommandNV	dstAddress(long value)	Sets the specified value to the dstAddress() field.
static VkCopyMemoryIndirectCommandNV	malloc()	Returns a new VkCopyMemoryIndirectCommandNV instance allocated with memAlloc.
static VkCopyMemoryIndirectCommandNV.Buffer	malloc(int capacity)	Returns a new VkCopyMemoryIndirectCommandNV.Buffer instance allocated with memAlloc.
static VkCopyMemoryIndirectCommandNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkCopyMemoryIndirectCommandNV.Buffer instance allocated on the specified MemoryStack.
static VkCopyMemoryIndirectCommandNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkCopyMemoryIndirectCommandNV instance allocated on the specified MemoryStack.
static long	ndstAddress(long struct)	Unsafe version of dstAddress().
static void	ndstAddress(long struct, long value)	Unsafe version of dstAddress.
static long	nsize(long struct)	Unsafe version of size().
static void	nsize(long struct, long value)	Unsafe version of size.
static long	nsrcAddress(long struct)	Unsafe version of srcAddress().
static void	nsrcAddress(long struct, long value)	Unsafe version of srcAddress.
VkCopyMemoryIndirectCommandNV	set(long srcAddress, long dstAddress, long size)	Initializes this struct with the specified values.
VkCopyMemoryIndirectCommandNV	set(VkCopyMemoryIndirectCommandNV src)	Copies the specified struct data to this struct.
long	size()	the size of the copy in bytes.
VkCopyMemoryIndirectCommandNV	size(long value)	Sets the specified value to the size() field.
int	sizeof()
long	srcAddress()	the starting address of the source device memory to copy from.
VkCopyMemoryIndirectCommandNV	srcAddress(long value)	Sets the specified value to the srcAddress() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

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 Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

SRCADDRESS

public static final int SRCADDRESS

The struct member offsets.

DSTADDRESS

public static final int DSTADDRESS

The struct member offsets.

SIZE

public static final int SIZE

The struct member offsets.

Constructor Details

VkCopyMemoryIndirectCommandNV

public VkCopyMemoryIndirectCommandNV(ByteBuffer container)

Creates a VkCopyMemoryIndirectCommandNV 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()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkCopyMemoryIndirectCommandNV>

srcAddress

public long srcAddress()

the starting address of the source device memory to copy from.

dstAddress

public long dstAddress()

the starting address of the destination device memory to copy to.

size

public long size()

the size of the copy in bytes.

srcAddress

public VkCopyMemoryIndirectCommandNV srcAddress(long value)

Sets the specified value to the srcAddress() field.

dstAddress

public VkCopyMemoryIndirectCommandNV dstAddress(long value)

Sets the specified value to the dstAddress() field.

size

public VkCopyMemoryIndirectCommandNV size(long value)

Sets the specified value to the size() field.

set

public VkCopyMemoryIndirectCommandNV set(long srcAddress,
 long dstAddress,
 long size)

Initializes this struct with the specified values.

set

public VkCopyMemoryIndirectCommandNV set(VkCopyMemoryIndirectCommandNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkCopyMemoryIndirectCommandNV malloc()

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

calloc

public static VkCopyMemoryIndirectCommandNV calloc()

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

create

public static VkCopyMemoryIndirectCommandNV create()

Returns a new VkCopyMemoryIndirectCommandNV instance allocated with BufferUtils.

create

public static VkCopyMemoryIndirectCommandNV create(long address)

Returns a new VkCopyMemoryIndirectCommandNV instance for the specified memory address.

createSafe

public static @Nullable VkCopyMemoryIndirectCommandNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkCopyMemoryIndirectCommandNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkCopyMemoryIndirectCommandNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkCopyMemoryIndirectCommandNV.Buffer create(int capacity)

Returns a new VkCopyMemoryIndirectCommandNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkCopyMemoryIndirectCommandNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkCopyMemoryIndirectCommandNV malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkCopyMemoryIndirectCommandNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkCopyMemoryIndirectCommandNV calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkCopyMemoryIndirectCommandNV.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkCopyMemoryIndirectCommandNV.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

nsrcAddress

public static long nsrcAddress(long struct)

Unsafe version of srcAddress().

ndstAddress

public static long ndstAddress(long struct)

Unsafe version of dstAddress().

nsize

public static long nsize(long struct)

Unsafe version of size().

nsrcAddress

public static void nsrcAddress(long struct,
 long value)

Unsafe version of srcAddress.

ndstAddress

public static void ndstAddress(long struct,
 long value)

Unsafe version of dstAddress.

nsize

public static void nsize(long struct,
 long value)

Unsafe version of size.