Package org.lwjgl.vulkan

Class VkDescriptorPoolCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDescriptorPoolCreateInfo>

org.lwjgl.vulkan.VkDescriptorPoolCreateInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkDescriptorPoolCreateInfo
extends Struct<VkDescriptorPoolCreateInfo>
implements NativeResource

 struct VkDescriptorPoolCreateInfo {
     VkStructureType sType;
     void const * pNext;
     VkDescriptorPoolCreateFlags flags;
     uint32_t maxSets;
     uint32_t poolSizeCount;
     {@link VkDescriptorPoolSize VkDescriptorPoolSize} const * pPoolSizes;
 }

Nested Class Summary

Nested Classes

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

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

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	FLAGS	The struct member offsets.
static final int	MAXSETS	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	POOLSIZECOUNT	The struct member offsets.
static final int	PPOOLSIZES	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
VkDescriptorPoolCreateInfo(ByteBuffer container)	Creates a VkDescriptorPoolCreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkDescriptorPoolCreateInfo	calloc()	Returns a new VkDescriptorPoolCreateInfo instance allocated with memCalloc.
static VkDescriptorPoolCreateInfo.Buffer	calloc(int capacity)	Returns a new VkDescriptorPoolCreateInfo.Buffer instance allocated with memCalloc.
static VkDescriptorPoolCreateInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkDescriptorPoolCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDescriptorPoolCreateInfo	calloc(MemoryStack stack)	Returns a new VkDescriptorPoolCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDescriptorPoolCreateInfo	callocStack()	Deprecated.
static VkDescriptorPoolCreateInfo.Buffer	callocStack(int capacity)	Deprecated.
static VkDescriptorPoolCreateInfo.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkDescriptorPoolCreateInfo	callocStack(MemoryStack stack)	Deprecated.
static VkDescriptorPoolCreateInfo	create()	Returns a new VkDescriptorPoolCreateInfo instance allocated with BufferUtils.
static VkDescriptorPoolCreateInfo.Buffer	create(int capacity)	Returns a new VkDescriptorPoolCreateInfo.Buffer instance allocated with BufferUtils.
static VkDescriptorPoolCreateInfo	create(long address)	Returns a new VkDescriptorPoolCreateInfo instance for the specified memory address.
static VkDescriptorPoolCreateInfo.Buffer	create(long address, int capacity)	Create a VkDescriptorPoolCreateInfo.Buffer instance at the specified memory.
static @Nullable VkDescriptorPoolCreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDescriptorPoolCreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()
VkDescriptorPoolCreateInfo	flags(int value)	Sets the specified value to the flags field.
static VkDescriptorPoolCreateInfo	malloc()	Returns a new VkDescriptorPoolCreateInfo instance allocated with memAlloc.
static VkDescriptorPoolCreateInfo.Buffer	malloc(int capacity)	Returns a new VkDescriptorPoolCreateInfo.Buffer instance allocated with memAlloc.
static VkDescriptorPoolCreateInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkDescriptorPoolCreateInfo.Buffer instance allocated on the specified MemoryStack.
static VkDescriptorPoolCreateInfo	malloc(MemoryStack stack)	Returns a new VkDescriptorPoolCreateInfo instance allocated on the specified MemoryStack.
static VkDescriptorPoolCreateInfo	mallocStack()	Deprecated.
static VkDescriptorPoolCreateInfo.Buffer	mallocStack(int capacity)	Deprecated.
static VkDescriptorPoolCreateInfo.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkDescriptorPoolCreateInfo	mallocStack(MemoryStack stack)	Deprecated.
int	maxSets()
VkDescriptorPoolCreateInfo	maxSets(int value)	Sets the specified value to the maxSets field.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static int	nmaxSets(long struct)	Unsafe version of maxSets().
static void	nmaxSets(long struct, int value)	Unsafe version of maxSets.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	npoolSizeCount(long struct)	Unsafe version of poolSizeCount().
static void	npoolSizeCount(long struct, int value)	Sets the specified value to the poolSizeCount field of the specified struct.
static @Nullable VkDescriptorPoolSize.Buffer	npPoolSizes(long struct)	Unsafe version of pPoolSizes().
static void	npPoolSizes(long struct, @Nullable VkDescriptorPoolSize.Buffer value)	Unsafe version of pPoolSizes.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()
VkDescriptorPoolCreateInfo	pNext(long value)	Sets the specified value to the pNext field.
VkDescriptorPoolCreateInfo	pNext(VkDescriptorPoolInlineUniformBlockCreateInfo value)	Prepends the specified VkDescriptorPoolInlineUniformBlockCreateInfo value to the pNext chain.
VkDescriptorPoolCreateInfo	pNext(VkDescriptorPoolInlineUniformBlockCreateInfoEXT value)	Prepends the specified VkDescriptorPoolInlineUniformBlockCreateInfoEXT value to the pNext chain.
VkDescriptorPoolCreateInfo	pNext(VkMutableDescriptorTypeCreateInfoEXT value)	Prepends the specified VkMutableDescriptorTypeCreateInfoEXT value to the pNext chain.
VkDescriptorPoolCreateInfo	pNext(VkMutableDescriptorTypeCreateInfoVALVE value)	Prepends the specified VkMutableDescriptorTypeCreateInfoVALVE value to the pNext chain.
int	poolSizeCount()
@Nullable VkDescriptorPoolSize.Buffer	pPoolSizes()
VkDescriptorPoolCreateInfo	pPoolSizes(@Nullable VkDescriptorPoolSize.Buffer value)	Sets the address of the specified VkDescriptorPoolSize.Buffer to the pPoolSizes field.
VkDescriptorPoolCreateInfo	set(int sType, long pNext, int flags, int maxSets, @Nullable VkDescriptorPoolSize.Buffer pPoolSizes)	Initializes this struct with the specified values.
VkDescriptorPoolCreateInfo	set(VkDescriptorPoolCreateInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkDescriptorPoolCreateInfo	sType(int value)	Sets the specified value to the sType field.
VkDescriptorPoolCreateInfo	sType$Default()	Sets the STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_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.

FLAGS

public static final int FLAGS

The struct member offsets.

MAXSETS

public static final int MAXSETS

The struct member offsets.

POOLSIZECOUNT

public static final int POOLSIZECOUNT

The struct member offsets.

PPOOLSIZES

public static final int PPOOLSIZES

The struct member offsets.

Constructor Details

VkDescriptorPoolCreateInfo

public VkDescriptorPoolCreateInfo(ByteBuffer container)

Creates a VkDescriptorPoolCreateInfo 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()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkDescriptorPoolCreateInfo>

sType

public int sType()

Returns:

the value of the sType field.

pNext

public long pNext()

Returns:

the value of the pNext field.

flags

public int flags()

Returns:

the value of the flags field.

maxSets

public int maxSets()

Returns:

the value of the maxSets field.

poolSizeCount

public int poolSizeCount()

Returns:

the value of the poolSizeCount field.

pPoolSizes

public @Nullable VkDescriptorPoolSize.Buffer pPoolSizes()

Returns:

a VkDescriptorPoolSize.Buffer view of the struct array pointed to by the pPoolSizes field.

sType

public VkDescriptorPoolCreateInfo sType(int value)

Sets the specified value to the sType field.

sType$Default

public VkDescriptorPoolCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO value to the sType field.

pNext

public VkDescriptorPoolCreateInfo pNext(long value)

Sets the specified value to the pNext field.

pNext

public VkDescriptorPoolCreateInfo pNext(VkDescriptorPoolInlineUniformBlockCreateInfo value)

Prepends the specified VkDescriptorPoolInlineUniformBlockCreateInfo value to the pNext chain.

pNext

public VkDescriptorPoolCreateInfo pNext(VkDescriptorPoolInlineUniformBlockCreateInfoEXT value)

Prepends the specified VkDescriptorPoolInlineUniformBlockCreateInfoEXT value to the pNext chain.

pNext

public VkDescriptorPoolCreateInfo pNext(VkMutableDescriptorTypeCreateInfoEXT value)

Prepends the specified VkMutableDescriptorTypeCreateInfoEXT value to the pNext chain.

pNext

public VkDescriptorPoolCreateInfo pNext(VkMutableDescriptorTypeCreateInfoVALVE value)

Prepends the specified VkMutableDescriptorTypeCreateInfoVALVE value to the pNext chain.

flags

public VkDescriptorPoolCreateInfo flags(int value)

Sets the specified value to the flags field.

maxSets

public VkDescriptorPoolCreateInfo maxSets(int value)

Sets the specified value to the maxSets field.

pPoolSizes

public VkDescriptorPoolCreateInfo pPoolSizes(@Nullable VkDescriptorPoolSize.Buffer value)

Sets the address of the specified VkDescriptorPoolSize.Buffer to the pPoolSizes field.

set

public VkDescriptorPoolCreateInfo set(int sType,
 long pNext,
 int flags,
 int maxSets,
 @Nullable VkDescriptorPoolSize.Buffer pPoolSizes)

Initializes this struct with the specified values.

set

public VkDescriptorPoolCreateInfo set(VkDescriptorPoolCreateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDescriptorPoolCreateInfo malloc()

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

calloc

public static VkDescriptorPoolCreateInfo calloc()

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

create

public static VkDescriptorPoolCreateInfo create()

Returns a new VkDescriptorPoolCreateInfo instance allocated with BufferUtils.

create

public static VkDescriptorPoolCreateInfo create(long address)

Returns a new VkDescriptorPoolCreateInfo instance for the specified memory address.

createSafe

public static @Nullable VkDescriptorPoolCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDescriptorPoolCreateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDescriptorPoolCreateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDescriptorPoolCreateInfo.Buffer create(int capacity)

Returns a new VkDescriptorPoolCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDescriptorPoolCreateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkDescriptorPoolCreateInfo mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkDescriptorPoolCreateInfo callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkDescriptorPoolCreateInfo mallocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkDescriptorPoolCreateInfo callocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkDescriptorPoolCreateInfo.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkDescriptorPoolCreateInfo.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkDescriptorPoolCreateInfo.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkDescriptorPoolCreateInfo.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static VkDescriptorPoolCreateInfo malloc(MemoryStack stack)

Returns a new VkDescriptorPoolCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkDescriptorPoolCreateInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkDescriptorPoolCreateInfo.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkDescriptorPoolCreateInfo.Buffer calloc(int capacity,
 MemoryStack stack)

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

nflags

public static int nflags(long struct)

Unsafe version of flags().

nmaxSets

public static int nmaxSets(long struct)

Unsafe version of maxSets().

npoolSizeCount

public static int npoolSizeCount(long struct)

Unsafe version of poolSizeCount().

npPoolSizes

public static @Nullable VkDescriptorPoolSize.Buffer npPoolSizes(long struct)

Unsafe version of pPoolSizes().

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.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.

nmaxSets

public static void nmaxSets(long struct,
 int value)

Unsafe version of maxSets.

npoolSizeCount

public static void npoolSizeCount(long struct,
 int value)

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

npPoolSizes

public static void npPoolSizes(long struct,
 @Nullable VkDescriptorPoolSize.Buffer value)

Unsafe version of pPoolSizes.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate