Structure specifying a descriptor set layout binding.

Description

The above layout definition allows the descriptor bindings to be specified sparsely such that not all binding numbers between 0 and the maximum binding number need to be specified in the pBindings array. Bindings that are not specified have a descriptorCount and stageFlags of zero, and the value of descriptorType is undefined. However, all binding numbers between 0 and the maximum binding number in the VkDescriptorSetLayoutCreateInfo::pBindings array may consume memory in the descriptor set layout even if not all descriptor bindings are used, though it should not consume additional memory from the descriptor pool.

Note

The maximum binding number specified should be as compact as possible to avoid wasted memory.

Valid Usage

If descriptorType is DESCRIPTOR_TYPE_SAMPLER or DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, and descriptorCount is not 0 and pImmutableSamplers is not NULL, pImmutableSamplers must be a valid pointer to an array of descriptorCount valid VkSampler handles
If the inlineUniformBlock feature is not enabled, descriptorType must not be DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK
If descriptorType is DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK then descriptorCount must be a multiple of 4
If descriptorType is DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK and VkDescriptorSetLayoutCreateInfo::flags does not contain DESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT then descriptorCount must be less than or equal to VkPhysicalDeviceInlineUniformBlockPropertiesEXT::maxInlineUniformBlockSize
If VkDescriptorSetLayoutCreateInfo::flags contains DESCRIPTOR_SET_LAYOUT_CREATE_EMBEDDED_IMMUTABLE_SAMPLERS_BIT_EXT, descriptorType must be DESCRIPTOR_TYPE_SAMPLER
If VkDescriptorSetLayoutCreateInfo::flags contains DESCRIPTOR_SET_LAYOUT_CREATE_EMBEDDED_IMMUTABLE_SAMPLERS_BIT_EXT, descriptorCount must less than or equal to 1
If VkDescriptorSetLayoutCreateInfo::flags contains DESCRIPTOR_SET_LAYOUT_CREATE_EMBEDDED_IMMUTABLE_SAMPLERS_BIT_EXT, and descriptorCount is equal to 1, pImmutableSamplers must not be NULL
If descriptorCount is not 0, stageFlags must be a valid combination of VkShaderStageFlagBits values
If descriptorType is DESCRIPTOR_TYPE_INPUT_ATTACHMENT and descriptorCount is not 0, then stageFlags must be 0 or SHADER_STAGE_FRAGMENT_BIT
The sampler objects indicated by pImmutableSamplers must not have a borderColor with one of the values BORDER_COLOR_FLOAT_CUSTOM_EXT or BORDER_COLOR_INT_CUSTOM_EXT
If descriptorType is DESCRIPTOR_TYPE_MUTABLE_EXT, then pImmutableSamplers must be NULL

Valid Usage (Implicit)

descriptorType must be a valid VkDescriptorType value

Layout


struct VkDescriptorSetLayoutBinding {
    uint32_t binding;
    VkDescriptorType descriptorType;
    uint32_t descriptorCount;
    VkShaderStageFlags stageFlags;
    VkSampler const * pImmutableSamplers;
}

Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	BINDING The struct member offsets.
public static final int	DESCRIPTORCOUNT The struct member offsets.
public static final int	DESCRIPTORTYPE The struct member offsets.
public static final int	PIMMUTABLESAMPLERS The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	STAGEFLAGS The struct member offsets.

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

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
public int	binding() the binding number of this entry and corresponds to a resource of the same binding number in the shader stages.
public VkDescriptorSetLayoutBinding	binding(int value) Sets the specified value to the `binding` field.
public static VkDescriptorSetLayoutBinding	calloc() Returns a new `VkDescriptorSetLayoutBinding` instance allocated with `memCalloc`.
public static VkDescriptorSetLayoutBinding.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkDescriptorSetLayoutBinding.Buffer` instance allocated with `memCalloc`.
public static VkDescriptorSetLayoutBinding	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkDescriptorSetLayoutBinding` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkDescriptorSetLayoutBinding.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkDescriptorSetLayoutBinding.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkDescriptorSetLayoutBinding	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkDescriptorSetLayoutBinding	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkDescriptorSetLayoutBinding.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkDescriptorSetLayoutBinding.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkDescriptorSetLayoutBinding	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 VkDescriptorSetLayoutBinding	create() Returns a new `VkDescriptorSetLayoutBinding` instance allocated with `BufferUtils`.
public static VkDescriptorSetLayoutBinding	create(long address) Returns a new `VkDescriptorSetLayoutBinding` instance for the specified memory address.
public static VkDescriptorSetLayoutBinding.Buffer	create(int the buffer capacity capacity) Returns a new `VkDescriptorSetLayoutBinding.Buffer` instance allocated with `BufferUtils`.
public static VkDescriptorSetLayoutBinding.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkDescriptorSetLayoutBinding.Buffer` instance at the specified memory.
public static VkDescriptorSetLayoutBinding	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkDescriptorSetLayoutBinding.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	descriptorCount() the number of descriptors contained in the binding, accessed in a shader as an array, except if `descriptorType` is `DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK` in which case `descriptorCount` is the size in bytes of the inline uniform block.
public VkDescriptorSetLayoutBinding	descriptorCount(int value) Sets the specified value to the `descriptorCount` field.
public int	descriptorType() a `VkDescriptorType` specifying which type of resource descriptors are used for this binding.
public VkDescriptorSetLayoutBinding	descriptorType(int value) Sets the specified value to the `descriptorType` field.
public static VkDescriptorSetLayoutBinding	malloc() Returns a new `VkDescriptorSetLayoutBinding` instance allocated with `memAlloc`.
public static VkDescriptorSetLayoutBinding.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkDescriptorSetLayoutBinding.Buffer` instance allocated with `memAlloc`.
public static VkDescriptorSetLayoutBinding	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkDescriptorSetLayoutBinding` instance allocated on the specified `MemoryStack`.
public static VkDescriptorSetLayoutBinding.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkDescriptorSetLayoutBinding.Buffer` instance allocated on the specified `MemoryStack`.
public static VkDescriptorSetLayoutBinding	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkDescriptorSetLayoutBinding	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkDescriptorSetLayoutBinding.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkDescriptorSetLayoutBinding.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static int	nbinding(long struct) Unsafe version of `binding`.
public static void	nbinding(long struct, int value) Unsafe version of `binding`.
public static int	ndescriptorCount(long struct) Unsafe version of `descriptorCount`.
public static void	ndescriptorCount(long struct, int value) Sets the specified value to the `descriptorCount` field of the specified `struct`.
public static int	ndescriptorType(long struct) Unsafe version of `descriptorType`.
public static void	ndescriptorType(long struct, int value) Unsafe version of `descriptorType`.
public static LongBuffer	npImmutableSamplers(long struct) Unsafe version of `pImmutableSamplers`.
public static void	npImmutableSamplers(long struct, LongBuffer value) Unsafe version of `pImmutableSamplers`.
public static int	nstageFlags(long struct) Unsafe version of `stageFlags`.
public static void	nstageFlags(long struct, int value) Unsafe version of `stageFlags`.
public LongBuffer	pImmutableSamplers() affects initialization of samplers.
public VkDescriptorSetLayoutBinding	pImmutableSamplers(LongBuffer value) Sets the address of the specified `LongBuffer` to the `pImmutableSamplers` field.
public VkDescriptorSetLayoutBinding	set(int binding, int descriptorType, int descriptorCount, int stageFlags, LongBuffer pImmutableSamplers) Initializes this struct with the specified values.
public VkDescriptorSetLayoutBinding	Returns: this struct set(VkDescriptorSetLayoutBinding 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	stageFlags() member is a bitmask of `VkShaderStageFlagBits` specifying which pipeline shader stages can access a resource for this binding.
public VkDescriptorSetLayoutBinding	stageFlags(int value) Sets the specified value to the `stageFlags` field.

Field Detail

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

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

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

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

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

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

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

Constructor Detail

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

VkDescriptorSetLayoutBinding back to summary

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

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

binding	back to summary
public int binding() the binding number of this entry and corresponds to a resource of the same binding number in the shader stages. Annotations @NativeType:uint32_t

binding

back to summary

public int binding()

the binding number of this entry and corresponds to a resource of the same binding number in the shader stages.

Annotations

@NativeType:uint32_t

binding	back to summary
public VkDescriptorSetLayoutBinding binding(int value) Sets the specified value to the `binding` field.

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

calloc back to summary

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

public static VkDescriptorSetLayoutBinding.Buffer calloc(int capacity)

Returns a new VkDescriptorSetLayoutBinding.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 VkDescriptorSetLayoutBinding calloc(MemoryStack stack) Returns a new `VkDescriptorSetLayoutBinding` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkDescriptorSetLayoutBinding calloc(MemoryStack stack)

Returns a new VkDescriptorSetLayoutBinding 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 VkDescriptorSetLayoutBinding.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkDescriptorSetLayoutBinding.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 VkDescriptorSetLayoutBinding.Buffer calloc(int capacity, MemoryStack stack)

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

callocStack back to summary

callocStack	back to summary
public static VkDescriptorSetLayoutBinding callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkDescriptorSetLayoutBinding callocStack()

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkDescriptorSetLayoutBinding callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkDescriptorSetLayoutBinding callocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkDescriptorSetLayoutBinding.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkDescriptorSetLayoutBinding.Buffer callocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkDescriptorSetLayoutBinding.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkDescriptorSetLayoutBinding.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

create back to summary

create	back to summary
protected VkDescriptorSetLayoutBinding 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 VkDescriptorSetLayoutBinding 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 VkDescriptorSetLayoutBinding create() Returns a new `VkDescriptorSetLayoutBinding` instance allocated with `BufferUtils`.

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

create back to summary

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

public static VkDescriptorSetLayoutBinding.Buffer create(int capacity)

Returns a new VkDescriptorSetLayoutBinding.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

Create a VkDescriptorSetLayoutBinding.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 VkDescriptorSetLayoutBinding createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkDescriptorSetLayoutBinding createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

descriptorCount back to summary

descriptorCount	back to summary
public int descriptorCount() the number of descriptors contained in the binding, accessed in a shader as an array, except if `descriptorType` is `DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK` in which case `descriptorCount` is the size in bytes of the inline uniform block. If `descriptorCount` is zero this binding entry is reserved and the resource must not be accessed from any stage via this binding within any pipeline using the set layout. Annotations @NativeType:uint32_t

public int descriptorCount()

the number of descriptors contained in the binding, accessed in a shader as an array, except if descriptorType is DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK in which case descriptorCount is the size in bytes of the inline uniform block. If descriptorCount is zero this binding entry is reserved and the resource must not be accessed from any stage via this binding within any pipeline using the set layout.

Annotations

@NativeType:uint32_t

descriptorCount	back to summary
public VkDescriptorSetLayoutBinding descriptorCount(int value) Sets the specified value to the `descriptorCount` field.

descriptorType back to summary

descriptorType	back to summary
public int descriptorType() a `VkDescriptorType` specifying which type of resource descriptors are used for this binding. Annotations @NativeType:VkDescriptorType

public int descriptorType()

a VkDescriptorType specifying which type of resource descriptors are used for this binding.

Annotations

@NativeType:VkDescriptorType

descriptorType	back to summary
public VkDescriptorSetLayoutBinding descriptorType(int value) Sets the specified value to the `descriptorType` field.

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

malloc back to summary

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

public static VkDescriptorSetLayoutBinding.Buffer malloc(int capacity)

Returns a new VkDescriptorSetLayoutBinding.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 VkDescriptorSetLayoutBinding malloc(MemoryStack stack) Returns a new `VkDescriptorSetLayoutBinding` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkDescriptorSetLayoutBinding malloc(MemoryStack stack)

Returns a new VkDescriptorSetLayoutBinding 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 VkDescriptorSetLayoutBinding.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkDescriptorSetLayoutBinding.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

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

mallocStack back to summary

mallocStack	back to summary
public static VkDescriptorSetLayoutBinding mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkDescriptorSetLayoutBinding mallocStack()

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkDescriptorSetLayoutBinding mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkDescriptorSetLayoutBinding mallocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkDescriptorSetLayoutBinding.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkDescriptorSetLayoutBinding.Buffer mallocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkDescriptorSetLayoutBinding.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkDescriptorSetLayoutBinding.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

nbinding	back to summary
public static int nbinding(long struct) Unsafe version of `binding`.

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

ndescriptorCount	back to summary
public static int ndescriptorCount(long struct) Unsafe version of `descriptorCount`.

ndescriptorCount	back to summary
public static void ndescriptorCount(long struct, int value) Sets the specified value to the `descriptorCount` field of the specified `struct`.

ndescriptorType	back to summary
public static int ndescriptorType(long struct) Unsafe version of `descriptorType`.

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

npImmutableSamplers back to summary

npImmutableSamplers	back to summary
public static LongBuffer npImmutableSamplers(long struct) Unsafe version of `pImmutableSamplers`. Annotations @Nullable

public static LongBuffer npImmutableSamplers(long struct)

Unsafe version of pImmutableSamplers.

Annotations

@Nullable

npImmutableSamplers	back to summary
public static void npImmutableSamplers(long struct, LongBuffer value) Unsafe version of `pImmutableSamplers`.

nstageFlags	back to summary
public static int nstageFlags(long struct) Unsafe version of `stageFlags`.

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

pImmutableSamplers back to summary

public LongBuffer pImmutableSamplers()

affects initialization of samplers. If descriptorType specifies a DESCRIPTOR_TYPE_SAMPLER or DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER type descriptor, then pImmutableSamplers can be used to initialize a set of immutable samplers. Immutable samplers are permanently bound into the set layout and must not be changed; updating a DESCRIPTOR_TYPE_SAMPLER descriptor with immutable samplers is not allowed and updates to a DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER descriptor with immutable samplers does not modify the samplers (the image views are updated, but the sampler updates are ignored). If pImmutableSamplers is not NULL, then it is a pointer to an array of sampler handles that will be copied into the set layout and used for the corresponding binding. Only the sampler handles are copied; the sampler objects must not be destroyed before the final use of the set layout and any descriptor pools and sets created using it. If pImmutableSamplers is NULL, then the sampler slots are dynamic and sampler handles must be bound into descriptor sets using this layout. If descriptorType is not one of these descriptor types, then pImmutableSamplers is ignored.

Annotations

@Nullable
@NativeType:VkSampler const *

pImmutableSamplers	back to summary
public VkDescriptorSetLayoutBinding pImmutableSamplers(LongBuffer value) Sets the address of the specified `LongBuffer` to the `pImmutableSamplers` field.

set	back to summary
public VkDescriptorSetLayoutBinding set(int binding, int descriptorType, int descriptorCount, int stageFlags, LongBuffer pImmutableSamplers) Initializes this struct with the specified values.

set

back to summary

public VkDescriptorSetLayoutBinding set(VkDescriptorSetLayoutBinding src)

Copies the specified struct data to this struct.

Parameters

src:VkDescriptorSetLayoutBinding: the source struct

Returns:VkDescriptorSetLayoutBinding

this struct

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

stageFlags back to summary

public int stageFlags()

member is a bitmask of VkShaderStageFlagBits specifying which pipeline shader stages can access a resource for this binding. SHADER_STAGE_ALL is a shorthand specifying that all defined shader stages, including any additional stages defined by extensions, can access the resource.

If a shader stage is not included in stageFlags, then a resource must not be accessed from that stage via this binding within any pipeline using the set layout. Other than input attachments which are limited to the fragment shader, there are no limitations on what combinations of stages can use a descriptor binding, and in particular a binding can be used by both graphics stages and the compute stage.

Annotations

@NativeType:VkShaderStageFlags

stageFlags	back to summary
public VkDescriptorSetLayoutBinding stageFlags(int value) Sets the specified value to the `stageFlags` field.

org.lwjgl.vulkan back to summary

public Class VkDescriptorSetLayoutBinding.Buffer

Class Inheritance

extends StructBuffer<VkDescriptorSetLayoutBinding, VkDescriptorSetLayoutBinding.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkDescriptorSetLayoutBinding.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkDescriptorSetLayoutBinding structs.

Field Summary

Modifier and Type	Field and Description
private static final VkDescriptorSetLayoutBinding	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkDescriptorSetLayoutBinding.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 Type	Method and Description
public int	Returns: the value of the `VkDescriptorSetLayoutBinding#binding` field. binding()
public VkDescriptorSetLayoutBinding.Buffer	binding(int value) Sets the specified value to the `VkDescriptorSetLayoutBinding#binding` field.
public int	Returns: the value of the `VkDescriptorSetLayoutBinding#descriptorCount` field. descriptorCount()
public VkDescriptorSetLayoutBinding.Buffer	descriptorCount(int value) Sets the specified value to the `VkDescriptorSetLayoutBinding#descriptorCount` field.
public int	Returns: the value of the `VkDescriptorSetLayoutBinding#descriptorType` field. descriptorType()
public VkDescriptorSetLayoutBinding.Buffer	descriptorType(int value) Sets the specified value to the `VkDescriptorSetLayoutBinding#descriptorType` field.
protected VkDescriptorSetLayoutBinding	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public LongBuffer	Returns: a `LongBuffer` view of the data pointed to by the `VkDescriptorSetLayoutBinding#pImmutableSamplers` field. pImmutableSamplers()
public VkDescriptorSetLayoutBinding.Buffer	pImmutableSamplers(LongBuffer value) Sets the address of the specified `LongBuffer` to the `VkDescriptorSetLayoutBinding#pImmutableSamplers` field.
protected VkDescriptorSetLayoutBinding.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkDescriptorSetLayoutBinding#stageFlags` field. stageFlags()
public VkDescriptorSetLayoutBinding.Buffer	stageFlags(int value) Sets the specified value to the `VkDescriptorSetLayoutBinding#stageFlags` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkDescriptorSetLayoutBinding ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new VkDescriptorSetLayoutBinding.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 VkDescriptorSetLayoutBinding#SIZEOF, and its mark will be undefined.

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

Buffer	back to summary
public Buffer(long address, int cap)

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

Method Detail

binding	back to summary
public int binding() Returns:int the value of the `VkDescriptorSetLayoutBinding#binding` field. Annotations @NativeType:uint32_t

binding	back to summary
public VkDescriptorSetLayoutBinding.Buffer binding(int value) Sets the specified value to the `VkDescriptorSetLayoutBinding#binding` field.

descriptorCount	back to summary
public int descriptorCount() Returns:int the value of the `VkDescriptorSetLayoutBinding#descriptorCount` field. Annotations @NativeType:uint32_t

descriptorCount	back to summary
public VkDescriptorSetLayoutBinding.Buffer descriptorCount(int value) Sets the specified value to the `VkDescriptorSetLayoutBinding#descriptorCount` field.

descriptorType	back to summary
public int descriptorType() Returns:int the value of the `VkDescriptorSetLayoutBinding#descriptorType` field. Annotations @NativeType:VkDescriptorType

descriptorType	back to summary
public VkDescriptorSetLayoutBinding.Buffer descriptorType(int value) Sets the specified value to the `VkDescriptorSetLayoutBinding#descriptorType` field.

getElementFactory

back to summary

protected VkDescriptorSetLayoutBinding getElementFactory()

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

Annotations

@Override

pImmutableSamplers	back to summary
public LongBuffer pImmutableSamplers() Returns:LongBuffer a `LongBuffer` view of the data pointed to by the `VkDescriptorSetLayoutBinding#pImmutableSamplers` field. Annotations @Nullable @NativeType:VkSampler const *

pImmutableSamplers	back to summary
public VkDescriptorSetLayoutBinding.Buffer pImmutableSamplers(LongBuffer value) Sets the address of the specified `LongBuffer` to the `VkDescriptorSetLayoutBinding#pImmutableSamplers` field.

self

back to summary

protected VkDescriptorSetLayoutBinding.Buffer self()

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

Annotations

@Override

stageFlags	back to summary
public int stageFlags() Returns:int the value of the `VkDescriptorSetLayoutBinding#stageFlags` field. Annotations @NativeType:VkShaderStageFlags

stageFlags	back to summary
public VkDescriptorSetLayoutBinding.Buffer stageFlags(int value) Sets the specified value to the `VkDescriptorSetLayoutBinding#stageFlags` field.

public Class VkDescriptorSetLayoutBinding

Description

Note

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VkDescriptorSetLayoutBinding.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail