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
sTypemust beSTRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFOpNextmust beNULLflagsmust be 0- If
vertexBindingDescriptionCountis not 0,pVertexBindingDescriptionsmust be a pointer to an array ofvertexBindingDescriptionCountvalidVkVertexInputBindingDescriptionstructures - If
vertexAttributeDescriptionCountis not 0,pVertexAttributeDescriptionsmust be a pointer to an array ofvertexAttributeDescriptionCountvalidVkVertexInputAttributeDescriptionstructures vertexBindingDescriptionCountmust be less than or equal toVkPhysicalDeviceLimits::maxVertexInputBindingsvertexAttributeDescriptionCountmust be less than or equal toVkPhysicalDeviceLimits::maxVertexInputAttributes- For every
bindingspecified by any given element ofpVertexAttributeDescriptions, aVkVertexInputBindingDescriptionmust exist inpVertexBindingDescriptionswith the same value ofbinding - All elements of
pVertexBindingDescriptionsmust describe distinct binding numbers - All elements of
pVertexAttributeDescriptionsmust describe distinct attribute locations
Member documentation
sType– the type of this structure. Must be:STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFOpNext– reserved for use by extensionsflags– reserved for future usevertexBindingDescriptionCount– the number of vertex binding descriptions provided inpVertexBindingDescriptionspVertexBindingDescriptions– a pointer to an array ofVkVertexInputBindingDescriptionstructuresvertexAttributeDescriptionCount– the number of vertex attribute descriptions provided inpVertexAttributeDescriptionspVertexAttributeDescriptions– a pointer to an array ofVkVertexInputAttributeDescriptionstructures
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 classVkPipelineVertexInputStateCreateInfo.BufferAn array ofVkPipelineVertexInputStateCreateInfostructs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static intSIZEOFThe 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 aVkPipelineVertexInputStateCreateInfoinstance at the current position of the specifiedByteBuffercontainer.
-
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 aVkPipelineVertexInputStateCreateInfoinstance 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 Detail
-
sizeof
public int sizeof()
Description copied from class:StructReturns thesizeof(struct).
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
flags
public int flags()
Returns the value of theflagsfield.
-
vertexBindingDescriptionCount
public int vertexBindingDescriptionCount()
Returns the value of thevertexBindingDescriptionCountfield.
-
pVertexBindingDescriptions
public VkVertexInputBindingDescription.Buffer pVertexBindingDescriptions()
Returns aVkVertexInputBindingDescription.Bufferview of the struct array pointed to by thepVertexBindingDescriptionsfield.
-
vertexAttributeDescriptionCount
public int vertexAttributeDescriptionCount()
Returns the value of thevertexAttributeDescriptionCountfield.
-
pVertexAttributeDescriptions
public VkVertexInputAttributeDescription.Buffer pVertexAttributeDescriptions()
Returns aVkVertexInputAttributeDescription.Bufferview of the struct array pointed to by thepVertexAttributeDescriptionsfield.
-
sType
public VkPipelineVertexInputStateCreateInfo sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkPipelineVertexInputStateCreateInfo pNext(long value)
Sets the specified value to thepNextfield.
-
flags
public VkPipelineVertexInputStateCreateInfo flags(int value)
Sets the specified value to theflagsfield.
-
pVertexBindingDescriptions
public VkPipelineVertexInputStateCreateInfo pVertexBindingDescriptions(VkVertexInputBindingDescription.Buffer value)
Sets the address of the specifiedVkVertexInputBindingDescription.Bufferto thepVertexBindingDescriptionsfield.
-
pVertexAttributeDescriptions
public VkPipelineVertexInputStateCreateInfo pVertexAttributeDescriptions(VkVertexInputAttributeDescription.Buffer value)
Sets the address of the specifiedVkVertexInputAttributeDescription.Bufferto thepVertexAttributeDescriptionsfield.
-
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 newVkPipelineVertexInputStateCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkPipelineVertexInputStateCreateInfo calloc()
Returns a newVkPipelineVertexInputStateCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkPipelineVertexInputStateCreateInfo create()
Returns a newVkPipelineVertexInputStateCreateInfoinstance allocated withBufferUtils.
-
create
public static VkPipelineVertexInputStateCreateInfo create(long address)
Returns a newVkPipelineVertexInputStateCreateInfoinstance for the specified memory address ornullif the address isNULL.
-
malloc
public static VkPipelineVertexInputStateCreateInfo.Buffer malloc(int capacity)
Returns a newVkPipelineVertexInputStateCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkPipelineVertexInputStateCreateInfo.Buffer calloc(int capacity)
Returns a newVkPipelineVertexInputStateCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkPipelineVertexInputStateCreateInfo.Buffer create(int capacity)
Returns a newVkPipelineVertexInputStateCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkPipelineVertexInputStateCreateInfo.Buffer create(long address, int capacity)
Create aVkPipelineVertexInputStateCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
mallocStack
public static VkPipelineVertexInputStateCreateInfo mallocStack()
Returns a newVkPipelineVertexInputStateCreateInfoinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkPipelineVertexInputStateCreateInfo callocStack()
Returns a newVkPipelineVertexInputStateCreateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkPipelineVertexInputStateCreateInfo mallocStack(MemoryStack stack)
Returns a newVkPipelineVertexInputStateCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkPipelineVertexInputStateCreateInfo callocStack(MemoryStack stack)
Returns a newVkPipelineVertexInputStateCreateInfoinstance allocated on the specifiedMemoryStackand 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.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkPipelineVertexInputStateCreateInfo.Buffer callocStack(int capacity)
Returns a newVkPipelineVertexInputStateCreateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkPipelineVertexInputStateCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkPipelineVertexInputStateCreateInfo.Bufferinstance 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.Bufferinstance allocated on the specifiedMemoryStackand 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
-
-