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,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkPipelineVertexInputStateCreateInfo extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying parameters of a newly created pipeline vertex input state.Valid Usage
vertexBindingDescriptionCountmust be less than or equal toVkPhysicalDeviceLimits::maxVertexInputBindingsvertexAttributeDescriptionCountmust be less than or equal toVkPhysicalDeviceLimits::maxVertexInputAttributes- For every
bindingspecified by each 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
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFOpNextmust beNULLor a pointer to a valid instance ofVkPipelineVertexInputDivisorStateCreateInfoEXTflagsmust be 0- If
vertexBindingDescriptionCountis not 0,pVertexBindingDescriptionsmust be a valid pointer to an array ofvertexBindingDescriptionCountvalidVkVertexInputBindingDescriptionstructures - If
vertexAttributeDescriptionCountis not 0,pVertexAttributeDescriptionsmust be a valid pointer to an array ofvertexAttributeDescriptionCountvalidVkVertexInputAttributeDescriptionstructures
See Also
VkGraphicsPipelineCreateInfo,VkVertexInputAttributeDescription,VkVertexInputBindingDescriptionMember documentation
sType– the type of this structure.pNext–NULLor a pointer to an extension-specific structure.flags– reserved for future use.vertexBindingDescriptionCount– the number of vertex binding descriptions provided inpVertexBindingDescriptions.pVertexBindingDescriptions– a pointer to an array ofVkVertexInputBindingDescriptionstructures.vertexAttributeDescriptionCount– the number of vertex attribute descriptions provided inpVertexAttributeDescriptions.pVertexAttributeDescriptions– a pointer to an array ofVkVertexInputAttributeDescriptionstructures.
Layout
struct VkPipelineVertexInputStateCreateInfo { VkStructureType sType; void const * pNext; VkPipelineVertexInputStateCreateFlags flags; uint32_t vertexBindingDescriptionCount;VkVertexInputBindingDescriptionconst * pVertexBindingDescriptions; uint32_t vertexAttributeDescriptionCount;VkVertexInputAttributeDescriptionconst * pVertexAttributeDescriptions; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkPipelineVertexInputStateCreateInfo.BufferAn array ofVkPipelineVertexInputStateCreateInfostructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intFLAGS
PNEXT
PVERTEXATTRIBUTEDESCRIPTIONS
PVERTEXBINDINGDESCRIPTIONSThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPE
VERTEXATTRIBUTEDESCRIPTIONCOUNT
VERTEXBINDINGDESCRIPTIONCOUNTThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkPipelineVertexInputStateCreateInfo(java.nio.ByteBuffer container)Creates aVkPipelineVertexInputStateCreateInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkPipelineVertexInputStateCreateInfocalloc()Returns a newVkPipelineVertexInputStateCreateInfoinstance allocated withmemCalloc.static VkPipelineVertexInputStateCreateInfo.Buffercalloc(int capacity)Returns a newVkPipelineVertexInputStateCreateInfo.Bufferinstance allocated withmemCalloc.static VkPipelineVertexInputStateCreateInfocallocStack()Returns a newVkPipelineVertexInputStateCreateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkPipelineVertexInputStateCreateInfo.BuffercallocStack(int capacity)Returns a newVkPipelineVertexInputStateCreateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkPipelineVertexInputStateCreateInfo.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineVertexInputStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPipelineVertexInputStateCreateInfocallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineVertexInputStateCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPipelineVertexInputStateCreateInfocreate()Returns a newVkPipelineVertexInputStateCreateInfoinstance allocated withBufferUtils.static VkPipelineVertexInputStateCreateInfo.Buffercreate(int capacity)Returns a newVkPipelineVertexInputStateCreateInfo.Bufferinstance allocated withBufferUtils.static VkPipelineVertexInputStateCreateInfocreate(long address)Returns a newVkPipelineVertexInputStateCreateInfoinstance for the specified memory address.static VkPipelineVertexInputStateCreateInfo.Buffercreate(long address, int capacity)Create aVkPipelineVertexInputStateCreateInfo.Bufferinstance at the specified memory.static VkPipelineVertexInputStateCreateInfocreateSafe(long address)static VkPipelineVertexInputStateCreateInfo.BuffercreateSafe(long address, int capacity)intflags()Returns the value of theflagsfield.VkPipelineVertexInputStateCreateInfoflags(int value)Sets the specified value to theflagsfield.static VkPipelineVertexInputStateCreateInfomalloc()Returns a newVkPipelineVertexInputStateCreateInfoinstance allocated withmemAlloc.static VkPipelineVertexInputStateCreateInfo.Buffermalloc(int capacity)Returns a newVkPipelineVertexInputStateCreateInfo.Bufferinstance allocated withmemAlloc.static VkPipelineVertexInputStateCreateInfomallocStack()Returns a newVkPipelineVertexInputStateCreateInfoinstance allocated on the thread-localMemoryStack.static VkPipelineVertexInputStateCreateInfo.BuffermallocStack(int capacity)Returns a newVkPipelineVertexInputStateCreateInfo.Bufferinstance allocated on the thread-localMemoryStack.static VkPipelineVertexInputStateCreateInfo.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineVertexInputStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkPipelineVertexInputStateCreateInfomallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineVertexInputStateCreateInfoinstance allocated on the specifiedMemoryStack.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 VkVertexInputAttributeDescription.BuffernpVertexAttributeDescriptions(long struct)Unsafe version ofpVertexAttributeDescriptions().static voidnpVertexAttributeDescriptions(long struct, VkVertexInputAttributeDescription.Buffer value)Unsafe version ofpVertexAttributeDescriptions.static VkVertexInputBindingDescription.BuffernpVertexBindingDescriptions(long struct)Unsafe version ofpVertexBindingDescriptions().static voidnpVertexBindingDescriptions(long struct, VkVertexInputBindingDescription.Buffer value)Unsafe version ofpVertexBindingDescriptions.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.static intnvertexAttributeDescriptionCount(long struct)Unsafe version ofvertexAttributeDescriptionCount().static voidnvertexAttributeDescriptionCount(long struct, int value)Sets the specified value to thevertexAttributeDescriptionCountfield of the specifiedstruct.static intnvertexBindingDescriptionCount(long struct)Unsafe version ofvertexBindingDescriptionCount().static voidnvertexBindingDescriptionCount(long struct, int value)Sets the specified value to thevertexBindingDescriptionCountfield of the specifiedstruct.longpNext()Returns the value of thepNextfield.VkPipelineVertexInputStateCreateInfopNext(long value)Sets the specified value to thepNextfield.VkVertexInputAttributeDescription.BufferpVertexAttributeDescriptions()Returns aVkVertexInputAttributeDescription.Bufferview of the struct array pointed to by thepVertexAttributeDescriptionsfield.VkPipelineVertexInputStateCreateInfopVertexAttributeDescriptions(VkVertexInputAttributeDescription.Buffer value)Sets the address of the specifiedVkVertexInputAttributeDescription.Bufferto thepVertexAttributeDescriptionsfield.VkVertexInputBindingDescription.BufferpVertexBindingDescriptions()Returns aVkVertexInputBindingDescription.Bufferview of the struct array pointed to by thepVertexBindingDescriptionsfield.VkPipelineVertexInputStateCreateInfopVertexBindingDescriptions(VkVertexInputBindingDescription.Buffer value)Sets the address of the specifiedVkVertexInputBindingDescription.Bufferto thepVertexBindingDescriptionsfield.VkPipelineVertexInputStateCreateInfoset(int sType, long pNext, int flags, VkVertexInputBindingDescription.Buffer pVertexBindingDescriptions, VkVertexInputAttributeDescription.Buffer pVertexAttributeDescriptions)Initializes this struct with the specified values.VkPipelineVertexInputStateCreateInfoset(VkPipelineVertexInputStateCreateInfo src)Copies the specified struct data to this struct.intsizeof()intsType()Returns the value of thesTypefield.VkPipelineVertexInputStateCreateInfosType(int value)Sets the specified value to thesTypefield.static voidvalidate(long struct)Validates pointer members that should not beNULL.static voidvalidate(long array, int count)Callsvalidate(long)for each struct contained in the specified struct array.intvertexAttributeDescriptionCount()Returns the value of thevertexAttributeDescriptionCountfield.intvertexBindingDescriptionCount()Returns the value of thevertexBindingDescriptionCountfield.
-
-
-
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()
- Specified by:
sizeofin classorg.lwjgl.system.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
@Nullable 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
@Nullable 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(@Nullable VkVertexInputBindingDescription.Buffer value)
Sets the address of the specifiedVkVertexInputBindingDescription.Bufferto thepVertexBindingDescriptionsfield.
-
pVertexAttributeDescriptions
public VkPipelineVertexInputStateCreateInfo pVertexAttributeDescriptions(@Nullable VkVertexInputAttributeDescription.Buffer value)
Sets the address of the specifiedVkVertexInputAttributeDescription.Bufferto thepVertexAttributeDescriptionsfield.
-
set
public VkPipelineVertexInputStateCreateInfo set(int sType, long pNext, int flags, @Nullable VkVertexInputBindingDescription.Buffer pVertexBindingDescriptions, @Nullable VkVertexInputAttributeDescription.Buffer pVertexAttributeDescriptions)
Initializes this struct with the specified values.
-
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.
-
createSafe
@Nullable public static VkPipelineVertexInputStateCreateInfo createSafe(long address)
-
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
-
createSafe
@Nullable public static VkPipelineVertexInputStateCreateInfo.Buffer createSafe(long address, int 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(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineVertexInputStateCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkPipelineVertexInputStateCreateInfo callocStack(org.lwjgl.system.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, org.lwjgl.system.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, org.lwjgl.system.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
-
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().
-
nvertexBindingDescriptionCount
public static int nvertexBindingDescriptionCount(long struct)
Unsafe version ofvertexBindingDescriptionCount().
-
npVertexBindingDescriptions
@Nullable public static VkVertexInputBindingDescription.Buffer npVertexBindingDescriptions(long struct)
Unsafe version ofpVertexBindingDescriptions().
-
nvertexAttributeDescriptionCount
public static int nvertexAttributeDescriptionCount(long struct)
Unsafe version ofvertexAttributeDescriptionCount().
-
npVertexAttributeDescriptions
@Nullable public static VkVertexInputAttributeDescription.Buffer npVertexAttributeDescriptions(long struct)
Unsafe version ofpVertexAttributeDescriptions().
-
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.
-
nvertexBindingDescriptionCount
public static void nvertexBindingDescriptionCount(long struct, int value)Sets the specified value to thevertexBindingDescriptionCountfield of the specifiedstruct.
-
npVertexBindingDescriptions
public static void npVertexBindingDescriptions(long struct, @Nullable VkVertexInputBindingDescription.Buffer value)Unsafe version ofpVertexBindingDescriptions.
-
nvertexAttributeDescriptionCount
public static void nvertexAttributeDescriptionCount(long struct, int value)Sets the specified value to thevertexAttributeDescriptionCountfield of the specifiedstruct.
-
npVertexAttributeDescriptions
public static void npVertexAttributeDescriptions(long struct, @Nullable VkVertexInputAttributeDescription.Buffer value)Unsafe version ofpVertexAttributeDescriptions.
-
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)Callsvalidate(long)for each struct contained in the specified struct array.- Parameters:
array- the struct array to validatecount- the number of structs inarray
-
-