Package org.lwjgl.vulkan

Class VkDrawIndirectCommand

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDrawIndirectCommand>

org.lwjgl.vulkan.VkDrawIndirectCommand

All Implemented Interfaces:

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

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

Structure specifying an indirect drawing command.

Description

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

Valid Usage

• If the bound graphics pipeline state was created with VkPipelineVertexInputDivisorStateCreateInfo in the pNext chain of VkGraphicsPipelineCreateInfo::pVertexInputState, any member of VkPipelineVertexInputDivisorStateCreateInfo::pVertexBindingDivisors has a value other than 1 in divisor, and VkPhysicalDeviceVertexAttributeDivisorProperties::supportsNonZeroFirstInstance is FALSE, then firstInstance must be 0
• If shader objects are used for drawing or the bound graphics pipeline state was created with the DYNAMIC_STATE_VERTEX_INPUT_EXT dynamic state enabled, any member of the pVertexBindingDescriptions parameter to the CmdSetVertexInputEXT call that sets this dynamic state has a value other than 1 in divisor, and VkPhysicalDeviceVertexAttributeDivisorProperties::supportsNonZeroFirstInstance is FALSE, then firstInstance must be 0

• If the drawIndirectFirstInstance feature is not enabled, firstInstance must be 0

See Also

CmdDrawIndirect

Layout

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkDrawIndirectCommand.Buffer	An array of VkDrawIndirectCommand 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	FIRSTINSTANCE	The struct member offsets.
static final int	FIRSTVERTEX	The struct member offsets.
static final int	INSTANCECOUNT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	VERTEXCOUNT	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
VkDrawIndirectCommand(ByteBuffer container)	Creates a VkDrawIndirectCommand instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkDrawIndirectCommand	calloc()	Returns a new VkDrawIndirectCommand instance allocated with memCalloc.
static VkDrawIndirectCommand.Buffer	calloc(int capacity)	Returns a new VkDrawIndirectCommand.Buffer instance allocated with memCalloc.
static VkDrawIndirectCommand.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDrawIndirectCommand.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDrawIndirectCommand	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDrawIndirectCommand instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDrawIndirectCommand	callocStack()	Deprecated.
static VkDrawIndirectCommand.Buffer	callocStack(int capacity)	Deprecated.
static VkDrawIndirectCommand.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDrawIndirectCommand	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDrawIndirectCommand	create()	Returns a new VkDrawIndirectCommand instance allocated with BufferUtils.
static VkDrawIndirectCommand.Buffer	create(int capacity)	Returns a new VkDrawIndirectCommand.Buffer instance allocated with BufferUtils.
static VkDrawIndirectCommand	create(long address)	Returns a new VkDrawIndirectCommand instance for the specified memory address.
static VkDrawIndirectCommand.Buffer	create(long address, int capacity)	Create a VkDrawIndirectCommand.Buffer instance at the specified memory.
static @Nullable VkDrawIndirectCommand	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDrawIndirectCommand.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	firstInstance()	the instance ID of the first instance to draw.
VkDrawIndirectCommand	firstInstance(int value)	Sets the specified value to the firstInstance() field.
int	firstVertex()	the index of the first vertex to draw.
VkDrawIndirectCommand	firstVertex(int value)	Sets the specified value to the firstVertex() field.
int	instanceCount()	the number of instances to draw.
VkDrawIndirectCommand	instanceCount(int value)	Sets the specified value to the instanceCount() field.
static VkDrawIndirectCommand	malloc()	Returns a new VkDrawIndirectCommand instance allocated with memAlloc.
static VkDrawIndirectCommand.Buffer	malloc(int capacity)	Returns a new VkDrawIndirectCommand.Buffer instance allocated with memAlloc.
static VkDrawIndirectCommand.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDrawIndirectCommand.Buffer instance allocated on the specified MemoryStack.
static VkDrawIndirectCommand	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDrawIndirectCommand instance allocated on the specified MemoryStack.
static VkDrawIndirectCommand	mallocStack()	Deprecated.
static VkDrawIndirectCommand.Buffer	mallocStack(int capacity)	Deprecated.
static VkDrawIndirectCommand.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDrawIndirectCommand	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	nfirstInstance(long struct)	Unsafe version of firstInstance().
static void	nfirstInstance(long struct, int value)	Unsafe version of firstInstance.
static int	nfirstVertex(long struct)	Unsafe version of firstVertex().
static void	nfirstVertex(long struct, int value)	Unsafe version of firstVertex.
static int	ninstanceCount(long struct)	Unsafe version of instanceCount().
static void	ninstanceCount(long struct, int value)	Unsafe version of instanceCount.
static int	nvertexCount(long struct)	Unsafe version of vertexCount().
static void	nvertexCount(long struct, int value)	Unsafe version of vertexCount.
VkDrawIndirectCommand	set(int vertexCount, int instanceCount, int firstVertex, int firstInstance)	Initializes this struct with the specified values.
VkDrawIndirectCommand	set(VkDrawIndirectCommand src)	Copies the specified struct data to this struct.
int	sizeof()
int	vertexCount()	the number of vertices to draw.
VkDrawIndirectCommand	vertexCount(int value)	Sets the specified value to the vertexCount() 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.

VERTEXCOUNT

public static final int VERTEXCOUNT

The struct member offsets.

INSTANCECOUNT

public static final int INSTANCECOUNT

The struct member offsets.

FIRSTVERTEX

public static final int FIRSTVERTEX

The struct member offsets.

FIRSTINSTANCE

public static final int FIRSTINSTANCE

The struct member offsets.

Constructor Details

VkDrawIndirectCommand

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 Details

sizeof

public int sizeof()

Specified by:

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

vertexCount

public int vertexCount()

the number of vertices to draw.

instanceCount

public int instanceCount()

the number of instances to draw.

firstVertex

public int firstVertex()

the index of the first vertex to draw.

firstInstance

public int firstInstance()

the instance ID of the first instance to draw.

vertexCount

public VkDrawIndirectCommand vertexCount(int value)

Sets the specified value to the vertexCount() field.

instanceCount

public VkDrawIndirectCommand instanceCount(int value)

Sets the specified value to the instanceCount() field.

firstVertex

public VkDrawIndirectCommand firstVertex(int value)

Sets the specified value to the firstVertex() field.

firstInstance

public VkDrawIndirectCommand firstInstance(int value)

Sets the specified value to the firstInstance() field.

set

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

Initializes this struct with the specified values.

set

public VkDrawIndirectCommand set(VkDrawIndirectCommand src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDrawIndirectCommand malloc()

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

calloc

public static VkDrawIndirectCommand calloc()

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

create

public static VkDrawIndirectCommand create()

Returns a new VkDrawIndirectCommand instance allocated with BufferUtils.

create

public static VkDrawIndirectCommand create(long address)

Returns a new VkDrawIndirectCommand instance for the specified memory address.

createSafe

public static @Nullable VkDrawIndirectCommand createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDrawIndirectCommand.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDrawIndirectCommand.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDrawIndirectCommand.Buffer create(int capacity)

Returns a new VkDrawIndirectCommand.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDrawIndirectCommand.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkDrawIndirectCommand mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkDrawIndirectCommand callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkDrawIndirectCommand mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDrawIndirectCommand callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VkDrawIndirectCommand.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkDrawIndirectCommand.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static VkDrawIndirectCommand.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDrawIndirectCommand.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

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

Returns a new VkDrawIndirectCommand instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nvertexCount

public static int nvertexCount(long struct)

Unsafe version of vertexCount().

ninstanceCount

public static int ninstanceCount(long struct)

Unsafe version of instanceCount().

nfirstVertex

public static int nfirstVertex(long struct)

Unsafe version of firstVertex().

nfirstInstance

public static int nfirstInstance(long struct)

Unsafe version of firstInstance().

nvertexCount

public static void nvertexCount(long struct,
 int value)

Unsafe version of vertexCount.

ninstanceCount

public static void ninstanceCount(long struct,
 int value)

Unsafe version of instanceCount.

nfirstVertex

public static void nfirstVertex(long struct,
 int value)

Unsafe version of firstVertex.

nfirstInstance

public static void nfirstInstance(long struct,
 int value)

Unsafe version of firstInstance.