VkDescriptorPoolSize (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkDescriptorPoolSize
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying descriptor pool size.
Description

Note

When creating a descriptor pool that will contain descriptors for combined image samplers of multi-planar formats, an application needs to account for non-trivial descriptor consumption when choosing the descriptorCount value, as indicated by VkSamplerYcbcrConversionImageFormatProperties::combinedImageSamplerDescriptorCount.

Valid Usage
- descriptorCount must be greater than 0
- If type is DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT then descriptorCount must be a multiple of 4
Valid Usage (Implicit)
- type must be a valid VkDescriptorType value
See Also

VkDescriptorPoolCreateInfo

Member documentation
- type – the type of descriptor.
- descriptorCount – the number of descriptors of that type to allocate. If type is DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT then descriptorCount is the number of bytes to allocate for descriptors of this type.
Layout
```
 struct VkDescriptorPoolSize {
     VkDescriptorType type;
     uint32_t descriptorCount;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkDescriptorPoolSize.Buffer
An array of VkDescriptorPoolSize 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`	`VkDescriptorPoolSize.Buffer` An array of `VkDescriptorPoolSize` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`DESCRIPTORCOUNT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`TYPE` 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
`VkDescriptorPoolSize(java.nio.ByteBuffer container)` Creates a `VkDescriptorPoolSize` 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 VkDescriptorPoolSize`	`calloc()` Returns a new `VkDescriptorPoolSize` instance allocated with `memCalloc`.
`static VkDescriptorPoolSize.Buffer`	`calloc(int capacity)` Returns a new `VkDescriptorPoolSize.Buffer` instance allocated with `memCalloc`.
`static VkDescriptorPoolSize`	`callocStack()` Returns a new `VkDescriptorPoolSize` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDescriptorPoolSize.Buffer`	`callocStack(int capacity)` Returns a new `VkDescriptorPoolSize.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDescriptorPoolSize.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDescriptorPoolSize.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDescriptorPoolSize`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkDescriptorPoolSize` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDescriptorPoolSize`	`create()` Returns a new `VkDescriptorPoolSize` instance allocated with `BufferUtils`.
`static VkDescriptorPoolSize.Buffer`	`create(int capacity)` Returns a new `VkDescriptorPoolSize.Buffer` instance allocated with `BufferUtils`.
`static VkDescriptorPoolSize`	`create(long address)` Returns a new `VkDescriptorPoolSize` instance for the specified memory address.
`static VkDescriptorPoolSize.Buffer`	`create(long address, int capacity)` Create a `VkDescriptorPoolSize.Buffer` instance at the specified memory.
`static VkDescriptorPoolSize`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkDescriptorPoolSize.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`descriptorCount()` Returns the value of the `descriptorCount` field.
`VkDescriptorPoolSize`	`descriptorCount(int value)` Sets the specified value to the `descriptorCount` field.
`static VkDescriptorPoolSize`	`malloc()` Returns a new `VkDescriptorPoolSize` instance allocated with `memAlloc`.
`static VkDescriptorPoolSize.Buffer`	`malloc(int capacity)` Returns a new `VkDescriptorPoolSize.Buffer` instance allocated with `memAlloc`.
`static VkDescriptorPoolSize`	`mallocStack()` Returns a new `VkDescriptorPoolSize` instance allocated on the thread-local `MemoryStack`.
`static VkDescriptorPoolSize.Buffer`	`mallocStack(int capacity)` Returns a new `VkDescriptorPoolSize.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkDescriptorPoolSize.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDescriptorPoolSize.Buffer` instance allocated on the specified `MemoryStack`.
`static VkDescriptorPoolSize`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkDescriptorPoolSize` instance allocated on the specified `MemoryStack`.
`static int`	`ndescriptorCount(long struct)` Unsafe version of `descriptorCount()`.
`static void`	`ndescriptorCount(long struct, int value)` Unsafe version of `descriptorCount`.
`static int`	`ntype(long struct)` Unsafe version of `type()`.
`static void`	`ntype(long struct, int value)` Unsafe version of `type`.
`VkDescriptorPoolSize`	`set(int type, int descriptorCount)` Initializes this struct with the specified values.
`VkDescriptorPoolSize`	`set(VkDescriptorPoolSize src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`type()` Returns the value of the `type` field.
`VkDescriptorPoolSize`	`type(int value)` Sets the specified value to the `type` field.

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.
  - TYPE
```
public static final int TYPE
```
    The struct member offsets.
  - DESCRIPTORCOUNT
```
public static final int DESCRIPTORCOUNT
```
    The struct member offsets.
- Constructor Detail
  - VkDescriptorPoolSize
```
public VkDescriptorPoolSize(java.nio.ByteBuffer container)
```
    Creates a VkDescriptorPoolSize 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
  - type
```
public int type()
```
    Returns the value of the type field.
  - descriptorCount
```
public int descriptorCount()
```
    Returns the value of the descriptorCount field.
  - type
```
public VkDescriptorPoolSize type(int value)
```
    Sets the specified value to the type field.
  - descriptorCount
```
public VkDescriptorPoolSize descriptorCount(int value)
```
    Sets the specified value to the descriptorCount field.
  - set
```
public VkDescriptorPoolSize set(int type,
                                int descriptorCount)
```
    Initializes this struct with the specified values.
  - set
```
public VkDescriptorPoolSize set(VkDescriptorPoolSize src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkDescriptorPoolSize malloc()
```
    Returns a new VkDescriptorPoolSize instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkDescriptorPoolSize calloc()
```
    Returns a new VkDescriptorPoolSize instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkDescriptorPoolSize create()
```
    Returns a new VkDescriptorPoolSize instance allocated with BufferUtils.
  - create
```
public static VkDescriptorPoolSize create(long address)
```
    Returns a new VkDescriptorPoolSize instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkDescriptorPoolSize createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkDescriptorPoolSize.Buffer malloc(int capacity)
```
    Returns a new VkDescriptorPoolSize.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkDescriptorPoolSize.Buffer calloc(int capacity)
```
    Returns a new VkDescriptorPoolSize.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDescriptorPoolSize.Buffer create(int capacity)
```
    Returns a new VkDescriptorPoolSize.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDescriptorPoolSize.Buffer create(long address,
                                                 int capacity)
```
    Create a VkDescriptorPoolSize.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkDescriptorPoolSize.Buffer createSafe(long address,
                                                               int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkDescriptorPoolSize mallocStack()
```
    Returns a new VkDescriptorPoolSize instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkDescriptorPoolSize callocStack()
```
    Returns a new VkDescriptorPoolSize instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkDescriptorPoolSize mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDescriptorPoolSize instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkDescriptorPoolSize callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDescriptorPoolSize instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkDescriptorPoolSize.Buffer mallocStack(int capacity)
```
    Returns a new VkDescriptorPoolSize.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDescriptorPoolSize.Buffer callocStack(int capacity)
```
    Returns a new VkDescriptorPoolSize.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkDescriptorPoolSize.Buffer mallocStack(int capacity,
                                                      org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDescriptorPoolSize.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDescriptorPoolSize.Buffer callocStack(int capacity,
                                                      org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDescriptorPoolSize.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
  - ntype
```
public static int ntype(long struct)
```
    Unsafe version of type().
  - ndescriptorCount
```
public static int ndescriptorCount(long struct)
```
    Unsafe version of descriptorCount().
  - ntype
```
public static void ntype(long struct,
                         int value)
```
    Unsafe version of type.
  - ndescriptorCount
```
public static void ndescriptorCount(long struct,
                                    int value)
```
    Unsafe version of descriptorCount.

Class VkDescriptorPoolSize

Description

Note

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

TYPE

DESCRIPTORCOUNT

Constructor Detail

VkDescriptorPoolSize

Method Detail

sizeof

type

descriptorCount

type

descriptorCount

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

ntype

ndescriptorCount

ntype

ndescriptorCount