Package org.lwjgl.vulkan

Class VkDescriptorSetVariableDescriptorCountAllocateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDescriptorSetVariableDescriptorCountAllocateInfo>

org.lwjgl.vulkan.VkDescriptorSetVariableDescriptorCountAllocateInfo

All Implemented Interfaces:

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

Direct Known Subclasses:

VkDescriptorSetVariableDescriptorCountAllocateInfoEXT

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

Structure specifying additional allocation parameters for descriptor sets.

Description

If descriptorSetCount is zero or this structure is not included in the pNext chain, then the variable lengths are considered to be zero. Otherwise, pDescriptorCounts[i] is the number of descriptors in the variable-sized descriptor binding in the corresponding descriptor set layout. If the variable-sized descriptor binding in the corresponding descriptor set layout has a descriptor type of DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK then pDescriptorCounts[i] specifies the binding’s capacity in bytes. If VkDescriptorSetAllocateInfo::pSetLayouts[i] does not include a variable-sized descriptor binding, then pDescriptorCounts[i] is ignored.

Valid Usage

• If descriptorSetCount is not zero, descriptorSetCount must equal VkDescriptorSetAllocateInfo::descriptorSetCount

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DESCRIPTOR_SET_VARIABLE_DESCRIPTOR_COUNT_ALLOCATE_INFO
• If descriptorSetCount is not 0, pDescriptorCounts must be a valid pointer to an array of descriptorSetCount uint32_t values

Layout

 struct VkDescriptorSetVariableDescriptorCountAllocateInfo {
     VkStructureType sType();
     void const * pNext();
     uint32_t descriptorSetCount();
     uint32_t const * pDescriptorCounts();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkDescriptorSetVariableDescriptorCountAllocateInfo.Buffer	An array of VkDescriptorSetVariableDescriptorCountAllocateInfo 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	DESCRIPTORSETCOUNT	The struct member offsets.
static final int	PDESCRIPTORCOUNTS	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	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
VkDescriptorSetVariableDescriptorCountAllocateInfo(ByteBuffer container)	Creates a VkDescriptorSetVariableDescriptorCountAllocateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkDescriptorSetVariableDescriptorCountAllocateInfo	calloc()	Returns a new VkDescriptorSetVariableDescriptorCountAllocateInfo instance allocated with memCalloc.
static VkDescriptorSetVariableDescriptorCountAllocateInfo.Buffer	calloc(int capacity)	Returns a new VkDescriptorSetVariableDescriptorCountAllocateInfo.Buffer instance allocated with memCalloc.
static VkDescriptorSetVariableDescriptorCountAllocateInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDescriptorSetVariableDescriptorCountAllocateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDescriptorSetVariableDescriptorCountAllocateInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDescriptorSetVariableDescriptorCountAllocateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDescriptorSetVariableDescriptorCountAllocateInfo	create()	Returns a new VkDescriptorSetVariableDescriptorCountAllocateInfo instance allocated with BufferUtils.
static VkDescriptorSetVariableDescriptorCountAllocateInfo.Buffer	create(int capacity)	Returns a new VkDescriptorSetVariableDescriptorCountAllocateInfo.Buffer instance allocated with BufferUtils.
static VkDescriptorSetVariableDescriptorCountAllocateInfo	create(long address)	Returns a new VkDescriptorSetVariableDescriptorCountAllocateInfo instance for the specified memory address.
static VkDescriptorSetVariableDescriptorCountAllocateInfo.Buffer	create(long address, int capacity)	Create a VkDescriptorSetVariableDescriptorCountAllocateInfo.Buffer instance at the specified memory.
static @Nullable VkDescriptorSetVariableDescriptorCountAllocateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDescriptorSetVariableDescriptorCountAllocateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	descriptorSetCount()	zero or the number of elements in pDescriptorCounts.
static VkDescriptorSetVariableDescriptorCountAllocateInfo	malloc()	Returns a new VkDescriptorSetVariableDescriptorCountAllocateInfo instance allocated with memAlloc.
static VkDescriptorSetVariableDescriptorCountAllocateInfo.Buffer	malloc(int capacity)	Returns a new VkDescriptorSetVariableDescriptorCountAllocateInfo.Buffer instance allocated with memAlloc.
static VkDescriptorSetVariableDescriptorCountAllocateInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDescriptorSetVariableDescriptorCountAllocateInfo.Buffer instance allocated on the specified MemoryStack.
static VkDescriptorSetVariableDescriptorCountAllocateInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDescriptorSetVariableDescriptorCountAllocateInfo instance allocated on the specified MemoryStack.
static int	ndescriptorSetCount(long struct)	Unsafe version of descriptorSetCount().
static void	ndescriptorSetCount(long struct, int value)	Sets the specified value to the descriptorSetCount field of the specified struct.
static @Nullable IntBuffer	npDescriptorCounts(long struct)	Unsafe version of pDescriptorCounts.
static void	npDescriptorCounts(long struct, @Nullable IntBuffer value)	Unsafe version of pDescriptorCounts.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
@Nullable IntBuffer	pDescriptorCounts()	a pointer to an array of descriptor counts, with each member specifying the number of descriptors in a variable-sized descriptor binding in the corresponding descriptor set being allocated.
VkDescriptorSetVariableDescriptorCountAllocateInfo	pDescriptorCounts(@Nullable IntBuffer value)	Sets the address of the specified IntBuffer to the pDescriptorCounts() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkDescriptorSetVariableDescriptorCountAllocateInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkDescriptorSetVariableDescriptorCountAllocateInfo	set(int sType, long pNext, @Nullable IntBuffer pDescriptorCounts)	Initializes this struct with the specified values.
VkDescriptorSetVariableDescriptorCountAllocateInfo	set(VkDescriptorSetVariableDescriptorCountAllocateInfo src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkDescriptorSetVariableDescriptorCountAllocateInfo	sType(int value)	Sets the specified value to the sType() field.
VkDescriptorSetVariableDescriptorCountAllocateInfo	sType$Default()	Sets the STRUCTURE_TYPE_DESCRIPTOR_SET_VARIABLE_DESCRIPTOR_COUNT_ALLOCATE_INFO value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, 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.

DESCRIPTORSETCOUNT

public static final int DESCRIPTORSETCOUNT

The struct member offsets.

PDESCRIPTORCOUNTS

public static final int PDESCRIPTORCOUNTS

The struct member offsets.

Constructor Details

VkDescriptorSetVariableDescriptorCountAllocateInfo

public VkDescriptorSetVariableDescriptorCountAllocateInfo(ByteBuffer container)

Creates a VkDescriptorSetVariableDescriptorCountAllocateInfo 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<VkDescriptorSetVariableDescriptorCountAllocateInfo>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

descriptorSetCount

public int descriptorSetCount()

zero or the number of elements in pDescriptorCounts.

pDescriptorCounts

public @Nullable IntBuffer pDescriptorCounts()

a pointer to an array of descriptor counts, with each member specifying the number of descriptors in a variable-sized descriptor binding in the corresponding descriptor set being allocated.

sType

public VkDescriptorSetVariableDescriptorCountAllocateInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDescriptorSetVariableDescriptorCountAllocateInfo sType$Default()

Sets the STRUCTURE_TYPE_DESCRIPTOR_SET_VARIABLE_DESCRIPTOR_COUNT_ALLOCATE_INFO value to the sType() field.

pNext

public VkDescriptorSetVariableDescriptorCountAllocateInfo pNext(long value)

Sets the specified value to the pNext() field.

pDescriptorCounts

public VkDescriptorSetVariableDescriptorCountAllocateInfo pDescriptorCounts(@Nullable IntBuffer value)

Sets the address of the specified IntBuffer to the pDescriptorCounts() field.

set

public VkDescriptorSetVariableDescriptorCountAllocateInfo set(int sType,
 long pNext,
 @Nullable IntBuffer pDescriptorCounts)

Initializes this struct with the specified values.

set

public VkDescriptorSetVariableDescriptorCountAllocateInfo set(VkDescriptorSetVariableDescriptorCountAllocateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDescriptorSetVariableDescriptorCountAllocateInfo malloc()

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

calloc

public static VkDescriptorSetVariableDescriptorCountAllocateInfo calloc()

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

create

public static VkDescriptorSetVariableDescriptorCountAllocateInfo create()

Returns a new VkDescriptorSetVariableDescriptorCountAllocateInfo instance allocated with BufferUtils.

create

public static VkDescriptorSetVariableDescriptorCountAllocateInfo create(long address)

Returns a new VkDescriptorSetVariableDescriptorCountAllocateInfo instance for the specified memory address.

createSafe

public static @Nullable VkDescriptorSetVariableDescriptorCountAllocateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDescriptorSetVariableDescriptorCountAllocateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDescriptorSetVariableDescriptorCountAllocateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDescriptorSetVariableDescriptorCountAllocateInfo.Buffer create(int capacity)

Returns a new VkDescriptorSetVariableDescriptorCountAllocateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDescriptorSetVariableDescriptorCountAllocateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkDescriptorSetVariableDescriptorCountAllocateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkDescriptorSetVariableDescriptorCountAllocateInfo.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().

ndescriptorSetCount

public static int ndescriptorSetCount(long struct)

Unsafe version of descriptorSetCount().

npDescriptorCounts

public static @Nullable IntBuffer npDescriptorCounts(long struct)

Unsafe version of pDescriptorCounts.

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.

ndescriptorSetCount

public static void ndescriptorSetCount(long struct,
 int value)

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

npDescriptorCounts

public static void npDescriptorCounts(long struct,
 @Nullable IntBuffer value)

Unsafe version of pDescriptorCounts.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate