Package org.lwjgl.vulkan

Class VkPipelineInputAssemblyStateCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPipelineInputAssemblyStateCreateInfo>

org.lwjgl.vulkan.VkPipelineInputAssemblyStateCreateInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkPipelineInputAssemblyStateCreateInfo
extends Struct<VkPipelineInputAssemblyStateCreateInfo>
implements NativeResource

Structure specifying parameters of a newly created pipeline input assembly state.

Description

Restarting the assembly of primitives discards the most recent index values if those elements formed an incomplete primitive, and restarts the primitive assembly using the subsequent indices, but only assembling the immediately following element through the end of the originally specified elements. The primitive restart index value comparison is performed before adding the vertexOffset value to the index value.

Valid Usage

• If the primitiveTopologyListRestart feature is not enabled, and topology is PRIMITIVE_TOPOLOGY_POINT_LIST, PRIMITIVE_TOPOLOGY_LINE_LIST, PRIMITIVE_TOPOLOGY_TRIANGLE_LIST, PRIMITIVE_TOPOLOGY_LINE_LIST_WITH_ADJACENCY, or PRIMITIVE_TOPOLOGY_TRIANGLE_LIST_WITH_ADJACENCY, primitiveRestartEnable must be FALSE
• If the primitiveTopologyPatchListRestart feature is not enabled, and topology is PRIMITIVE_TOPOLOGY_PATCH_LIST, primitiveRestartEnable must be FALSE
• If the geometryShader feature is not enabled, topology must not be any of PRIMITIVE_TOPOLOGY_LINE_LIST_WITH_ADJACENCY, PRIMITIVE_TOPOLOGY_LINE_STRIP_WITH_ADJACENCY, PRIMITIVE_TOPOLOGY_TRIANGLE_LIST_WITH_ADJACENCY or PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP_WITH_ADJACENCY
• If the tessellationShader feature is not enabled, topology must not be PRIMITIVE_TOPOLOGY_PATCH_LIST
• If the VK_KHR_portability_subset extension is enabled, and VkPhysicalDevicePortabilitySubsetFeaturesKHR::triangleFans is FALSE, topology must not be PRIMITIVE_TOPOLOGY_TRIANGLE_FAN

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_INPUT_ASSEMBLY_STATE_CREATE_INFO
• pNext must be NULL
• flags must be 0
• topology must be a valid VkPrimitiveTopology value

See Also

VkGraphicsPipelineCreateInfo

Layout

 struct VkPipelineInputAssemblyStateCreateInfo {
     VkStructureType sType();
     void const * pNext();
     VkPipelineInputAssemblyStateCreateFlags flags();
     VkPrimitiveTopology topology();
     VkBool32 primitiveRestartEnable();
 }

Nested Class Summary

Nested Classes

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

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

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static VkPipelineInputAssemblyStateCreateInfo	calloc()	Returns a new VkPipelineInputAssemblyStateCreateInfo instance allocated with memCalloc.
static VkPipelineInputAssemblyStateCreateInfo.Buffer	calloc(int capacity)	Returns a new VkPipelineInputAssemblyStateCreateInfo.Buffer instance allocated with memCalloc.
static VkPipelineInputAssemblyStateCreateInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkPipelineInputAssemblyStateCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineInputAssemblyStateCreateInfo	calloc(MemoryStack stack)	Returns a new VkPipelineInputAssemblyStateCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineInputAssemblyStateCreateInfo	callocStack()	Deprecated.
static VkPipelineInputAssemblyStateCreateInfo.Buffer	callocStack(int capacity)	Deprecated.
static VkPipelineInputAssemblyStateCreateInfo.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkPipelineInputAssemblyStateCreateInfo	callocStack(MemoryStack stack)	Deprecated.
static VkPipelineInputAssemblyStateCreateInfo	create()	Returns a new VkPipelineInputAssemblyStateCreateInfo instance allocated with BufferUtils.
static VkPipelineInputAssemblyStateCreateInfo.Buffer	create(int capacity)	Returns a new VkPipelineInputAssemblyStateCreateInfo.Buffer instance allocated with BufferUtils.
static VkPipelineInputAssemblyStateCreateInfo	create(long address)	Returns a new VkPipelineInputAssemblyStateCreateInfo instance for the specified memory address.
static VkPipelineInputAssemblyStateCreateInfo.Buffer	create(long address, int capacity)	Create a VkPipelineInputAssemblyStateCreateInfo.Buffer instance at the specified memory.
static VkPipelineInputAssemblyStateCreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static VkPipelineInputAssemblyStateCreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()	reserved for future use.
VkPipelineInputAssemblyStateCreateInfo	flags(int value)	Sets the specified value to the flags() field.
static VkPipelineInputAssemblyStateCreateInfo	malloc()	Returns a new VkPipelineInputAssemblyStateCreateInfo instance allocated with memAlloc.
static VkPipelineInputAssemblyStateCreateInfo.Buffer	malloc(int capacity)	Returns a new VkPipelineInputAssemblyStateCreateInfo.Buffer instance allocated with memAlloc.
static VkPipelineInputAssemblyStateCreateInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkPipelineInputAssemblyStateCreateInfo.Buffer instance allocated on the specified MemoryStack.
static VkPipelineInputAssemblyStateCreateInfo	malloc(MemoryStack stack)	Returns a new VkPipelineInputAssemblyStateCreateInfo instance allocated on the specified MemoryStack.
static VkPipelineInputAssemblyStateCreateInfo	mallocStack()	Deprecated.
static VkPipelineInputAssemblyStateCreateInfo.Buffer	mallocStack(int capacity)	Deprecated.
static VkPipelineInputAssemblyStateCreateInfo.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkPipelineInputAssemblyStateCreateInfo	mallocStack(MemoryStack stack)	Deprecated.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nprimitiveRestartEnable(long struct)	Unsafe version of primitiveRestartEnable().
static void	nprimitiveRestartEnable(long struct, int value)	Unsafe version of primitiveRestartEnable.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static int	ntopology(long struct)	Unsafe version of topology().
static void	ntopology(long struct, int value)	Unsafe version of topology.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkPipelineInputAssemblyStateCreateInfo	pNext(long value)	Sets the specified value to the pNext() field.
boolean	primitiveRestartEnable()	controls whether a special vertex index value is treated as restarting the assembly of primitives.
VkPipelineInputAssemblyStateCreateInfo	primitiveRestartEnable(boolean value)	Sets the specified value to the primitiveRestartEnable() field.
VkPipelineInputAssemblyStateCreateInfo	set(int sType, long pNext, int flags, int topology, boolean primitiveRestartEnable)	Initializes this struct with the specified values.
VkPipelineInputAssemblyStateCreateInfo	set(VkPipelineInputAssemblyStateCreateInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkPipelineInputAssemblyStateCreateInfo	sType(int value)	Sets the specified value to the sType() field.
VkPipelineInputAssemblyStateCreateInfo	sType$Default()	Sets the STRUCTURE_TYPE_PIPELINE_INPUT_ASSEMBLY_STATE_CREATE_INFO value to the sType() field.
int	topology()	a VkPrimitiveTopology defining the primitive topology, as described below.
VkPipelineInputAssemblyStateCreateInfo	topology(int value)	Sets the specified value to the topology() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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.

FLAGS

public static final int FLAGS

The struct member offsets.

TOPOLOGY

public static final int TOPOLOGY

The struct member offsets.

PRIMITIVERESTARTENABLE

public static final int PRIMITIVERESTARTENABLE

The struct member offsets.

Constructor Details

VkPipelineInputAssemblyStateCreateInfo

public VkPipelineInputAssemblyStateCreateInfo(ByteBuffer container)

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

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkPipelineInputAssemblyStateCreateInfo>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

flags

public int flags()

reserved for future use.

topology

public int topology()

a VkPrimitiveTopology defining the primitive topology, as described below.

primitiveRestartEnable

public boolean primitiveRestartEnable()

controls whether a special vertex index value is treated as restarting the assembly of primitives. This enable only applies to indexed draws (CmdDrawIndexed, CmdDrawMultiIndexedEXT, and CmdDrawIndexedIndirect), and the special index value is either 0xFFFFFFFF when the indexType parameter of vkCmdBindIndexBuffer2KHR or vkCmdBindIndexBuffer is equal to INDEX_TYPE_UINT32, 0xFF when indexType is equal to INDEX_TYPE_UINT8_EXT, or 0xFFFF when indexType is equal to INDEX_TYPE_UINT16. Primitive restart is not allowed for “list” topologies, unless one of the features primitiveTopologyPatchListRestart (for PRIMITIVE_TOPOLOGY_PATCH_LIST) or primitiveTopologyListRestart (for all other list topologies) is enabled.

sType

public VkPipelineInputAssemblyStateCreateInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPipelineInputAssemblyStateCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_INPUT_ASSEMBLY_STATE_CREATE_INFO value to the sType() field.

pNext

public VkPipelineInputAssemblyStateCreateInfo pNext(long value)

Sets the specified value to the pNext() field.

flags

public VkPipelineInputAssemblyStateCreateInfo flags(int value)

Sets the specified value to the flags() field.

topology

public VkPipelineInputAssemblyStateCreateInfo topology(int value)

Sets the specified value to the topology() field.

primitiveRestartEnable

public VkPipelineInputAssemblyStateCreateInfo primitiveRestartEnable(boolean value)

Sets the specified value to the primitiveRestartEnable() field.

set

public VkPipelineInputAssemblyStateCreateInfo set(int sType,
 long pNext,
 int flags,
 int topology,
 boolean primitiveRestartEnable)

Initializes this struct with the specified values.

set

public VkPipelineInputAssemblyStateCreateInfo set(VkPipelineInputAssemblyStateCreateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPipelineInputAssemblyStateCreateInfo malloc()

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

calloc

public static VkPipelineInputAssemblyStateCreateInfo calloc()

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

create

public static VkPipelineInputAssemblyStateCreateInfo create()

Returns a new VkPipelineInputAssemblyStateCreateInfo instance allocated with BufferUtils.

create

public static VkPipelineInputAssemblyStateCreateInfo create(long address)

Returns a new VkPipelineInputAssemblyStateCreateInfo instance for the specified memory address.

createSafe

@Nullable
public static VkPipelineInputAssemblyStateCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPipelineInputAssemblyStateCreateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPipelineInputAssemblyStateCreateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPipelineInputAssemblyStateCreateInfo.Buffer create(int capacity)

Returns a new VkPipelineInputAssemblyStateCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPipelineInputAssemblyStateCreateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkPipelineInputAssemblyStateCreateInfo mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkPipelineInputAssemblyStateCreateInfo callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkPipelineInputAssemblyStateCreateInfo mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkPipelineInputAssemblyStateCreateInfo callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkPipelineInputAssemblyStateCreateInfo.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkPipelineInputAssemblyStateCreateInfo.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkPipelineInputAssemblyStateCreateInfo malloc(MemoryStack stack)

Returns a new VkPipelineInputAssemblyStateCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkPipelineInputAssemblyStateCreateInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkPipelineInputAssemblyStateCreateInfo.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkPipelineInputAssemblyStateCreateInfo.Buffer calloc(int capacity,
 MemoryStack stack)

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

nflags

public static int nflags(long struct)

Unsafe version of flags().

ntopology

public static int ntopology(long struct)

Unsafe version of topology().

nprimitiveRestartEnable

public static int nprimitiveRestartEnable(long struct)

Unsafe version of primitiveRestartEnable().

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.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.

ntopology

public static void ntopology(long struct,
 int value)

Unsafe version of topology.

nprimitiveRestartEnable

public static void nprimitiveRestartEnable(long struct,
 int value)

Unsafe version of primitiveRestartEnable.