LWJGL 3.3.3 · org.lwjgl.vulkan.VkDescriptorSetVariableDescriptorCountLayoutSupport

Structure returning information about whether a descriptor set layout can be supported.

Description

If the VkDescriptorSetLayoutCreateInfo structure specified in GetDescriptorSetLayoutSupport::pCreateInfo includes a variable-sized descriptor, then supported is determined assuming the requested size of the variable-sized descriptor, and maxVariableDescriptorCount is set to the maximum size of that descriptor that can be successfully created (which is greater than or equal to the requested size passed in). If the VkDescriptorSetLayoutCreateInfo structure does not include a variable-sized descriptor, or if the VkPhysicalDeviceDescriptorIndexingFeatures::descriptorBindingVariableDescriptorCount feature is not enabled, then maxVariableDescriptorCount is set to zero. For the purposes of this command, a variable-sized descriptor binding with a descriptorCount of zero is treated as having a descriptorCount of four if descriptorType is DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK, or one otherwise, and thus the binding is not ignored and the maximum descriptor count will be returned. If the layout is not supported, then the value written to maxVariableDescriptorCount is undefined.

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_DESCRIPTOR_SET_VARIABLE_DESCRIPTOR_COUNT_LAYOUT_SUPPORT

Layout


struct VkDescriptorSetVariableDescriptorCountLayoutSupport {
    VkStructureType sType;
    void * pNext;
    uint32_t maxVariableDescriptorCount;
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer An array of `VkDescriptorSetVariableDescriptorCountLayoutSupport` structs.

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	MAXVARIABLEDESCRIPTORCOUNT The struct member offsets.
public static final int	PNEXT The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	STYPE The struct member offsets.

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	VkDescriptorSetVariableDescriptorCountLayoutSupport(long address, ByteBuffer container)
public	VkDescriptorSetVariableDescriptorCountLayoutSupport(ByteBuffer container) Creates a `VkDescriptorSetVariableDescriptorCountLayoutSupport` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkDescriptorSetVariableDescriptorCountLayoutSupport	calloc() Returns a new `VkDescriptorSetVariableDescriptorCountLayoutSupport` instance allocated with `memCalloc`.
public static VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer` instance allocated with `memCalloc`.
public static VkDescriptorSetVariableDescriptorCountLayoutSupport	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkDescriptorSetVariableDescriptorCountLayoutSupport` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected VkDescriptorSetVariableDescriptorCountLayoutSupport	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 VkDescriptorSetVariableDescriptorCountLayoutSupport	create() Returns a new `VkDescriptorSetVariableDescriptorCountLayoutSupport` instance allocated with `BufferUtils`.
public static VkDescriptorSetVariableDescriptorCountLayoutSupport	create(long address) Returns a new `VkDescriptorSetVariableDescriptorCountLayoutSupport` instance for the specified memory address.
public static VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer	create(int the buffer capacity capacity) Returns a new `VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer` instance allocated with `BufferUtils`.
public static VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer` instance at the specified memory.
public static VkDescriptorSetVariableDescriptorCountLayoutSupport	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static VkDescriptorSetVariableDescriptorCountLayoutSupport	malloc() Returns a new `VkDescriptorSetVariableDescriptorCountLayoutSupport` instance allocated with `memAlloc`.
public static VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer` instance allocated with `memAlloc`.
public static VkDescriptorSetVariableDescriptorCountLayoutSupport	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkDescriptorSetVariableDescriptorCountLayoutSupport` instance allocated on the specified `MemoryStack`.
public static VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer` instance allocated on the specified `MemoryStack`.
public int	maxVariableDescriptorCount() indicates the maximum number of descriptors supported in the highest numbered binding of the layout, if that binding is variable-sized.
public static int	nmaxVariableDescriptorCount(long struct) Unsafe version of `maxVariableDescriptorCount`.
public static long	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, long value) Unsafe version of `pNext`.
public static int	nsType(long struct) Unsafe version of `sType`.
public static void	nsType(long struct, int value) Unsafe version of `sType`.
public long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkDescriptorSetVariableDescriptorCountLayoutSupport	pNext(long value) Sets the specified value to the `pNext` field.
public VkDescriptorSetVariableDescriptorCountLayoutSupport	set(int sType, long pNext) Initializes this struct with the specified values.
public VkDescriptorSetVariableDescriptorCountLayoutSupport	Returns: this struct set(VkDescriptorSetVariableDescriptorCountLayoutSupport 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	sType() a `VkStructureType` value identifying this structure.
public VkDescriptorSetVariableDescriptorCountLayoutSupport	sType(int value) Sets the specified value to the `sType` field.
public VkDescriptorSetVariableDescriptorCountLayoutSupport	sType$Default() Sets the `STRUCTURE_TYPE_DESCRIPTOR_SET_VARIABLE_DESCRIPTOR_COUNT_LAYOUT_SUPPORT` value to the `sType` field.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

MAXVARIABLEDESCRIPTORCOUNT	back to summary
public static final int MAXVARIABLEDESCRIPTORCOUNT The struct member offsets.

PNEXT	back to summary
public static final int PNEXT The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

STYPE	back to summary
public static final int STYPE The struct member offsets.

Constructor Detail

VkDescriptorSetVariableDescriptorCountLayoutSupport	back to summary
protected VkDescriptorSetVariableDescriptorCountLayoutSupport(long address, ByteBuffer container)

VkDescriptorSetVariableDescriptorCountLayoutSupport back to summary

VkDescriptorSetVariableDescriptorCountLayoutSupport	back to summary
public VkDescriptorSetVariableDescriptorCountLayoutSupport(ByteBuffer container) Creates a `VkDescriptorSetVariableDescriptorCountLayoutSupport` 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.

public VkDescriptorSetVariableDescriptorCountLayoutSupport(ByteBuffer container)

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

calloc	back to summary
public static VkDescriptorSetVariableDescriptorCountLayoutSupport calloc() Returns a new `VkDescriptorSetVariableDescriptorCountLayoutSupport` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer calloc(int capacity) Returns a new `VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static VkDescriptorSetVariableDescriptorCountLayoutSupport calloc(MemoryStack stack) Returns a new `VkDescriptorSetVariableDescriptorCountLayoutSupport` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkDescriptorSetVariableDescriptorCountLayoutSupport calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkDescriptorSetVariableDescriptorCountLayoutSupport.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

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

Returns a new VkDescriptorSetVariableDescriptorCountLayoutSupport.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

create back to summary

create	back to summary
protected VkDescriptorSetVariableDescriptorCountLayoutSupport 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

protected VkDescriptorSetVariableDescriptorCountLayoutSupport 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

create	back to summary
public static VkDescriptorSetVariableDescriptorCountLayoutSupport create() Returns a new `VkDescriptorSetVariableDescriptorCountLayoutSupport` instance allocated with `BufferUtils`.

create	back to summary
public static VkDescriptorSetVariableDescriptorCountLayoutSupport create(long address) Returns a new `VkDescriptorSetVariableDescriptorCountLayoutSupport` instance for the specified memory address.

create back to summary

create	back to summary
public static VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer create(int capacity) Returns a new `VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer create(int capacity)

Returns a new VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer create(long address, int capacity) Create a `VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkDescriptorSetVariableDescriptorCountLayoutSupport createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkDescriptorSetVariableDescriptorCountLayoutSupport createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

malloc	back to summary
public static VkDescriptorSetVariableDescriptorCountLayoutSupport malloc() Returns a new `VkDescriptorSetVariableDescriptorCountLayoutSupport` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer malloc(int capacity) Returns a new `VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static VkDescriptorSetVariableDescriptorCountLayoutSupport malloc(MemoryStack stack) Returns a new `VkDescriptorSetVariableDescriptorCountLayoutSupport` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkDescriptorSetVariableDescriptorCountLayoutSupport malloc(MemoryStack stack)

Returns a new VkDescriptorSetVariableDescriptorCountLayoutSupport instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

maxVariableDescriptorCount back to summary

maxVariableDescriptorCount	back to summary
public int maxVariableDescriptorCount() indicates the maximum number of descriptors supported in the highest numbered binding of the layout, if that binding is variable-sized. If the highest numbered binding of the layout has a descriptor type of `DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK` then `maxVariableDescriptorCount` indicates the maximum byte size supported for the binding, if that binding is variable-sized. Annotations @NativeType:uint32_t

public int maxVariableDescriptorCount()

indicates the maximum number of descriptors supported in the highest numbered binding of the layout, if that binding is variable-sized. If the highest numbered binding of the layout has a descriptor type of DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK then maxVariableDescriptorCount indicates the maximum byte size supported for the binding, if that binding is variable-sized.

Annotations

@NativeType:uint32_t

nmaxVariableDescriptorCount	back to summary
public static int nmaxVariableDescriptorCount(long struct) Unsafe version of `maxVariableDescriptorCount`.

npNext	back to summary
public static long npNext(long struct) Unsafe version of `pNext`.

npNext	back to summary
public static void npNext(long struct, long value) Unsafe version of `pNext`.

nsType	back to summary
public static int nsType(long struct) Unsafe version of `sType`.

nsType	back to summary
public static void nsType(long struct, int value) Unsafe version of `sType`.

pNext back to summary

pNext	back to summary
public long pNext() `NULL` or a pointer to a structure extending this structure. Annotations @NativeType:void *

public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations

@NativeType:void *

pNext	back to summary
public VkDescriptorSetVariableDescriptorCountLayoutSupport pNext(long value) Sets the specified value to the `pNext` field.

set	back to summary
public VkDescriptorSetVariableDescriptorCountLayoutSupport set(int sType, long pNext) Initializes this struct with the specified values.

set	back to summary
public VkDescriptorSetVariableDescriptorCountLayoutSupport set(VkDescriptorSetVariableDescriptorCountLayoutSupport src) Copies the specified struct data to this struct. Parameters src:VkDescriptorSetVariableDescriptorCountLayoutSupport the source struct Returns:VkDescriptorSetVariableDescriptorCountLayoutSupport this struct

set

back to summary

public VkDescriptorSetVariableDescriptorCountLayoutSupport set(VkDescriptorSetVariableDescriptorCountLayoutSupport src)

Copies the specified struct data to this struct.

Parameters

src:VkDescriptorSetVariableDescriptorCountLayoutSupport: the source struct

Returns:VkDescriptorSetVariableDescriptorCountLayoutSupport

this struct

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

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

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

Returns sizeof(struct).

Annotations

@Override

sType back to summary

sType	back to summary
public int sType() a `VkStructureType` value identifying this structure. Annotations @NativeType:VkStructureType

public int sType()

a VkStructureType value identifying this structure.

Annotations

@NativeType:VkStructureType

sType	back to summary
public VkDescriptorSetVariableDescriptorCountLayoutSupport sType(int value) Sets the specified value to the `sType` field.

sType$Default	back to summary
public VkDescriptorSetVariableDescriptorCountLayoutSupport sType$Default() Sets the `STRUCTURE_TYPE_DESCRIPTOR_SET_VARIABLE_DESCRIPTOR_COUNT_LAYOUT_SUPPORT` value to the `sType` field.

Modifier and Type	Method and Description
protected VkDescriptorSetVariableDescriptorCountLayoutSupport	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public int	Returns: the value of the `VkDescriptorSetVariableDescriptorCountLayoutSupport#maxVariableDescriptorCount` field. maxVariableDescriptorCount()
public long	Returns: the value of the `VkDescriptorSetVariableDescriptorCountLayoutSupport#pNext` field. pNext()
public VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer	pNext(long value) Sets the specified value to the `VkDescriptorSetVariableDescriptorCountLayoutSupport#pNext` field.
protected VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkDescriptorSetVariableDescriptorCountLayoutSupport#sType` field. sType()
public VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer	sType(int value) Sets the specified value to the `VkDescriptorSetVariableDescriptorCountLayoutSupport#sType` field.
public VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer	sType$Default() Sets the `STRUCTURE_TYPE_DESCRIPTOR_SET_VARIABLE_DESCRIPTOR_COUNT_LAYOUT_SUPPORT` value to the `VkDescriptorSetVariableDescriptorCountLayoutSupport#sType` field.

public Class VkDescriptorSetVariableDescriptorCountLayoutSupport

Description

Valid Usage (Implicit)

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VkDescriptorSetVariableDescriptorCountLayoutSupport.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkDescriptorSetVariableDescriptorCountLayoutSupport.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)