Package org.lwjgl.vulkan

Class VkGeneratedCommandsMemoryRequirementsInfoNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkGeneratedCommandsMemoryRequirementsInfoNV>

org.lwjgl.vulkan.VkGeneratedCommandsMemoryRequirementsInfoNV

All Implemented Interfaces:

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

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

Structure specifying parameters for the reservation of preprocess buffer space.

Valid Usage

• maxSequencesCount must be less or equal to VkPhysicalDeviceDeviceGeneratedCommandsPropertiesNV::maxIndirectSequenceCount
• If pipelineBindPoint is of type PIPELINE_BIND_POINT_GRAPHICS, then pipeline must be a valid VkPipeline handle
• If pipelineBindPoint is of type PIPELINE_BIND_POINT_COMPUTE, and the indirectCommandsLayout was not created with a INDIRECT_COMMANDS_TOKEN_TYPE_PIPELINE_NV token, then the pipeline must be a valid VkPipeline handle
• If pipelineBindPoint is of type PIPELINE_BIND_POINT_COMPUTE, and the indirectCommandsLayout contains a INDIRECT_COMMANDS_TOKEN_TYPE_PIPELINE_NV token, then the pipeline must be NULL_HANDLE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_GENERATED_COMMANDS_MEMORY_REQUIREMENTS_INFO_NV
• pNext must be NULL
• pipelineBindPoint must be a valid VkPipelineBindPoint value
• If pipeline is not NULL_HANDLE, pipeline must be a valid VkPipeline handle
• indirectCommandsLayout must be a valid VkIndirectCommandsLayoutNV handle
• Both of indirectCommandsLayout, and pipeline that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same VkDevice

See Also

GetGeneratedCommandsMemoryRequirementsNV

Layout

 struct VkGeneratedCommandsMemoryRequirementsInfoNV {
     VkStructureType sType();
     void const * pNext();
     VkPipelineBindPoint pipelineBindPoint();
     VkPipeline pipeline();
     VkIndirectCommandsLayoutNV indirectCommandsLayout();
     uint32_t maxSequencesCount();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkGeneratedCommandsMemoryRequirementsInfoNV.Buffer	An array of VkGeneratedCommandsMemoryRequirementsInfoNV 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	INDIRECTCOMMANDSLAYOUT	The struct member offsets.
static final int	MAXSEQUENCESCOUNT	The struct member offsets.
static final int	PIPELINE	The struct member offsets.
static final int	PIPELINEBINDPOINT	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	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
VkGeneratedCommandsMemoryRequirementsInfoNV(ByteBuffer container)	Creates a VkGeneratedCommandsMemoryRequirementsInfoNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkGeneratedCommandsMemoryRequirementsInfoNV	calloc()	Returns a new VkGeneratedCommandsMemoryRequirementsInfoNV instance allocated with memCalloc.
static VkGeneratedCommandsMemoryRequirementsInfoNV.Buffer	calloc(int capacity)	Returns a new VkGeneratedCommandsMemoryRequirementsInfoNV.Buffer instance allocated with memCalloc.
static VkGeneratedCommandsMemoryRequirementsInfoNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkGeneratedCommandsMemoryRequirementsInfoNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkGeneratedCommandsMemoryRequirementsInfoNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkGeneratedCommandsMemoryRequirementsInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkGeneratedCommandsMemoryRequirementsInfoNV	create()	Returns a new VkGeneratedCommandsMemoryRequirementsInfoNV instance allocated with BufferUtils.
static VkGeneratedCommandsMemoryRequirementsInfoNV.Buffer	create(int capacity)	Returns a new VkGeneratedCommandsMemoryRequirementsInfoNV.Buffer instance allocated with BufferUtils.
static VkGeneratedCommandsMemoryRequirementsInfoNV	create(long address)	Returns a new VkGeneratedCommandsMemoryRequirementsInfoNV instance for the specified memory address.
static VkGeneratedCommandsMemoryRequirementsInfoNV.Buffer	create(long address, int capacity)	Create a VkGeneratedCommandsMemoryRequirementsInfoNV.Buffer instance at the specified memory.
static @Nullable VkGeneratedCommandsMemoryRequirementsInfoNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkGeneratedCommandsMemoryRequirementsInfoNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	indirectCommandsLayout()	the VkIndirectCommandsLayoutNV that this buffer memory is intended to be used with.
VkGeneratedCommandsMemoryRequirementsInfoNV	indirectCommandsLayout(long value)	Sets the specified value to the indirectCommandsLayout() field.
static VkGeneratedCommandsMemoryRequirementsInfoNV	malloc()	Returns a new VkGeneratedCommandsMemoryRequirementsInfoNV instance allocated with memAlloc.
static VkGeneratedCommandsMemoryRequirementsInfoNV.Buffer	malloc(int capacity)	Returns a new VkGeneratedCommandsMemoryRequirementsInfoNV.Buffer instance allocated with memAlloc.
static VkGeneratedCommandsMemoryRequirementsInfoNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkGeneratedCommandsMemoryRequirementsInfoNV.Buffer instance allocated on the specified MemoryStack.
static VkGeneratedCommandsMemoryRequirementsInfoNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkGeneratedCommandsMemoryRequirementsInfoNV instance allocated on the specified MemoryStack.
int	maxSequencesCount()	the maximum number of sequences that this buffer memory in combination with the other state provided can be used with.
VkGeneratedCommandsMemoryRequirementsInfoNV	maxSequencesCount(int value)	Sets the specified value to the maxSequencesCount() field.
static long	nindirectCommandsLayout(long struct)	Unsafe version of indirectCommandsLayout().
static void	nindirectCommandsLayout(long struct, long value)	Unsafe version of indirectCommandsLayout.
static int	nmaxSequencesCount(long struct)	Unsafe version of maxSequencesCount().
static void	nmaxSequencesCount(long struct, int value)	Unsafe version of maxSequencesCount.
static long	npipeline(long struct)	Unsafe version of pipeline().
static void	npipeline(long struct, long value)	Unsafe version of pipeline.
static int	npipelineBindPoint(long struct)	Unsafe version of pipelineBindPoint().
static void	npipelineBindPoint(long struct, int value)	Unsafe version of pipelineBindPoint.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pipeline()	the VkPipeline that this buffer memory is intended to be used with during the execution.
VkGeneratedCommandsMemoryRequirementsInfoNV	pipeline(long value)	Sets the specified value to the pipeline() field.
int	pipelineBindPoint()	the VkPipelineBindPoint of the pipeline that this buffer memory is intended to be used with during the execution.
VkGeneratedCommandsMemoryRequirementsInfoNV	pipelineBindPoint(int value)	Sets the specified value to the pipelineBindPoint() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkGeneratedCommandsMemoryRequirementsInfoNV	pNext(long value)	Sets the specified value to the pNext() field.
VkGeneratedCommandsMemoryRequirementsInfoNV	set(int sType, long pNext, int pipelineBindPoint, long pipeline, long indirectCommandsLayout, int maxSequencesCount)	Initializes this struct with the specified values.
VkGeneratedCommandsMemoryRequirementsInfoNV	set(VkGeneratedCommandsMemoryRequirementsInfoNV src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkGeneratedCommandsMemoryRequirementsInfoNV	sType(int value)	Sets the specified value to the sType() field.
VkGeneratedCommandsMemoryRequirementsInfoNV	sType$Default()	Sets the STRUCTURE_TYPE_GENERATED_COMMANDS_MEMORY_REQUIREMENTS_INFO_NV value to the sType() 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.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

PIPELINEBINDPOINT

public static final int PIPELINEBINDPOINT

The struct member offsets.

PIPELINE

public static final int PIPELINE

The struct member offsets.

INDIRECTCOMMANDSLAYOUT

public static final int INDIRECTCOMMANDSLAYOUT

The struct member offsets.

MAXSEQUENCESCOUNT

public static final int MAXSEQUENCESCOUNT

The struct member offsets.

Constructor Details

VkGeneratedCommandsMemoryRequirementsInfoNV

public VkGeneratedCommandsMemoryRequirementsInfoNV(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

pipelineBindPoint

public int pipelineBindPoint()

the VkPipelineBindPoint of the pipeline that this buffer memory is intended to be used with during the execution.

pipeline

public long pipeline()

the VkPipeline that this buffer memory is intended to be used with during the execution.

indirectCommandsLayout

public long indirectCommandsLayout()

the VkIndirectCommandsLayoutNV that this buffer memory is intended to be used with.

maxSequencesCount

public int maxSequencesCount()

the maximum number of sequences that this buffer memory in combination with the other state provided can be used with.

sType

public VkGeneratedCommandsMemoryRequirementsInfoNV sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkGeneratedCommandsMemoryRequirementsInfoNV sType$Default()

Sets the STRUCTURE_TYPE_GENERATED_COMMANDS_MEMORY_REQUIREMENTS_INFO_NV value to the sType() field.

pNext

public VkGeneratedCommandsMemoryRequirementsInfoNV pNext(long value)

Sets the specified value to the pNext() field.

pipelineBindPoint

public VkGeneratedCommandsMemoryRequirementsInfoNV pipelineBindPoint(int value)

Sets the specified value to the pipelineBindPoint() field.

pipeline

public VkGeneratedCommandsMemoryRequirementsInfoNV pipeline(long value)

Sets the specified value to the pipeline() field.

indirectCommandsLayout

public VkGeneratedCommandsMemoryRequirementsInfoNV indirectCommandsLayout(long value)

Sets the specified value to the indirectCommandsLayout() field.

maxSequencesCount

public VkGeneratedCommandsMemoryRequirementsInfoNV maxSequencesCount(int value)

Sets the specified value to the maxSequencesCount() field.

set

public VkGeneratedCommandsMemoryRequirementsInfoNV set(int sType,
 long pNext,
 int pipelineBindPoint,
 long pipeline,
 long indirectCommandsLayout,
 int maxSequencesCount)

Initializes this struct with the specified values.

set

public VkGeneratedCommandsMemoryRequirementsInfoNV set(VkGeneratedCommandsMemoryRequirementsInfoNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkGeneratedCommandsMemoryRequirementsInfoNV malloc()

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

calloc

public static VkGeneratedCommandsMemoryRequirementsInfoNV calloc()

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

create

public static VkGeneratedCommandsMemoryRequirementsInfoNV create()

Returns a new VkGeneratedCommandsMemoryRequirementsInfoNV instance allocated with BufferUtils.

create

public static VkGeneratedCommandsMemoryRequirementsInfoNV create(long address)

Returns a new VkGeneratedCommandsMemoryRequirementsInfoNV instance for the specified memory address.

createSafe

public static @Nullable VkGeneratedCommandsMemoryRequirementsInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkGeneratedCommandsMemoryRequirementsInfoNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkGeneratedCommandsMemoryRequirementsInfoNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkGeneratedCommandsMemoryRequirementsInfoNV.Buffer create(int capacity)

Returns a new VkGeneratedCommandsMemoryRequirementsInfoNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkGeneratedCommandsMemoryRequirementsInfoNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkGeneratedCommandsMemoryRequirementsInfoNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

npipelineBindPoint

public static int npipelineBindPoint(long struct)

Unsafe version of pipelineBindPoint().

npipeline

public static long npipeline(long struct)

Unsafe version of pipeline().

nindirectCommandsLayout

public static long nindirectCommandsLayout(long struct)

Unsafe version of indirectCommandsLayout().

nmaxSequencesCount

public static int nmaxSequencesCount(long struct)

Unsafe version of maxSequencesCount().

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.

npipelineBindPoint

public static void npipelineBindPoint(long struct,
 int value)

Unsafe version of pipelineBindPoint.

npipeline

public static void npipeline(long struct,
 long value)

Unsafe version of pipeline.

nindirectCommandsLayout

public static void nindirectCommandsLayout(long struct,
 long value)

Unsafe version of indirectCommandsLayout.

nmaxSequencesCount

public static void nmaxSequencesCount(long struct,
 int value)

Unsafe version of maxSequencesCount.