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,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkPipelineInputAssemblyStateCreateInfo
extends org.lwjgl.system.Struct<VkPipelineInputAssemblyStateCreateInfo>
implements org.lwjgl.system.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
primitiveTopologyListRestartfeature is not enabled, andtopologyisPRIMITIVE_TOPOLOGY_POINT_LIST,PRIMITIVE_TOPOLOGY_LINE_LIST,PRIMITIVE_TOPOLOGY_TRIANGLE_LIST,PRIMITIVE_TOPOLOGY_LINE_LIST_WITH_ADJACENCY, orPRIMITIVE_TOPOLOGY_TRIANGLE_LIST_WITH_ADJACENCY,primitiveRestartEnablemust beFALSE - If the
primitiveTopologyPatchListRestartfeature is not enabled, andtopologyisPRIMITIVE_TOPOLOGY_PATCH_LIST,primitiveRestartEnablemust beFALSE - If the
geometryShaderfeature is not enabled,topologymust not be any ofPRIMITIVE_TOPOLOGY_LINE_LIST_WITH_ADJACENCY,PRIMITIVE_TOPOLOGY_LINE_STRIP_WITH_ADJACENCY,PRIMITIVE_TOPOLOGY_TRIANGLE_LIST_WITH_ADJACENCYorPRIMITIVE_TOPOLOGY_TRIANGLE_STRIP_WITH_ADJACENCY - If the
tessellationShaderfeature is not enabled,topologymust not bePRIMITIVE_TOPOLOGY_PATCH_LIST - If the
VK_KHR_portability_subsetextension is enabled, andVkPhysicalDevicePortabilitySubsetFeaturesKHR::triangleFansisFALSE,topologymust not bePRIMITIVE_TOPOLOGY_TRIANGLE_FAN
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_PIPELINE_INPUT_ASSEMBLY_STATE_CREATE_INFOpNextmust beNULLflagsmust be 0topologymust be a validVkPrimitiveTopologyvalue
See Also
Layout
struct VkPipelineInputAssemblyStateCreateInfo {
VkStructureType sType();
void const * pNext();
VkPipelineInputAssemblyStateCreateFlags flags();
VkPrimitiveTopology topology();
VkBool32 primitiveRestartEnable();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkPipelineInputAssemblyStateCreateInfostructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkPipelineInputAssemblyStateCreateInfo(ByteBuffer container) Creates aVkPipelineInputAssemblyStateCreateInfoinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkPipelineInputAssemblyStateCreateInfoinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkPipelineInputAssemblyStateCreateInfo.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineInputAssemblyStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineInputAssemblyStateCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.Deprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.create()Returns a newVkPipelineInputAssemblyStateCreateInfoinstance allocated withBufferUtils.create(int capacity) Returns a newVkPipelineInputAssemblyStateCreateInfo.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkPipelineInputAssemblyStateCreateInfoinstance for the specified memory address.create(long address, int capacity) Create aVkPipelineInputAssemblyStateCreateInfo.Bufferinstance at the specified memory.static @Nullable VkPipelineInputAssemblyStateCreateInfocreateSafe(long address) static @Nullable VkPipelineInputAssemblyStateCreateInfo.BuffercreateSafe(long address, int capacity) intflags()reserved for future use.flags(int value) Sets the specified value to theflags()field.malloc()Returns a newVkPipelineInputAssemblyStateCreateInfoinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkPipelineInputAssemblyStateCreateInfo.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineInputAssemblyStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineInputAssemblyStateCreateInfoinstance allocated on the specifiedMemoryStack.Deprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static intnflags(long struct) Unsafe version offlags().static voidnflags(long struct, int value) Unsafe version offlags.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnprimitiveRestartEnable(long struct) Unsafe version ofprimitiveRestartEnable().static voidnprimitiveRestartEnable(long struct, int value) Unsafe version ofprimitiveRestartEnable.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.static intntopology(long struct) Unsafe version oftopology().static voidntopology(long struct, int value) Unsafe version oftopology.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.booleancontrols whether a special vertex index value is treated as restarting the assembly of primitives.primitiveRestartEnable(boolean value) Sets the specified value to theprimitiveRestartEnable()field.set(int sType, long pNext, int flags, int topology, boolean primitiveRestartEnable) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_PIPELINE_INPUT_ASSEMBLY_STATE_CREATE_INFOvalue to thesType()field.inttopology()aVkPrimitiveTopologydefining the primitive topology, as described below.topology(int value) Sets the specified value to thetopology()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
FLAGS
public static final int FLAGSThe struct member offsets. -
TOPOLOGY
public static final int TOPOLOGYThe struct member offsets. -
PRIMITIVERESTARTENABLE
public static final int PRIMITIVERESTARTENABLEThe struct member offsets.
-
-
Constructor Details
-
VkPipelineInputAssemblyStateCreateInfo
Creates aVkPipelineInputAssemblyStateCreateInfoinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct<VkPipelineInputAssemblyStateCreateInfo>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
flags
public int flags()reserved for future use. -
topology
public int topology()aVkPrimitiveTopologydefining 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, andCmdDrawIndexedIndirect), and the special index value is either 0xFFFFFFFF when theindexTypeparameter ofvkCmdBindIndexBuffer2orvkCmdBindIndexBufferis equal toINDEX_TYPE_UINT32; 0xFF whenindexTypeis equal toINDEX_TYPE_UINT8; or 0xFFFF whenindexTypeis equal toINDEX_TYPE_UINT16. Primitive restart is not allowed for “list” topologies, unless one of the featuresprimitiveTopologyPatchListRestart(forPRIMITIVE_TOPOLOGY_PATCH_LIST) orprimitiveTopologyListRestart(for all other list topologies) is enabled. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_PIPELINE_INPUT_ASSEMBLY_STATE_CREATE_INFOvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
flags
Sets the specified value to theflags()field. -
topology
Sets the specified value to thetopology()field. -
primitiveRestartEnable
Sets the specified value to theprimitiveRestartEnable()field. -
set
public VkPipelineInputAssemblyStateCreateInfo set(int sType, long pNext, int flags, int topology, boolean primitiveRestartEnable) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkPipelineInputAssemblyStateCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkPipelineInputAssemblyStateCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkPipelineInputAssemblyStateCreateInfoinstance allocated withBufferUtils. -
create
Returns a newVkPipelineInputAssemblyStateCreateInfoinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkPipelineInputAssemblyStateCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkPipelineInputAssemblyStateCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkPipelineInputAssemblyStateCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkPipelineInputAssemblyStateCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkPipelineInputAssemblyStateCreateInfo.Buffer createSafe(long address, int capacity) -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
@Deprecated public static VkPipelineInputAssemblyStateCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
@Deprecated public static VkPipelineInputAssemblyStateCreateInfo callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkPipelineInputAssemblyStateCreateInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkPipelineInputAssemblyStateCreateInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkPipelineInputAssemblyStateCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkPipelineInputAssemblyStateCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkPipelineInputAssemblyStateCreateInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineInputAssemblyStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkPipelineInputAssemblyStateCreateInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineInputAssemblyStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
nflags
public static int nflags(long struct) Unsafe version offlags(). -
ntopology
public static int ntopology(long struct) Unsafe version oftopology(). -
nprimitiveRestartEnable
public static int nprimitiveRestartEnable(long struct) Unsafe version ofprimitiveRestartEnable(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nflags
public static void nflags(long struct, int value) Unsafe version offlags. -
ntopology
public static void ntopology(long struct, int value) Unsafe version oftopology. -
nprimitiveRestartEnable
public static void nprimitiveRestartEnable(long struct, int value) Unsafe version ofprimitiveRestartEnable.
-