Package org.lwjgl.vulkan

Class VkPipelineVertexInputDivisorStateCreateInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPipelineVertexInputDivisorStateCreateInfoKHR>

org.lwjgl.vulkan.VkPipelineVertexInputDivisorStateCreateInfoKHR

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

Direct Known Subclasses:

VkPipelineVertexInputDivisorStateCreateInfoEXT

public class VkPipelineVertexInputDivisorStateCreateInfoKHR
extends org.lwjgl.system.Struct<VkPipelineVertexInputDivisorStateCreateInfoKHR>
implements org.lwjgl.system.NativeResource

Structure specifying vertex attributes assignment during instanced rendering.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_DIVISOR_STATE_CREATE_INFO_KHR
• pVertexBindingDivisors must be a valid pointer to an array of vertexBindingDivisorCount VkVertexInputBindingDivisorDescriptionKHR structures
• vertexBindingDivisorCount must be greater than 0

See Also

VkVertexInputBindingDivisorDescriptionKHR

Layout

 struct VkPipelineVertexInputDivisorStateCreateInfoKHR {
     VkStructureType sType();
     void const * pNext();
     uint32_t vertexBindingDivisorCount();
     VkVertexInputBindingDivisorDescriptionKHR const * pVertexBindingDivisors();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer	An array of VkPipelineVertexInputDivisorStateCreateInfoKHR structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	PNEXT	The struct member offsets.
static final int	PVERTEXBINDINGDIVISORS	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.
static final int	VERTEXBINDINGDIVISORCOUNT	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkPipelineVertexInputDivisorStateCreateInfoKHR(ByteBuffer container)	Creates a VkPipelineVertexInputDivisorStateCreateInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPipelineVertexInputDivisorStateCreateInfoKHR	calloc()	Returns a new VkPipelineVertexInputDivisorStateCreateInfoKHR instance allocated with memCalloc.
static VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer	calloc(int capacity)	Returns a new VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer instance allocated with memCalloc.
static VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineVertexInputDivisorStateCreateInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineVertexInputDivisorStateCreateInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineVertexInputDivisorStateCreateInfoKHR	create()	Returns a new VkPipelineVertexInputDivisorStateCreateInfoKHR instance allocated with BufferUtils.
static VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer	create(int capacity)	Returns a new VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer instance allocated with BufferUtils.
static VkPipelineVertexInputDivisorStateCreateInfoKHR	create(long address)	Returns a new VkPipelineVertexInputDivisorStateCreateInfoKHR instance for the specified memory address.
static VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer	create(long address, int capacity)	Create a VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer instance at the specified memory.
static VkPipelineVertexInputDivisorStateCreateInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkPipelineVertexInputDivisorStateCreateInfoKHR	malloc()	Returns a new VkPipelineVertexInputDivisorStateCreateInfoKHR instance allocated with memAlloc.
static VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer	malloc(int capacity)	Returns a new VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer instance allocated with memAlloc.
static VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkPipelineVertexInputDivisorStateCreateInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineVertexInputDivisorStateCreateInfoKHR instance allocated on the specified MemoryStack.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static VkVertexInputBindingDivisorDescriptionKHR.Buffer	npVertexBindingDivisors(long struct)	Unsafe version of pVertexBindingDivisors().
static void	npVertexBindingDivisors(long struct, VkVertexInputBindingDivisorDescriptionKHR.Buffer value)	Unsafe version of pVertexBindingDivisors.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static int	nvertexBindingDivisorCount(long struct)	Unsafe version of vertexBindingDivisorCount().
static void	nvertexBindingDivisorCount(long struct, int value)	Sets the specified value to the vertexBindingDivisorCount field of the specified struct.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkPipelineVertexInputDivisorStateCreateInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkVertexInputBindingDivisorDescriptionKHR.Buffer	pVertexBindingDivisors()	a pointer to an array of VkVertexInputBindingDivisorDescriptionKHR structures specifying the divisor value for each binding.
VkPipelineVertexInputDivisorStateCreateInfoKHR	pVertexBindingDivisors(VkVertexInputBindingDivisorDescriptionKHR.Buffer value)	Sets the address of the specified VkVertexInputBindingDivisorDescriptionKHR.Buffer to the pVertexBindingDivisors() field.
VkPipelineVertexInputDivisorStateCreateInfoKHR	set(int sType, long pNext, VkVertexInputBindingDivisorDescriptionKHR.Buffer pVertexBindingDivisors)	Initializes this struct with the specified values.
VkPipelineVertexInputDivisorStateCreateInfoKHR	set(VkPipelineVertexInputDivisorStateCreateInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPipelineVertexInputDivisorStateCreateInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkPipelineVertexInputDivisorStateCreateInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_DIVISOR_STATE_CREATE_INFO_KHR value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.
int	vertexBindingDivisorCount()	the number of elements in the pVertexBindingDivisors array.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

VERTEXBINDINGDIVISORCOUNT

public static final int VERTEXBINDINGDIVISORCOUNT

The struct member offsets.

PVERTEXBINDINGDIVISORS

public static final int PVERTEXBINDINGDIVISORS

The struct member offsets.

Constructor Details

VkPipelineVertexInputDivisorStateCreateInfoKHR

public VkPipelineVertexInputDivisorStateCreateInfoKHR(ByteBuffer container)

Creates a VkPipelineVertexInputDivisorStateCreateInfoKHR instance at the current position of the specified ByteBuffer 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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkPipelineVertexInputDivisorStateCreateInfoKHR>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

vertexBindingDivisorCount

public int vertexBindingDivisorCount()

the number of elements in the pVertexBindingDivisors array.

pVertexBindingDivisors

public VkVertexInputBindingDivisorDescriptionKHR.Buffer pVertexBindingDivisors()

a pointer to an array of VkVertexInputBindingDivisorDescriptionKHR structures specifying the divisor value for each binding.

sType

public VkPipelineVertexInputDivisorStateCreateInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPipelineVertexInputDivisorStateCreateInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_DIVISOR_STATE_CREATE_INFO_KHR value to the sType() field.

pNext

public VkPipelineVertexInputDivisorStateCreateInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

pVertexBindingDivisors

public VkPipelineVertexInputDivisorStateCreateInfoKHR pVertexBindingDivisors(VkVertexInputBindingDivisorDescriptionKHR.Buffer value)

Sets the address of the specified VkVertexInputBindingDivisorDescriptionKHR.Buffer to the pVertexBindingDivisors() field.

set

public VkPipelineVertexInputDivisorStateCreateInfoKHR set(int sType,
 long pNext,
 VkVertexInputBindingDivisorDescriptionKHR.Buffer pVertexBindingDivisors)

Initializes this struct with the specified values.

set

public VkPipelineVertexInputDivisorStateCreateInfoKHR set(VkPipelineVertexInputDivisorStateCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPipelineVertexInputDivisorStateCreateInfoKHR malloc()

Returns a new VkPipelineVertexInputDivisorStateCreateInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkPipelineVertexInputDivisorStateCreateInfoKHR calloc()

Returns a new VkPipelineVertexInputDivisorStateCreateInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkPipelineVertexInputDivisorStateCreateInfoKHR create()

Returns a new VkPipelineVertexInputDivisorStateCreateInfoKHR instance allocated with BufferUtils.

create

public static VkPipelineVertexInputDivisorStateCreateInfoKHR create(long address)

Returns a new VkPipelineVertexInputDivisorStateCreateInfoKHR instance for the specified memory address.

createSafe

@Nullable
public static VkPipelineVertexInputDivisorStateCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer malloc(int capacity)

Returns a new VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer calloc(int capacity)

Returns a new VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer create(int capacity)

Returns a new VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer create(long address,
 int capacity)

Create a VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

@Nullable
public static VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkPipelineVertexInputDivisorStateCreateInfoKHR malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkPipelineVertexInputDivisorStateCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkPipelineVertexInputDivisorStateCreateInfoKHR calloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkPipelineVertexInputDivisorStateCreateInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkPipelineVertexInputDivisorStateCreateInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nvertexBindingDivisorCount

public static int nvertexBindingDivisorCount(long struct)

Unsafe version of vertexBindingDivisorCount().

npVertexBindingDivisors

public static VkVertexInputBindingDivisorDescriptionKHR.Buffer npVertexBindingDivisors(long struct)

Unsafe version of pVertexBindingDivisors().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nvertexBindingDivisorCount

public static void nvertexBindingDivisorCount(long struct,
 int value)

Sets the specified value to the vertexBindingDivisorCount field of the specified struct.

npVertexBindingDivisors

public static void npVertexBindingDivisors(long struct,
 VkVertexInputBindingDivisorDescriptionKHR.Buffer value)

Unsafe version of pVertexBindingDivisors.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate