Package org.lwjgl.vulkan
Class VkPipelineVertexInputStateCreateInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkPipelineVertexInputStateCreateInfo
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkPipelineVertexInputStateCreateInfo extends Struct
Khronos Reference Page
Vulkan SpecificationContains vertex input attribute and vertex input binding descriptions as part of graphics pipeline creation.
Valid Usage
sType
must beSTRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO
pNext
must beNULL
flags
must be 0- If
vertexBindingDescriptionCount
is not 0,pVertexBindingDescriptions
must be a pointer to an array ofvertexBindingDescriptionCount
validVkVertexInputBindingDescription
structures - If
vertexAttributeDescriptionCount
is not 0,pVertexAttributeDescriptions
must be a pointer to an array ofvertexAttributeDescriptionCount
validVkVertexInputAttributeDescription
structures vertexBindingDescriptionCount
must be less than or equal toVkPhysicalDeviceLimits
::maxVertexInputBindings
vertexAttributeDescriptionCount
must be less than or equal toVkPhysicalDeviceLimits
::maxVertexInputAttributes
- For every
binding
specified by any given element ofpVertexAttributeDescriptions
, aVkVertexInputBindingDescription
must exist inpVertexBindingDescriptions
with the same value ofbinding
- All elements of
pVertexBindingDescriptions
must describe distinct binding numbers - All elements of
pVertexAttributeDescriptions
must describe distinct attribute locations
Member documentation
sType
– the type of this structure. Must be:STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO
pNext
– reserved for use by extensionsflags
– reserved for future usevertexBindingDescriptionCount
– the number of vertex binding descriptions provided inpVertexBindingDescriptions
pVertexBindingDescriptions
– a pointer to an array ofVkVertexInputBindingDescription
structuresvertexAttributeDescriptionCount
– the number of vertex attribute descriptions provided inpVertexAttributeDescriptions
pVertexAttributeDescriptions
– a pointer to an array ofVkVertexInputAttributeDescription
structures
Layout
struct VkPipelineVertexInputStateCreateInfo { VkStructureType sType; const void * pNext; VkPipelineVertexInputStateCreateFlags flags; uint32_t vertexBindingDescriptionCount; const VkVertexInputBindingDescription * pVertexBindingDescriptions; uint32_t vertexAttributeDescriptionCount; const VkVertexInputAttributeDescription * pVertexAttributeDescriptions; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkPipelineVertexInputStateCreateInfo.Buffer
An array ofVkPipelineVertexInputStateCreateInfo
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkPipelineVertexInputStateCreateInfo(java.nio.ByteBuffer container)
Creates aVkPipelineVertexInputStateCreateInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkPipelineVertexInputStateCreateInfo
public VkPipelineVertexInputStateCreateInfo(java.nio.ByteBuffer container)
Creates aVkPipelineVertexInputStateCreateInfo
instance at the current position of the specifiedByteBuffer
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
-
sizeof
public int sizeof()
Description copied from class:Struct
Returns thesizeof(struct)
.
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
flags
public int flags()
Returns the value of theflags
field.
-
vertexBindingDescriptionCount
public int vertexBindingDescriptionCount()
Returns the value of thevertexBindingDescriptionCount
field.
-
pVertexBindingDescriptions
public VkVertexInputBindingDescription.Buffer pVertexBindingDescriptions()
Returns aVkVertexInputBindingDescription.Buffer
view of the struct array pointed to by thepVertexBindingDescriptions
field.
-
vertexAttributeDescriptionCount
public int vertexAttributeDescriptionCount()
Returns the value of thevertexAttributeDescriptionCount
field.
-
pVertexAttributeDescriptions
public VkVertexInputAttributeDescription.Buffer pVertexAttributeDescriptions()
Returns aVkVertexInputAttributeDescription.Buffer
view of the struct array pointed to by thepVertexAttributeDescriptions
field.
-
sType
public VkPipelineVertexInputStateCreateInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkPipelineVertexInputStateCreateInfo pNext(long value)
Sets the specified value to thepNext
field.
-
flags
public VkPipelineVertexInputStateCreateInfo flags(int value)
Sets the specified value to theflags
field.
-
pVertexBindingDescriptions
public VkPipelineVertexInputStateCreateInfo pVertexBindingDescriptions(VkVertexInputBindingDescription.Buffer value)
Sets the address of the specifiedVkVertexInputBindingDescription.Buffer
to thepVertexBindingDescriptions
field.
-
pVertexAttributeDescriptions
public VkPipelineVertexInputStateCreateInfo pVertexAttributeDescriptions(VkVertexInputAttributeDescription.Buffer value)
Sets the address of the specifiedVkVertexInputAttributeDescription.Buffer
to thepVertexAttributeDescriptions
field.
-
set
public VkPipelineVertexInputStateCreateInfo set(int sType, long pNext, int flags, VkVertexInputBindingDescription.Buffer pVertexBindingDescriptions, VkVertexInputAttributeDescription.Buffer pVertexAttributeDescriptions)
Initializes this struct with the specified values.
-
nset
public VkPipelineVertexInputStateCreateInfo nset(long struct)
Unsafe version ofset
.
-
set
public VkPipelineVertexInputStateCreateInfo set(VkPipelineVertexInputStateCreateInfo src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkPipelineVertexInputStateCreateInfo malloc()
Returns a newVkPipelineVertexInputStateCreateInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkPipelineVertexInputStateCreateInfo calloc()
Returns a newVkPipelineVertexInputStateCreateInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkPipelineVertexInputStateCreateInfo create()
Returns a newVkPipelineVertexInputStateCreateInfo
instance allocated withBufferUtils
.
-
create
public static VkPipelineVertexInputStateCreateInfo create(long address)
Returns a newVkPipelineVertexInputStateCreateInfo
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkPipelineVertexInputStateCreateInfo.Buffer malloc(int capacity)
Returns a newVkPipelineVertexInputStateCreateInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkPipelineVertexInputStateCreateInfo.Buffer calloc(int capacity)
Returns a newVkPipelineVertexInputStateCreateInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPipelineVertexInputStateCreateInfo.Buffer create(int capacity)
Returns a newVkPipelineVertexInputStateCreateInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPipelineVertexInputStateCreateInfo.Buffer create(long address, int capacity)
Create aVkPipelineVertexInputStateCreateInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkPipelineVertexInputStateCreateInfo mallocStack()
Returns a newVkPipelineVertexInputStateCreateInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkPipelineVertexInputStateCreateInfo callocStack()
Returns a newVkPipelineVertexInputStateCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkPipelineVertexInputStateCreateInfo mallocStack(MemoryStack stack)
Returns a newVkPipelineVertexInputStateCreateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkPipelineVertexInputStateCreateInfo callocStack(MemoryStack stack)
Returns a newVkPipelineVertexInputStateCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkPipelineVertexInputStateCreateInfo.Buffer mallocStack(int capacity)
Returns a newVkPipelineVertexInputStateCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkPipelineVertexInputStateCreateInfo.Buffer callocStack(int capacity)
Returns a newVkPipelineVertexInputStateCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkPipelineVertexInputStateCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkPipelineVertexInputStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkPipelineVertexInputStateCreateInfo.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkPipelineVertexInputStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL
.- Parameters:
struct
- the struct to validate
-
validate
public static void validate(long array, int count)
CallsVkPipelineVertexInputStateCreateInfo.validate(long)
for each struct contained in the specified struct array.- Parameters:
array
- the struct array to validatecount
- the number of structs inarray
-
-