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.NativeResource
Structure specifying parameters of a newly created pipeline vertex input state.Valid Usage
vertexBindingDescriptionCount
must be less than or equal toVkPhysicalDeviceLimits
::maxVertexInputBindings
vertexAttributeDescriptionCount
must be less than or equal toVkPhysicalDeviceLimits
::maxVertexInputAttributes
- For every
binding
specified by each 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
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO
pNext
must beNULL
or a pointer to a valid instance ofVkPipelineVertexInputDivisorStateCreateInfoEXT
flags
must be 0- If
vertexBindingDescriptionCount
is not 0,pVertexBindingDescriptions
must be a valid pointer to an array ofvertexBindingDescriptionCount
validVkVertexInputBindingDescription
structures - If
vertexAttributeDescriptionCount
is not 0,pVertexAttributeDescriptions
must be a valid pointer to an array ofvertexAttributeDescriptionCount
validVkVertexInputAttributeDescription
structures
See Also
VkGraphicsPipelineCreateInfo
,VkVertexInputAttributeDescription
,VkVertexInputBindingDescription
Member documentation
sType
– the type of this structure.pNext
–NULL
or 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 ofVkVertexInputBindingDescription
structures.vertexAttributeDescriptionCount
– the number of vertex attribute descriptions provided inpVertexAttributeDescriptions
.pVertexAttributeDescriptions
– a pointer to an array ofVkVertexInputAttributeDescription
structures.
Layout
struct VkPipelineVertexInputStateCreateInfo { VkStructureType sType; void const * pNext; VkPipelineVertexInputStateCreateFlags flags; uint32_t vertexBindingDescriptionCount;
VkVertexInputBindingDescription
const * pVertexBindingDescriptions; uint32_t vertexAttributeDescriptionCount;VkVertexInputAttributeDescription
const * pVertexAttributeDescriptions; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkPipelineVertexInputStateCreateInfo.Buffer
An array ofVkPipelineVertexInputStateCreateInfo
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
FLAGS
PNEXT
PVERTEXATTRIBUTEDESCRIPTIONS
PVERTEXBINDINGDESCRIPTIONSThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
VERTEXATTRIBUTEDESCRIPTIONCOUNT
VERTEXBINDINGDESCRIPTIONCOUNTThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkPipelineVertexInputStateCreateInfo(java.nio.ByteBuffer container)
Creates aVkPipelineVertexInputStateCreateInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkPipelineVertexInputStateCreateInfo
calloc()
Returns a newVkPipelineVertexInputStateCreateInfo
instance allocated withmemCalloc
.static VkPipelineVertexInputStateCreateInfo.Buffer
calloc(int capacity)
Returns a newVkPipelineVertexInputStateCreateInfo.Buffer
instance allocated withmemCalloc
.static VkPipelineVertexInputStateCreateInfo
callocStack()
Returns a newVkPipelineVertexInputStateCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPipelineVertexInputStateCreateInfo.Buffer
callocStack(int capacity)
Returns a newVkPipelineVertexInputStateCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPipelineVertexInputStateCreateInfo.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineVertexInputStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPipelineVertexInputStateCreateInfo
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineVertexInputStateCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPipelineVertexInputStateCreateInfo
create()
Returns a newVkPipelineVertexInputStateCreateInfo
instance allocated withBufferUtils
.static VkPipelineVertexInputStateCreateInfo.Buffer
create(int capacity)
Returns a newVkPipelineVertexInputStateCreateInfo.Buffer
instance allocated withBufferUtils
.static VkPipelineVertexInputStateCreateInfo
create(long address)
Returns a newVkPipelineVertexInputStateCreateInfo
instance for the specified memory address.static VkPipelineVertexInputStateCreateInfo.Buffer
create(long address, int capacity)
Create aVkPipelineVertexInputStateCreateInfo.Buffer
instance at the specified memory.static VkPipelineVertexInputStateCreateInfo
createSafe(long address)
static VkPipelineVertexInputStateCreateInfo.Buffer
createSafe(long address, int capacity)
int
flags()
Returns the value of theflags
field.VkPipelineVertexInputStateCreateInfo
flags(int value)
Sets the specified value to theflags
field.static VkPipelineVertexInputStateCreateInfo
malloc()
Returns a newVkPipelineVertexInputStateCreateInfo
instance allocated withmemAlloc
.static VkPipelineVertexInputStateCreateInfo.Buffer
malloc(int capacity)
Returns a newVkPipelineVertexInputStateCreateInfo.Buffer
instance allocated withmemAlloc
.static VkPipelineVertexInputStateCreateInfo
mallocStack()
Returns a newVkPipelineVertexInputStateCreateInfo
instance allocated on the thread-localMemoryStack
.static VkPipelineVertexInputStateCreateInfo.Buffer
mallocStack(int capacity)
Returns a newVkPipelineVertexInputStateCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkPipelineVertexInputStateCreateInfo.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineVertexInputStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkPipelineVertexInputStateCreateInfo
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineVertexInputStateCreateInfo
instance allocated on the specifiedMemoryStack
.static int
nflags(long struct)
Unsafe version offlags()
.static void
nflags(long struct, int value)
Unsafe version offlags
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static VkVertexInputAttributeDescription.Buffer
npVertexAttributeDescriptions(long struct)
Unsafe version ofpVertexAttributeDescriptions()
.static void
npVertexAttributeDescriptions(long struct, VkVertexInputAttributeDescription.Buffer value)
Unsafe version ofpVertexAttributeDescriptions
.static VkVertexInputBindingDescription.Buffer
npVertexBindingDescriptions(long struct)
Unsafe version ofpVertexBindingDescriptions()
.static void
npVertexBindingDescriptions(long struct, VkVertexInputBindingDescription.Buffer value)
Unsafe version ofpVertexBindingDescriptions
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.static int
nvertexAttributeDescriptionCount(long struct)
Unsafe version ofvertexAttributeDescriptionCount()
.static void
nvertexAttributeDescriptionCount(long struct, int value)
Sets the specified value to thevertexAttributeDescriptionCount
field of the specifiedstruct
.static int
nvertexBindingDescriptionCount(long struct)
Unsafe version ofvertexBindingDescriptionCount()
.static void
nvertexBindingDescriptionCount(long struct, int value)
Sets the specified value to thevertexBindingDescriptionCount
field of the specifiedstruct
.long
pNext()
Returns the value of thepNext
field.VkPipelineVertexInputStateCreateInfo
pNext(long value)
Sets the specified value to thepNext
field.VkVertexInputAttributeDescription.Buffer
pVertexAttributeDescriptions()
Returns aVkVertexInputAttributeDescription.Buffer
view of the struct array pointed to by thepVertexAttributeDescriptions
field.VkPipelineVertexInputStateCreateInfo
pVertexAttributeDescriptions(VkVertexInputAttributeDescription.Buffer value)
Sets the address of the specifiedVkVertexInputAttributeDescription.Buffer
to thepVertexAttributeDescriptions
field.VkVertexInputBindingDescription.Buffer
pVertexBindingDescriptions()
Returns aVkVertexInputBindingDescription.Buffer
view of the struct array pointed to by thepVertexBindingDescriptions
field.VkPipelineVertexInputStateCreateInfo
pVertexBindingDescriptions(VkVertexInputBindingDescription.Buffer value)
Sets the address of the specifiedVkVertexInputBindingDescription.Buffer
to thepVertexBindingDescriptions
field.VkPipelineVertexInputStateCreateInfo
set(int sType, long pNext, int flags, VkVertexInputBindingDescription.Buffer pVertexBindingDescriptions, VkVertexInputAttributeDescription.Buffer pVertexAttributeDescriptions)
Initializes this struct with the specified values.VkPipelineVertexInputStateCreateInfo
set(VkPipelineVertexInputStateCreateInfo src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkPipelineVertexInputStateCreateInfo
sType(int value)
Sets the specified value to thesType
field.static void
validate(long struct)
Validates pointer members that should not beNULL
.static void
validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.int
vertexAttributeDescriptionCount()
Returns the value of thevertexAttributeDescriptionCount
field.int
vertexBindingDescriptionCount()
Returns the value of thevertexBindingDescriptionCount
field.
-
-
-
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()
- Specified by:
sizeof
in classorg.lwjgl.system.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
@Nullable 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
@Nullable 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(@Nullable VkVertexInputBindingDescription.Buffer value)
Sets the address of the specifiedVkVertexInputBindingDescription.Buffer
to thepVertexBindingDescriptions
field.
-
pVertexAttributeDescriptions
public VkPipelineVertexInputStateCreateInfo pVertexAttributeDescriptions(@Nullable VkVertexInputAttributeDescription.Buffer value)
Sets the address of the specifiedVkVertexInputAttributeDescription.Buffer
to thepVertexAttributeDescriptions
field.
-
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 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.
-
createSafe
@Nullable public static VkPipelineVertexInputStateCreateInfo createSafe(long address)
-
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
-
createSafe
@Nullable public static VkPipelineVertexInputStateCreateInfo.Buffer createSafe(long address, int 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(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineVertexInputStateCreateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkPipelineVertexInputStateCreateInfo callocStack(org.lwjgl.system.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, org.lwjgl.system.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, org.lwjgl.system.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
-
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 thevertexBindingDescriptionCount
field 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 thevertexAttributeDescriptionCount
field 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
-
-