Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkCopyMemoryIndirectCommandNV

extends Struct<VkCopyMemoryIndirectCommandNV>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying indirect memory region copy operation.
Valid Usage

Layout


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

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
DSTADDRESS

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
SRCADDRESS

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkCopyMemoryIndirectCommandNV(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkCopyMemoryIndirectCommandNV
calloc()

Returns a new VkCopyMemoryIndirectCommandNV instance allocated with memCalloc.

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

Returns a new VkCopyMemoryIndirectCommandNV.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkCopyMemoryIndirectCommandNV instance allocated with BufferUtils.

public static VkCopyMemoryIndirectCommandNV
create(long address)

Returns a new VkCopyMemoryIndirectCommandNV instance for the specified memory address.

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

Returns a new VkCopyMemoryIndirectCommandNV.Buffer instance allocated with BufferUtils.

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

Create a VkCopyMemoryIndirectCommandNV.Buffer instance at the specified memory.

public static VkCopyMemoryIndirectCommandNV
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
dstAddress()

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

public VkCopyMemoryIndirectCommandNV
dstAddress(long value)

Sets the specified value to the dstAddress field.

public static VkCopyMemoryIndirectCommandNV
malloc()

Returns a new VkCopyMemoryIndirectCommandNV instance allocated with memAlloc.

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

Returns a new VkCopyMemoryIndirectCommandNV.Buffer instance allocated with memAlloc.

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

Returns a new VkCopyMemoryIndirectCommandNV instance allocated on the specified MemoryStack.

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

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

public static long
ndstAddress(long struct)

Unsafe version of dstAddress.

public static void
ndstAddress(long struct, long value)

Unsafe version of dstAddress.

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
nsrcAddress(long struct)

Unsafe version of srcAddress.

public static void
nsrcAddress(long struct, long value)

Unsafe version of srcAddress.

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

Initializes this struct with the specified values.

public VkCopyMemoryIndirectCommandNV

Returns:

this struct
set
(VkCopyMemoryIndirectCommandNV
the source struct
src
)

Copies the specified struct data to this struct.

public long
size()

the size of the copy in bytes.

public VkCopyMemoryIndirectCommandNV
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
srcAddress()

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

public VkCopyMemoryIndirectCommandNV
srcAddress(long value)

Sets the specified value to the srcAddress 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.

DSTADDRESSback to summary
public static final int DSTADDRESS

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.

SRCADDRESSback to summary
public static final int SRCADDRESS

The struct member offsets.

Constructor Detail

VkCopyMemoryIndirectCommandNVback to summary
protected VkCopyMemoryIndirectCommandNV(long address, ByteBuffer container)
VkCopyMemoryIndirectCommandNVback to summary
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 Detail

callocback to summary
public static VkCopyMemoryIndirectCommandNV calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkCopyMemoryIndirectCommandNV calloc(MemoryStack stack)

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

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

Returns a new VkCopyMemoryIndirectCommandNV instance allocated with BufferUtils.

createback to summary
public static VkCopyMemoryIndirectCommandNV create(long address)

Returns a new VkCopyMemoryIndirectCommandNV instance for the specified memory address.

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

Returns a new VkCopyMemoryIndirectCommandNV.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkCopyMemoryIndirectCommandNV.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkCopyMemoryIndirectCommandNV createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
dstAddressback to summary
public long dstAddress()

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

Annotations
@NativeType:VkDeviceAddress
dstAddressback to summary
public VkCopyMemoryIndirectCommandNV dstAddress(long value)

Sets the specified value to the dstAddress field.

mallocback to summary
public static VkCopyMemoryIndirectCommandNV malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkCopyMemoryIndirectCommandNV malloc(MemoryStack stack)

Returns a new VkCopyMemoryIndirectCommandNV instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ndstAddressback to summary
public static long ndstAddress(long struct)

Unsafe version of dstAddress.

ndstAddressback to summary
public static void ndstAddress(long struct, long value)

Unsafe version of dstAddress.

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.

nsrcAddressback to summary
public static long nsrcAddress(long struct)

Unsafe version of srcAddress.

nsrcAddressback to summary
public static void nsrcAddress(long struct, long value)

Unsafe version of srcAddress.

setback to summary
public VkCopyMemoryIndirectCommandNV set(long srcAddress, long dstAddress, long size)

Initializes this struct with the specified values.

setback to summary
public VkCopyMemoryIndirectCommandNV set(VkCopyMemoryIndirectCommandNV src)

Copies the specified struct data to this struct.

Parameters
src:VkCopyMemoryIndirectCommandNV

the source struct

Returns:VkCopyMemoryIndirectCommandNV

this struct

sizeback to summary
public long size()

the size of the copy in bytes.

Annotations
@NativeType:VkDeviceSize
sizeback to summary
public VkCopyMemoryIndirectCommandNV 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
srcAddressback to summary
public long srcAddress()

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

Annotations
@NativeType:VkDeviceAddress
srcAddressback to summary
public VkCopyMemoryIndirectCommandNV srcAddress(long value)

Sets the specified value to the srcAddress field.

org.lwjgl.vulkan back to summary

public Class VkCopyMemoryIndirectCommandNV.Buffer

extends StructBuffer<VkCopyMemoryIndirectCommandNV, VkCopyMemoryIndirectCommandNV.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkCopyMemoryIndirectCommandNV structs.

Field Summary

Modifier and TypeField and Description
private static final VkCopyMemoryIndirectCommandNV

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

public VkCopyMemoryIndirectCommandNV.Buffer
dstAddress(long value)

Sets the specified value to the VkCopyMemoryIndirectCommandNV#dstAddress field.

protected VkCopyMemoryIndirectCommandNV
protected VkCopyMemoryIndirectCommandNV.Buffer
public long

Returns:

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

public VkCopyMemoryIndirectCommandNV.Buffer
size(long value)

Sets the specified value to the VkCopyMemoryIndirectCommandNV#size field.

public long

Returns:

the value of the VkCopyMemoryIndirectCommandNV#srcAddress field.
srcAddress
()

public VkCopyMemoryIndirectCommandNV.Buffer
srcAddress(long value)

Sets the specified value to the VkCopyMemoryIndirectCommandNV#srcAddress field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkCopyMemoryIndirectCommandNV ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

dstAddressback to summary
public long dstAddress()
Returns:long

the value of the VkCopyMemoryIndirectCommandNV#dstAddress field.

Annotations
@NativeType:VkDeviceAddress
dstAddressback to summary
public VkCopyMemoryIndirectCommandNV.Buffer dstAddress(long value)

Sets the specified value to the VkCopyMemoryIndirectCommandNV#dstAddress field.

getElementFactoryback to summary
protected VkCopyMemoryIndirectCommandNV getElementFactory()

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

Annotations
@Override
selfback to summary
protected VkCopyMemoryIndirectCommandNV.Buffer self()

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

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

the value of the VkCopyMemoryIndirectCommandNV#size field.

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

Sets the specified value to the VkCopyMemoryIndirectCommandNV#size field.

srcAddressback to summary
public long srcAddress()
Returns:long

the value of the VkCopyMemoryIndirectCommandNV#srcAddress field.

Annotations
@NativeType:VkDeviceAddress
srcAddressback to summary
public VkCopyMemoryIndirectCommandNV.Buffer srcAddress(long value)

Sets the specified value to the VkCopyMemoryIndirectCommandNV#srcAddress field.