Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDescriptorPoolSize

extends Struct<VkDescriptorPoolSize>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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
Valid Usage (Implicit)
See Also

VkDescriptorPoolCreateInfo

Layout


struct VkDescriptorPoolSize {
    VkDescriptorType type;
    uint32_t descriptorCount;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DESCRIPTORCOUNT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkDescriptorPoolSize(long address, ByteBuffer container)

public
VkDescriptorPoolSize(ByteBuffer container)

Creates a VkDescriptorPoolSize instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkDescriptorPoolSize
calloc()

Returns a new VkDescriptorPoolSize instance allocated with memCalloc.

public static VkDescriptorPoolSize.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkDescriptorPoolSize.Buffer instance allocated with memCalloc.

public static VkDescriptorPoolSize
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkDescriptorPoolSize.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkDescriptorPoolSize
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkDescriptorPoolSize
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDescriptorPoolSize.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDescriptorPoolSize.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkDescriptorPoolSize
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkDescriptorPoolSize
create()

Returns a new VkDescriptorPoolSize instance allocated with BufferUtils.

public static VkDescriptorPoolSize
create(long address)

Returns a new VkDescriptorPoolSize instance for the specified memory address.

public static VkDescriptorPoolSize.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkDescriptorPoolSize.Buffer instance allocated with BufferUtils.

public static VkDescriptorPoolSize.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkDescriptorPoolSize.Buffer instance at the specified memory.

public static VkDescriptorPoolSize
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkDescriptorPoolSize.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public int
descriptorCount()

the number of descriptors of that type to allocate.

public VkDescriptorPoolSize
descriptorCount(int value)

Sets the specified value to the descriptorCount field.

public static VkDescriptorPoolSize
malloc()

Returns a new VkDescriptorPoolSize instance allocated with memAlloc.

public static VkDescriptorPoolSize.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkDescriptorPoolSize.Buffer instance allocated with memAlloc.

public static VkDescriptorPoolSize
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkDescriptorPoolSize instance allocated on the specified MemoryStack.

public static VkDescriptorPoolSize.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkDescriptorPoolSize
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkDescriptorPoolSize
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDescriptorPoolSize.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDescriptorPoolSize.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
ndescriptorCount(long struct)

Unsafe version of descriptorCount.

public static void
ndescriptorCount(long struct, int value)

Unsafe version of descriptorCount.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public VkDescriptorPoolSize
set(int type, int descriptorCount)

Initializes this struct with the specified values.

public VkDescriptorPoolSize

Returns:

this struct
set
(VkDescriptorPoolSize
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
type()

the type of descriptor.

public VkDescriptorPoolSize
type(int value)

Sets the specified value to the type field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

DESCRIPTORCOUNTback to summary
public static final int DESCRIPTORCOUNT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

VkDescriptorPoolSizeback to summary
protected VkDescriptorPoolSize(long address, ByteBuffer container)
VkDescriptorPoolSizeback to summary
public VkDescriptorPoolSize(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

callocback to summary
public static VkDescriptorPoolSize calloc()

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

callocback to summary
public static VkDescriptorPoolSize.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkDescriptorPoolSize calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkDescriptorPoolSize.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkDescriptorPoolSize callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkDescriptorPoolSize callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkDescriptorPoolSize.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkDescriptorPoolSize.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected VkDescriptorPoolSize create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkDescriptorPoolSize create()

Returns a new VkDescriptorPoolSize instance allocated with BufferUtils.

createback to summary
public static VkDescriptorPoolSize create(long address)

Returns a new VkDescriptorPoolSize instance for the specified memory address.

createback to summary
public static VkDescriptorPoolSize.Buffer create(int capacity)

Returns a new VkDescriptorPoolSize.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkDescriptorPoolSize.Buffer create(long address, int capacity)

Create a VkDescriptorPoolSize.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDescriptorPoolSize createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkDescriptorPoolSize.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
descriptorCountback to summary
public int descriptorCount()

the number of descriptors of that type to allocate. If type is DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK then descriptorCount is the number of bytes to allocate for descriptors of this type.

Annotations
@NativeType:uint32_t
descriptorCountback to summary
public VkDescriptorPoolSize descriptorCount(int value)

Sets the specified value to the descriptorCount field.

mallocback to summary
public static VkDescriptorPoolSize malloc()

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

mallocback to summary
public static VkDescriptorPoolSize.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDescriptorPoolSize malloc(MemoryStack stack)

Returns a new VkDescriptorPoolSize instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkDescriptorPoolSize.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkDescriptorPoolSize mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkDescriptorPoolSize mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkDescriptorPoolSize.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkDescriptorPoolSize.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
ndescriptorCountback to summary
public static int ndescriptorCount(long struct)

Unsafe version of descriptorCount.

ndescriptorCountback to summary
public static void ndescriptorCount(long struct, int value)

Unsafe version of descriptorCount.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

ntypeback to summary
public static void ntype(long struct, int value)

Unsafe version of type.

setback to summary
public VkDescriptorPoolSize set(int type, int descriptorCount)

Initializes this struct with the specified values.

setback to summary
public VkDescriptorPoolSize set(VkDescriptorPoolSize src)

Copies the specified struct data to this struct.

Parameters
src:VkDescriptorPoolSize

the source struct

Returns:VkDescriptorPoolSize

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
typeback to summary
public int type()

the type of descriptor.

Annotations
@NativeType:VkDescriptorType
typeback to summary
public VkDescriptorPoolSize type(int value)

Sets the specified value to the type field.

org.lwjgl.vulkan back to summary

public Class VkDescriptorPoolSize.Buffer

extends StructBuffer<VkDescriptorPoolSize, VkDescriptorPoolSize.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkDescriptorPoolSize structs.

Field Summary

Modifier and TypeField and Description
private static final VkDescriptorPoolSize

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkDescriptorPoolSize.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the VkDescriptorPoolSize#descriptorCount field.
descriptorCount
()

public VkDescriptorPoolSize.Buffer
descriptorCount(int value)

Sets the specified value to the VkDescriptorPoolSize#descriptorCount field.

protected VkDescriptorPoolSize
protected VkDescriptorPoolSize.Buffer
public int

Returns:

the value of the VkDescriptorPoolSize#type field.
type
()

public VkDescriptorPoolSize.Buffer
type(int value)

Sets the specified value to the VkDescriptorPoolSize#type field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDescriptorPoolSize ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkDescriptorPoolSize.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkDescriptorPoolSize#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

descriptorCountback to summary
public int descriptorCount()
Returns:int

the value of the VkDescriptorPoolSize#descriptorCount field.

Annotations
@NativeType:uint32_t
descriptorCountback to summary
public VkDescriptorPoolSize.Buffer descriptorCount(int value)

Sets the specified value to the VkDescriptorPoolSize#descriptorCount field.

getElementFactoryback to summary
protected VkDescriptorPoolSize getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
selfback to summary
protected VkDescriptorPoolSize.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the VkDescriptorPoolSize#type field.

Annotations
@NativeType:VkDescriptorType
typeback to summary
public VkDescriptorPoolSize.Buffer type(int value)

Sets the specified value to the VkDescriptorPoolSize#type field.