Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDrawIndirectCommand

extends Struct<VkDrawIndirectCommand>
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 a indirect drawing command.
Description

The members of VkDrawIndirectCommand have the same meaning as the similarly named parameters of CmdDraw.

Valid Usage
See Also

CmdDrawIndirect

Layout


struct VkDrawIndirectCommand {
    uint32_t vertexCount;
    uint32_t instanceCount;
    uint32_t firstVertex;
    uint32_t firstInstance;
}

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
FIRSTINSTANCE

The struct member offsets.

public static final int
FIRSTVERTEX

The struct member offsets.

public static final int
INSTANCECOUNT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
VERTEXCOUNT

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkDrawIndirectCommand(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkDrawIndirectCommand
calloc()

Returns a new VkDrawIndirectCommand instance allocated with memCalloc.

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

Returns a new VkDrawIndirectCommand.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkDrawIndirectCommand
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkDrawIndirectCommand
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDrawIndirectCommand.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDrawIndirectCommand.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkDrawIndirectCommand
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 VkDrawIndirectCommand
create()

Returns a new VkDrawIndirectCommand instance allocated with BufferUtils.

public static VkDrawIndirectCommand
create(long address)

Returns a new VkDrawIndirectCommand instance for the specified memory address.

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

Returns a new VkDrawIndirectCommand.Buffer instance allocated with BufferUtils.

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

Create a VkDrawIndirectCommand.Buffer instance at the specified memory.

public static VkDrawIndirectCommand
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
firstInstance()

the instance ID of the first instance to draw.

public VkDrawIndirectCommand
firstInstance(int value)

Sets the specified value to the firstInstance field.

public int
firstVertex()

the index of the first vertex to draw.

public VkDrawIndirectCommand
firstVertex(int value)

Sets the specified value to the firstVertex field.

public int
instanceCount()

the number of instances to draw.

public VkDrawIndirectCommand
instanceCount(int value)

Sets the specified value to the instanceCount field.

public static VkDrawIndirectCommand
malloc()

Returns a new VkDrawIndirectCommand instance allocated with memAlloc.

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

Returns a new VkDrawIndirectCommand.Buffer instance allocated with memAlloc.

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

Returns a new VkDrawIndirectCommand instance allocated on the specified MemoryStack.

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

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

public static VkDrawIndirectCommand
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkDrawIndirectCommand
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDrawIndirectCommand.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDrawIndirectCommand.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
nfirstInstance(long struct)

Unsafe version of firstInstance.

public static void
nfirstInstance(long struct, int value)

Unsafe version of firstInstance.

public static int
nfirstVertex(long struct)

Unsafe version of firstVertex.

public static void
nfirstVertex(long struct, int value)

Unsafe version of firstVertex.

public static int
ninstanceCount(long struct)

Unsafe version of instanceCount.

public static void
ninstanceCount(long struct, int value)

Unsafe version of instanceCount.

public static int
nvertexCount(long struct)

Unsafe version of vertexCount.

public static void
nvertexCount(long struct, int value)

Unsafe version of vertexCount.

public VkDrawIndirectCommand
set(int vertexCount, int instanceCount, int firstVertex, int firstInstance)

Initializes this struct with the specified values.

public VkDrawIndirectCommand

Returns:

this struct
set
(VkDrawIndirectCommand
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 int
vertexCount()

the number of vertices to draw.

public VkDrawIndirectCommand
vertexCount(int value)

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

FIRSTINSTANCEback to summary
public static final int FIRSTINSTANCE

The struct member offsets.

FIRSTVERTEXback to summary
public static final int FIRSTVERTEX

The struct member offsets.

INSTANCECOUNTback to summary
public static final int INSTANCECOUNT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

VERTEXCOUNTback to summary
public static final int VERTEXCOUNT

The struct member offsets.

Constructor Detail

VkDrawIndirectCommandback to summary
protected VkDrawIndirectCommand(long address, ByteBuffer container)
VkDrawIndirectCommandback to summary
public VkDrawIndirectCommand(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkDrawIndirectCommand calloc(MemoryStack stack)

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

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

callocStackback to summary
public static VkDrawIndirectCommand callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkDrawIndirectCommand callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkDrawIndirectCommand.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkDrawIndirectCommand.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected VkDrawIndirectCommand 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 VkDrawIndirectCommand create()

Returns a new VkDrawIndirectCommand instance allocated with BufferUtils.

createback to summary
public static VkDrawIndirectCommand create(long address)

Returns a new VkDrawIndirectCommand instance for the specified memory address.

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

Returns a new VkDrawIndirectCommand.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkDrawIndirectCommand.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDrawIndirectCommand createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
firstInstanceback to summary
public int firstInstance()

the instance ID of the first instance to draw.

Annotations
@NativeType:uint32_t
firstInstanceback to summary
public VkDrawIndirectCommand firstInstance(int value)

Sets the specified value to the firstInstance field.

firstVertexback to summary
public int firstVertex()

the index of the first vertex to draw.

Annotations
@NativeType:uint32_t
firstVertexback to summary
public VkDrawIndirectCommand firstVertex(int value)

Sets the specified value to the firstVertex field.

instanceCountback to summary
public int instanceCount()

the number of instances to draw.

Annotations
@NativeType:uint32_t
instanceCountback to summary
public VkDrawIndirectCommand instanceCount(int value)

Sets the specified value to the instanceCount field.

mallocback to summary
public static VkDrawIndirectCommand malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDrawIndirectCommand malloc(MemoryStack stack)

Returns a new VkDrawIndirectCommand instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkDrawIndirectCommand mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkDrawIndirectCommand mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkDrawIndirectCommand.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkDrawIndirectCommand.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nfirstInstanceback to summary
public static int nfirstInstance(long struct)

Unsafe version of firstInstance.

nfirstInstanceback to summary
public static void nfirstInstance(long struct, int value)

Unsafe version of firstInstance.

nfirstVertexback to summary
public static int nfirstVertex(long struct)

Unsafe version of firstVertex.

nfirstVertexback to summary
public static void nfirstVertex(long struct, int value)

Unsafe version of firstVertex.

ninstanceCountback to summary
public static int ninstanceCount(long struct)

Unsafe version of instanceCount.

ninstanceCountback to summary
public static void ninstanceCount(long struct, int value)

Unsafe version of instanceCount.

nvertexCountback to summary
public static int nvertexCount(long struct)

Unsafe version of vertexCount.

nvertexCountback to summary
public static void nvertexCount(long struct, int value)

Unsafe version of vertexCount.

setback to summary
public VkDrawIndirectCommand set(int vertexCount, int instanceCount, int firstVertex, int firstInstance)

Initializes this struct with the specified values.

setback to summary
public VkDrawIndirectCommand set(VkDrawIndirectCommand src)

Copies the specified struct data to this struct.

Parameters
src:VkDrawIndirectCommand

the source struct

Returns:VkDrawIndirectCommand

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
vertexCountback to summary
public int vertexCount()

the number of vertices to draw.

Annotations
@NativeType:uint32_t
vertexCountback to summary
public VkDrawIndirectCommand vertexCount(int value)

Sets the specified value to the vertexCount field.

org.lwjgl.vulkan back to summary

public Class VkDrawIndirectCommand.Buffer

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

An array of VkDrawIndirectCommand structs.

Field Summary

Modifier and TypeField and Description
private static final VkDrawIndirectCommand

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkDrawIndirectCommand.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 int

Returns:

the value of the VkDrawIndirectCommand#firstInstance field.
firstInstance
()

public VkDrawIndirectCommand.Buffer
firstInstance(int value)

Sets the specified value to the VkDrawIndirectCommand#firstInstance field.

public int

Returns:

the value of the VkDrawIndirectCommand#firstVertex field.
firstVertex
()

public VkDrawIndirectCommand.Buffer
firstVertex(int value)

Sets the specified value to the VkDrawIndirectCommand#firstVertex field.

protected VkDrawIndirectCommand
public int

Returns:

the value of the VkDrawIndirectCommand#instanceCount field.
instanceCount
()

public VkDrawIndirectCommand.Buffer
instanceCount(int value)

Sets the specified value to the VkDrawIndirectCommand#instanceCount field.

protected VkDrawIndirectCommand.Buffer
public int

Returns:

the value of the VkDrawIndirectCommand#vertexCount field.
vertexCount
()

public VkDrawIndirectCommand.Buffer
vertexCount(int value)

Sets the specified value to the VkDrawIndirectCommand#vertexCount field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDrawIndirectCommand ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

firstInstanceback to summary
public int firstInstance()
Returns:int

the value of the VkDrawIndirectCommand#firstInstance field.

Annotations
@NativeType:uint32_t
firstInstanceback to summary
public VkDrawIndirectCommand.Buffer firstInstance(int value)

Sets the specified value to the VkDrawIndirectCommand#firstInstance field.

firstVertexback to summary
public int firstVertex()
Returns:int

the value of the VkDrawIndirectCommand#firstVertex field.

Annotations
@NativeType:uint32_t
firstVertexback to summary
public VkDrawIndirectCommand.Buffer firstVertex(int value)

Sets the specified value to the VkDrawIndirectCommand#firstVertex field.

getElementFactoryback to summary
protected VkDrawIndirectCommand getElementFactory()

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

Annotations
@Override
instanceCountback to summary
public int instanceCount()
Returns:int

the value of the VkDrawIndirectCommand#instanceCount field.

Annotations
@NativeType:uint32_t
instanceCountback to summary
public VkDrawIndirectCommand.Buffer instanceCount(int value)

Sets the specified value to the VkDrawIndirectCommand#instanceCount field.

selfback to summary
protected VkDrawIndirectCommand.Buffer self()

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

Annotations
@Override
vertexCountback to summary
public int vertexCount()
Returns:int

the value of the VkDrawIndirectCommand#vertexCount field.

Annotations
@NativeType:uint32_t
vertexCountback to summary
public VkDrawIndirectCommand.Buffer vertexCount(int value)

Sets the specified value to the VkDrawIndirectCommand#vertexCount field.