VkDescriptorSetAllocateInfo (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkDescriptorSetAllocateInfo

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkDescriptorSetAllocateInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying the allocation parameters for descriptor sets.
Valid Usage
- Each element of pSetLayouts must not have been created with DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR set
- If any element of pSetLayouts was created with the DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT bit set, descriptorPool must have been created with the DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag set
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO
- pNext must be NULL or a pointer to a valid instance of VkDescriptorSetVariableDescriptorCountAllocateInfoEXT
- descriptorPool must be a valid VkDescriptorPool handle
- pSetLayouts must be a valid pointer to an array of descriptorSetCount valid VkDescriptorSetLayout handles
- descriptorSetCount must be greater than 0
- Both of descriptorPool, and the elements of pSetLayouts must have been created, allocated, or retrieved from the same VkDevice
See Also

AllocateDescriptorSets

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- descriptorPool – the pool which the sets will be allocated from.
- descriptorSetCount – determines the number of descriptor sets to be allocated from the pool.
- pSetLayouts – a pointer to an array of descriptor set layouts, with each member specifying how the corresponding descriptor set is allocated.
Layout
```
 struct VkDescriptorSetAllocateInfo {
     VkStructureType sType;
     void const * pNext;
     VkDescriptorPool descriptorPool;
     uint32_t descriptorSetCount;
     VkDescriptorSetLayout const * pSetLayouts;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkDescriptorSetAllocateInfo.Buffer
An array of VkDescriptorSetAllocateInfo structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`DESCRIPTORPOOL` The struct member offsets.
`static int`	`DESCRIPTORSETCOUNT` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`PSETLAYOUTS` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static 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 and Description
`VkDescriptorSetAllocateInfo(java.nio.ByteBuffer container)` Creates a `VkDescriptorSetAllocateInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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`	`callocStack()` Returns a new `VkDescriptorSetAllocateInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDescriptorSetAllocateInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkDescriptorSetAllocateInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDescriptorSetAllocateInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDescriptorSetAllocateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDescriptorSetAllocateInfo`	`callocStack(org.lwjgl.system.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 VkDescriptorSetAllocateInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkDescriptorSetAllocateInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`long`	`descriptorPool()` Returns the value of the `descriptorPool` field.
`VkDescriptorSetAllocateInfo`	`descriptorPool(long value)` Sets the specified value to the `descriptorPool` field.
`int`	`descriptorSetCount()` Returns the value of the `descriptorSetCount` field.
`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`	`mallocStack()` Returns a new `VkDescriptorSetAllocateInfo` instance allocated on the thread-local `MemoryStack`.
`static VkDescriptorSetAllocateInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkDescriptorSetAllocateInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkDescriptorSetAllocateInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDescriptorSetAllocateInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkDescriptorSetAllocateInfo`	`mallocStack(org.lwjgl.system.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 java.nio.LongBuffer`	`npSetLayouts(long struct)` Unsafe version of `pSetLayouts`.
`static void`	`npSetLayouts(long struct, java.nio.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()` Returns the value of the `pNext` field.
`VkDescriptorSetAllocateInfo`	`pNext(long value)` Sets the specified value to the `pNext` field.
`java.nio.LongBuffer`	`pSetLayouts()` Returns a `LongBuffer` view of the data pointed to by the `pSetLayouts` field.
`VkDescriptorSetAllocateInfo`	`pSetLayouts(java.nio.LongBuffer value)` Sets the address of the specified `LongBuffer` to the `pSetLayouts` field.
`VkDescriptorSetAllocateInfo`	`set(int sType, long pNext, long descriptorPool, java.nio.LongBuffer pSetLayouts)` Initializes this struct with the specified values.
`VkDescriptorSetAllocateInfo`	`set(VkDescriptorSetAllocateInfo src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkDescriptorSetAllocateInfo`	`sType(int value)` Sets the specified value to the `sType` field.
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

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 Detail
  - 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 Detail
  - VkDescriptorSetAllocateInfo
```
public VkDescriptorSetAllocateInfo(java.nio.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 Detail
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - descriptorPool
```
public long descriptorPool()
```
    Returns the value of the descriptorPool field.
  - descriptorSetCount
```
public int descriptorSetCount()
```
    Returns the value of the descriptorSetCount field.
  - pSetLayouts
```
public java.nio.LongBuffer pSetLayouts()
```
    Returns a LongBuffer view of the data pointed to by the pSetLayouts field.
  - sType
```
public VkDescriptorSetAllocateInfo sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkDescriptorSetAllocateInfo pNext(long value)
```
    Sets the specified value to the pNext field.
  - descriptorPool
```
public VkDescriptorSetAllocateInfo descriptorPool(long value)
```
    Sets the specified value to the descriptorPool field.
  - pSetLayouts
```
public VkDescriptorSetAllocateInfo pSetLayouts(java.nio.LongBuffer value)
```
    Sets the address of the specified LongBuffer to the pSetLayouts field.
  - set
```
public VkDescriptorSetAllocateInfo set(int sType,
                                       long pNext,
                                       long descriptorPool,
                                       java.nio.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
```
@Nullable
public static 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
```
@Nullable
public static VkDescriptorSetAllocateInfo.Buffer createSafe(long address,
                                                                      int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkDescriptorSetAllocateInfo mallocStack()
```
    Returns a new VkDescriptorSetAllocateInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkDescriptorSetAllocateInfo callocStack()
```
    Returns a new VkDescriptorSetAllocateInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkDescriptorSetAllocateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDescriptorSetAllocateInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkDescriptorSetAllocateInfo callocStack(org.lwjgl.system.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
  - mallocStack
```
public static VkDescriptorSetAllocateInfo.Buffer mallocStack(int capacity)
```
    Returns a new VkDescriptorSetAllocateInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDescriptorSetAllocateInfo.Buffer callocStack(int capacity)
```
    Returns a new VkDescriptorSetAllocateInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkDescriptorSetAllocateInfo.Buffer mallocStack(int capacity,
                                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDescriptorSetAllocateInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDescriptorSetAllocateInfo.Buffer callocStack(int capacity,
                                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDescriptorSetAllocateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - 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 java.nio.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,
                                java.nio.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
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class VkDescriptorSetAllocateInfo

Valid Usage

Valid Usage (Implicit)

See Also

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

DESCRIPTORPOOL

DESCRIPTORSETCOUNT

PSETLAYOUTS

Constructor Detail

VkDescriptorSetAllocateInfo

Method Detail

sizeof

sType

pNext

descriptorPool

descriptorSetCount

pSetLayouts

sType

pNext

descriptorPool

pSetLayouts

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

ndescriptorPool

ndescriptorSetCount

npSetLayouts

nsType

npNext

ndescriptorPool

ndescriptorSetCount

npSetLayouts

validate

validate