Class VkDescriptorSetAllocateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDescriptorSetAllocateInfo>

org.lwjgl.vulkan.VkDescriptorSetAllocateInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkDescriptorSetAllocateInfo
extends Struct<VkDescriptorSetAllocateInfo>
implements NativeResource

struct VkDescriptorSetAllocateInfo {
    VkStructureType sType;
    void const * pNext;
    VkDescriptorPool descriptorPool;
    uint32_t descriptorSetCount;
    VkDescriptorSetLayout const * pSetLayouts;
}

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DESCRIPTORPOOL	The struct member offsets.
static final int	DESCRIPTORSETCOUNT	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	PSETLAYOUTS	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 Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkDescriptorSetAllocateInfo	calloc()	Returns a new VkDescriptorSetAllocateInfo instance allocated with memCalloc.
static VkDescriptorSetAllocateInfo.Buffer	calloc(int capacity)	Returns a new VkDescriptorSetAllocateInfo.Buffer instance allocated with memCalloc.
static VkDescriptorSetAllocateInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkDescriptorSetAllocateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDescriptorSetAllocateInfo	calloc(MemoryStack stack)	Returns a new VkDescriptorSetAllocateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDescriptorSetAllocateInfo	create()	Returns a new VkDescriptorSetAllocateInfo instance allocated with BufferUtils.
static VkDescriptorSetAllocateInfo.Buffer	create(int capacity)	Returns a new VkDescriptorSetAllocateInfo.Buffer instance allocated with BufferUtils.
static VkDescriptorSetAllocateInfo	create(long address)	Returns a new VkDescriptorSetAllocateInfo instance for the specified memory address.
static VkDescriptorSetAllocateInfo.Buffer	create(long address, int capacity)	Create a VkDescriptorSetAllocateInfo.Buffer instance at the specified memory.
static @Nullable VkDescriptorSetAllocateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDescriptorSetAllocateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	descriptorPool()
VkDescriptorSetAllocateInfo	descriptorPool(long value)	Sets the specified value to the descriptorPool field.
int	descriptorSetCount()
static VkDescriptorSetAllocateInfo	malloc()	Returns a new VkDescriptorSetAllocateInfo instance allocated with memAlloc.
static VkDescriptorSetAllocateInfo.Buffer	malloc(int capacity)	Returns a new VkDescriptorSetAllocateInfo.Buffer instance allocated with memAlloc.
static VkDescriptorSetAllocateInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkDescriptorSetAllocateInfo.Buffer instance allocated on the specified MemoryStack.
static VkDescriptorSetAllocateInfo	malloc(MemoryStack stack)	Returns a new VkDescriptorSetAllocateInfo instance allocated on the specified MemoryStack.
static long	ndescriptorPool(long struct)	Unsafe version of descriptorPool().
static void	ndescriptorPool(long struct, long value)	Unsafe version of descriptorPool.
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 long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static LongBuffer	npSetLayouts(long struct)	Unsafe version of pSetLayouts.
static void	npSetLayouts(long struct, LongBuffer value)	Unsafe version of pSetLayouts.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()
VkDescriptorSetAllocateInfo	pNext(long value)	Sets the specified value to the pNext field.
VkDescriptorSetAllocateInfo	pNext(VkDescriptorSetVariableDescriptorCountAllocateInfo value)	Prepends the specified VkDescriptorSetVariableDescriptorCountAllocateInfo value to the pNext chain.
VkDescriptorSetAllocateInfo	pNext(VkDescriptorSetVariableDescriptorCountAllocateInfoEXT value)	Prepends the specified VkDescriptorSetVariableDescriptorCountAllocateInfoEXT value to the pNext chain.
LongBuffer	pSetLayouts()
VkDescriptorSetAllocateInfo	pSetLayouts(LongBuffer value)	Sets the address of the specified LongBuffer to the pSetLayouts field.
VkDescriptorSetAllocateInfo	set(int sType, long pNext, long descriptorPool, LongBuffer pSetLayouts)	Initializes this struct with the specified values.
VkDescriptorSetAllocateInfo	set(VkDescriptorSetAllocateInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkDescriptorSetAllocateInfo	sType(int value)	Sets the specified value to the sType field.
VkDescriptorSetAllocateInfo	sType$Default()	Sets the STRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO value to the sType field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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.

DESCRIPTORPOOL

public static final int DESCRIPTORPOOL

The struct member offsets.

DESCRIPTORSETCOUNT

public static final int DESCRIPTORSETCOUNT

The struct member offsets.

PSETLAYOUTS

public static final int PSETLAYOUTS

The struct member offsets.

Constructor Details

VkDescriptorSetAllocateInfo

public VkDescriptorSetAllocateInfo(ByteBuffer container)

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

sType

@NativeType("VkStructureType")
public int sType()

Returns:

the value of the sType field.

pNext

@NativeType("void const *")
public long pNext()

Returns:

the value of the pNext field.

descriptorPool

@NativeType("VkDescriptorPool")
public long descriptorPool()

Returns:

the value of the descriptorPool field.

descriptorSetCount

@NativeType("uint32_t")
public int descriptorSetCount()

Returns:

the value of the descriptorSetCount field.

pSetLayouts

@NativeType("VkDescriptorSetLayout const *")
public LongBuffer pSetLayouts()

Returns:

a LongBuffer view of the data pointed to by the pSetLayouts field.

sType

public VkDescriptorSetAllocateInfo sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

sType$Default

public VkDescriptorSetAllocateInfo sType$Default()

Sets the STRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO value to the sType field.

pNext

public VkDescriptorSetAllocateInfo pNext(@NativeType("void const *")
 long value)

Sets the specified value to the pNext field.

pNext

public VkDescriptorSetAllocateInfo pNext(VkDescriptorSetVariableDescriptorCountAllocateInfo value)

Prepends the specified VkDescriptorSetVariableDescriptorCountAllocateInfo value to the pNext chain.

pNext

public VkDescriptorSetAllocateInfo pNext(VkDescriptorSetVariableDescriptorCountAllocateInfoEXT value)

Prepends the specified VkDescriptorSetVariableDescriptorCountAllocateInfoEXT value to the pNext chain.

descriptorPool

public VkDescriptorSetAllocateInfo descriptorPool(@NativeType("VkDescriptorPool")
 long value)

Sets the specified value to the descriptorPool field.

pSetLayouts

public VkDescriptorSetAllocateInfo pSetLayouts(@NativeType("VkDescriptorSetLayout const *")
 LongBuffer value)

Sets the address of the specified LongBuffer to the pSetLayouts field.

set

public VkDescriptorSetAllocateInfo set(int sType,
 long pNext,
 long descriptorPool,
 LongBuffer pSetLayouts)

Initializes this struct with the specified values.

set

public VkDescriptorSetAllocateInfo set(VkDescriptorSetAllocateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDescriptorSetAllocateInfo malloc()

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

calloc

public static VkDescriptorSetAllocateInfo calloc()

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

create

public static VkDescriptorSetAllocateInfo create()

Returns a new VkDescriptorSetAllocateInfo instance allocated with BufferUtils.

create

public static VkDescriptorSetAllocateInfo create(long address)

Returns a new VkDescriptorSetAllocateInfo instance for the specified memory address.

createSafe

public static @Nullable VkDescriptorSetAllocateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDescriptorSetAllocateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDescriptorSetAllocateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDescriptorSetAllocateInfo.Buffer create(int capacity)

Returns a new VkDescriptorSetAllocateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDescriptorSetAllocateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkDescriptorSetAllocateInfo malloc(MemoryStack stack)

Returns a new VkDescriptorSetAllocateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkDescriptorSetAllocateInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ndescriptorPool

public static long ndescriptorPool(long struct)

Unsafe version of descriptorPool().

ndescriptorSetCount

public static int ndescriptorSetCount(long struct)

Unsafe version of descriptorSetCount().

npSetLayouts

public static LongBuffer npSetLayouts(long struct)

Unsafe version of pSetLayouts.

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.

ndescriptorPool

public static void ndescriptorPool(long struct,
 long value)

Unsafe version of descriptorPool.

ndescriptorSetCount

public static void ndescriptorSetCount(long struct,
 int value)

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

npSetLayouts

public static void npSetLayouts(long struct,
 LongBuffer value)

Unsafe version of pSetLayouts.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate