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

All Implemented Interfaces:: java.lang.AutoCloseable, NativeResource, Pointer

public class VkDescriptorSetLayoutBinding
extends Struct

Khronos Reference Page
Vulkan Specification

An entry in a descriptor set layout corresponding to zero or more descriptors of a single descriptor type in a set.

Valid Usage

descriptorType must be a valid VkDescriptorType value
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 pointer to an array of descriptorCount valid VkSampler handles
If descriptorCount is not 0, stageFlags must be a valid combination of VkShaderStageFlagBits values

Member documentation

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

descriptorType – a VkDescriptorType specifying which type of resource descriptors are used for this binding. One of:

`DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER`	`DESCRIPTOR_TYPE_INPUT_ATTACHMENT`
`DESCRIPTOR_TYPE_SAMPLED_IMAGE`	`DESCRIPTOR_TYPE_SAMPLER`
`DESCRIPTOR_TYPE_STORAGE_BUFFER`	`DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC`
`DESCRIPTOR_TYPE_STORAGE_IMAGE`	`DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER`
`DESCRIPTOR_TYPE_UNIFORM_BUFFER`	`DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC`
`DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER`

descriptorCount – the number of descriptors contained in the binding, accessed in a shader as an array. 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.

stageFlags – a bitfield of VkShaderStageFlagBits specifying which pipeline shader stages can access a resource for this binding. One or more of:

`SHADER_STAGE_ALL`	`SHADER_STAGE_ALL_GRAPHICS`
`SHADER_STAGE_COMPUTE_BIT`	`SHADER_STAGE_FRAGMENT_BIT`
`SHADER_STAGE_GEOMETRY_BIT`	`SHADER_STAGE_TESSELLATION_CONTROL_BIT`
`SHADER_STAGE_TESSELLATION_EVALUATION_BIT`	`SHADER_STAGE_VERTEX_BIT`

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; later binding a sampler into an immutable sampler slot in a descriptor set is not allowed. If pImmutableSamplers is not NULL, then it is considered to be a pointer to an array of sampler handles that will be consumed by the set layout and used for the corresponding binding. 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.

Layout

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type Field and Description

static int SIZEOF
The struct size in bytes.
- Fields inherited from interface org.lwjgl.system.Pointer
  POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkDescriptorSetLayoutBinding(java.nio.ByteBuffer container)` Creates a `VkDescriptorSetLayoutBinding` 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
`int`	`binding()` Returns the value of the `binding` field.
`VkDescriptorSetLayoutBinding`	`binding(int value)` Sets the specified value to the `binding` field.
`static VkDescriptorSetLayoutBinding`	`calloc()` Returns a new `VkDescriptorSetLayoutBinding` instance allocated with `memCalloc`.
`static VkDescriptorSetLayoutBinding.Buffer`	`calloc(int capacity)` Returns a new `VkDescriptorSetLayoutBinding.Buffer` instance allocated with `memCalloc`.
`static VkDescriptorSetLayoutBinding`	`callocStack()` Returns a new `VkDescriptorSetLayoutBinding` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDescriptorSetLayoutBinding.Buffer`	`callocStack(int capacity)` Returns a new `VkDescriptorSetLayoutBinding.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDescriptorSetLayoutBinding.Buffer`	`callocStack(int capacity, MemoryStack stack)` Returns a new `VkDescriptorSetLayoutBinding.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDescriptorSetLayoutBinding`	`callocStack(MemoryStack stack)` Returns a new `VkDescriptorSetLayoutBinding` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDescriptorSetLayoutBinding`	`create()` Returns a new `VkDescriptorSetLayoutBinding` instance allocated with `BufferUtils`.
`static VkDescriptorSetLayoutBinding.Buffer`	`create(int capacity)` Returns a new `VkDescriptorSetLayoutBinding.Buffer` instance allocated with `BufferUtils`.
`static VkDescriptorSetLayoutBinding`	`create(long address)` Returns a new `VkDescriptorSetLayoutBinding` instance for the specified memory address or `null` if the address is `NULL`.
`static VkDescriptorSetLayoutBinding.Buffer`	`create(long address, int capacity)` Create a `VkDescriptorSetLayoutBinding.Buffer` instance at the specified memory.
`int`	`descriptorCount()` Returns the value of the `descriptorCount` field.
`VkDescriptorSetLayoutBinding`	`descriptorCount(int value)` Sets the specified value to the `descriptorCount` field.
`int`	`descriptorType()` Returns the value of the `descriptorType` field.
`VkDescriptorSetLayoutBinding`	`descriptorType(int value)` Sets the specified value to the `descriptorType` field.
`static VkDescriptorSetLayoutBinding`	`malloc()` Returns a new `VkDescriptorSetLayoutBinding` instance allocated with `memAlloc`.
`static VkDescriptorSetLayoutBinding.Buffer`	`malloc(int capacity)` Returns a new `VkDescriptorSetLayoutBinding.Buffer` instance allocated with `memAlloc`.
`static VkDescriptorSetLayoutBinding`	`mallocStack()` Returns a new `VkDescriptorSetLayoutBinding` instance allocated on the thread-local `MemoryStack`.
`static VkDescriptorSetLayoutBinding.Buffer`	`mallocStack(int capacity)` Returns a new `VkDescriptorSetLayoutBinding.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkDescriptorSetLayoutBinding.Buffer`	`mallocStack(int capacity, MemoryStack stack)` Returns a new `VkDescriptorSetLayoutBinding.Buffer` instance allocated on the specified `MemoryStack`.
`static VkDescriptorSetLayoutBinding`	`mallocStack(MemoryStack stack)` Returns a new `VkDescriptorSetLayoutBinding` instance allocated on the specified `MemoryStack`.
`VkDescriptorSetLayoutBinding`	`nset(long struct)` Unsafe version of `set`.
`java.nio.LongBuffer`	`pImmutableSamplers(int capacity)` Returns a `LongBuffer` view of the data pointed to by the `pImmutableSamplers` field.
`VkDescriptorSetLayoutBinding`	`pImmutableSamplers(java.nio.LongBuffer value)` Sets the address of the specified `LongBuffer` to the `pImmutableSamplers` field.
`VkDescriptorSetLayoutBinding`	`set(int binding, int descriptorType, int descriptorCount, int stageFlags, java.nio.LongBuffer pImmutableSamplers)` Initializes this struct with the specified values.
`VkDescriptorSetLayoutBinding`	`set(VkDescriptorSetLayoutBinding src)` Copies the specified struct data to this struct.
`int`	`sizeof()` Returns the `sizeof(struct)`.
`int`	`stageFlags()` Returns the value of the `stageFlags` field.
`VkDescriptorSetLayoutBinding`	`stageFlags(int value)` Sets the specified value to the `stageFlags` field.

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

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
- Constructor Detail
  - VkDescriptorSetLayoutBinding
```
public VkDescriptorSetLayoutBinding(java.nio.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
  - sizeof
```
public int sizeof()
```
    Description copied from class: Struct
    
    Returns the sizeof(struct).
    
    Specified by:
    
    sizeof in class Struct
  - binding
```
public int binding()
```
    Returns the value of the binding field.
  - descriptorType
```
public int descriptorType()
```
    Returns the value of the descriptorType field.
  - descriptorCount
```
public int descriptorCount()
```
    Returns the value of the descriptorCount field.
  - stageFlags
```
public int stageFlags()
```
    Returns the value of the stageFlags field.
  - pImmutableSamplers
```
public java.nio.LongBuffer pImmutableSamplers(int capacity)
```
    Returns a LongBuffer view of the data pointed to by the pImmutableSamplers field.
    
    Parameters:
    
    capacity - the number of elements in the returned buffer
  - binding
```
public VkDescriptorSetLayoutBinding binding(int value)
```
    Sets the specified value to the binding field.
  - descriptorType
```
public VkDescriptorSetLayoutBinding descriptorType(int value)
```
    Sets the specified value to the descriptorType field.
  - descriptorCount
```
public VkDescriptorSetLayoutBinding descriptorCount(int value)
```
    Sets the specified value to the descriptorCount field.
  - stageFlags
```
public VkDescriptorSetLayoutBinding stageFlags(int value)
```
    Sets the specified value to the stageFlags field.
  - pImmutableSamplers
```
public VkDescriptorSetLayoutBinding pImmutableSamplers(java.nio.LongBuffer value)
```
    Sets the address of the specified LongBuffer to the pImmutableSamplers field.
  - set
```
public VkDescriptorSetLayoutBinding set(int binding,
                                        int descriptorType,
                                        int descriptorCount,
                                        int stageFlags,
                                        java.nio.LongBuffer pImmutableSamplers)
```
    Initializes this struct with the specified values.
  - nset
```
public VkDescriptorSetLayoutBinding nset(long struct)
```
    Unsafe version of set.
  - set
```
public VkDescriptorSetLayoutBinding set(VkDescriptorSetLayoutBinding src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkDescriptorSetLayoutBinding malloc()
```
    Returns a new VkDescriptorSetLayoutBinding instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkDescriptorSetLayoutBinding calloc()
```
    Returns a new VkDescriptorSetLayoutBinding instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkDescriptorSetLayoutBinding create()
```
    Returns a new VkDescriptorSetLayoutBinding instance allocated with BufferUtils.
  - create
```
public static VkDescriptorSetLayoutBinding create(long address)
```
    Returns a new VkDescriptorSetLayoutBinding instance for the specified memory address or null if the address is NULL.
  - malloc
```
public static VkDescriptorSetLayoutBinding.Buffer malloc(int capacity)
```
    Returns a new VkDescriptorSetLayoutBinding.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkDescriptorSetLayoutBinding.Buffer calloc(int capacity)
```
    Returns a new VkDescriptorSetLayoutBinding.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDescriptorSetLayoutBinding.Buffer create(int capacity)
```
    Returns a new VkDescriptorSetLayoutBinding.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDescriptorSetLayoutBinding.Buffer create(long address,
                                                         int capacity)
```
    Create a VkDescriptorSetLayoutBinding.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkDescriptorSetLayoutBinding mallocStack()
```
    Returns a new VkDescriptorSetLayoutBinding instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkDescriptorSetLayoutBinding callocStack()
```
    Returns a new VkDescriptorSetLayoutBinding instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkDescriptorSetLayoutBinding mallocStack(MemoryStack stack)
```
    Returns a new VkDescriptorSetLayoutBinding instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkDescriptorSetLayoutBinding callocStack(MemoryStack stack)
```
    Returns a new VkDescriptorSetLayoutBinding instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkDescriptorSetLayoutBinding.Buffer mallocStack(int capacity)
```
    Returns a new VkDescriptorSetLayoutBinding.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDescriptorSetLayoutBinding.Buffer callocStack(int capacity)
```
    Returns a new VkDescriptorSetLayoutBinding.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkDescriptorSetLayoutBinding.Buffer mallocStack(int capacity,
                                                              MemoryStack stack)
```
    Returns a new VkDescriptorSetLayoutBinding.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDescriptorSetLayoutBinding.Buffer callocStack(int capacity,
                                                              MemoryStack stack)
```
    Returns a new VkDescriptorSetLayoutBinding.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

Class VkDescriptorSetLayoutBinding

Valid Usage

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

Constructor Detail

VkDescriptorSetLayoutBinding

Method Detail

sizeof

binding

descriptorType

descriptorCount

stageFlags

pImmutableSamplers

binding

descriptorType

descriptorCount

stageFlags

pImmutableSamplers

set

nset

set

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack