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

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

public class VkWriteDescriptorSet
extends Struct

Khronos Reference Page
Vulkan Specification

Describes an operation updating the descriptor set using descriptors for resources specified in the structure.

Valid Usage

sType must be STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET
pNext must be NULL
dstSet must be a valid VkDescriptorSet handle
descriptorType must be a valid VkDescriptorType value
descriptorCount must be greater than 0
Each of dstSet and the elements of pTexelBufferView that are valid handles must have been created, allocated or retrieved from the same VkDevice
dstBinding must be a valid binding point within dstSet
descriptorType must match the type of dstBinding within dstSet
The sum of dstArrayElement and descriptorCount must be less than or equal to the number of array elements in the descriptor set binding specified by dstBinding, and all applicable consecutive bindings
If descriptorType is DESCRIPTOR_TYPE_SAMPLER, DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, DESCRIPTOR_TYPE_SAMPLED_IMAGE, DESCRIPTOR_TYPE_STORAGE_IMAGE or DESCRIPTOR_TYPE_INPUT_ATTACHMENT, pImageInfo must be a pointer to an array of descriptorCount valid VkDescriptorImageInfo structures
If descriptorType is DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER or DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, pTexelBufferView must be a pointer to an array of descriptorCount valid VkBufferView handles
If descriptorType is DESCRIPTOR_TYPE_UNIFORM_BUFFER, DESCRIPTOR_TYPE_STORAGE_BUFFER, DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC or DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, pBufferInfo must be a pointer to an array of descriptorCount valid VkDescriptorBufferInfo structures
If descriptorType is DESCRIPTOR_TYPE_SAMPLER or DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, and dstSet was not created with a layout that included immutable samplers for dstBinding with descriptorType, the sampler member of any given element of pImageInfo must be a valid VkSampler object
If descriptorType is DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, DESCRIPTOR_TYPE_SAMPLED_IMAGE, DESCRIPTOR_TYPE_STORAGE_IMAGE or DESCRIPTOR_TYPE_INPUT_ATTACHMENT, the imageView and imageLayout members of any given element of pImageInfo must be a valid VkImageView and VkImageLayout, respectively
If descriptorType is DESCRIPTOR_TYPE_UNIFORM_BUFFER or DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, the offset member of any given element of pBufferInfo must be a multiple of VkPhysicalDeviceLimits::minUniformBufferOffsetAlignment
If descriptorType is DESCRIPTOR_TYPE_STORAGE_BUFFER or DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, the offset member of any given element of pBufferInfo must be a multiple of VkPhysicalDeviceLimits::minStorageBufferOffsetAlignment
If descriptorType is DESCRIPTOR_TYPE_UNIFORM_BUFFER or DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, the buffer member of any given element of pBufferInfo must have been created with BUFFER_USAGE_UNIFORM_BUFFER_BIT set
If descriptorType is DESCRIPTOR_TYPE_STORAGE_BUFFER or DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, the buffer member of any given element of pBufferInfo must have been created with BUFFER_USAGE_STORAGE_BUFFER_BIT set
If descriptorType is DESCRIPTOR_TYPE_UNIFORM_BUFFER or DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, the range member of any given element of pBufferInfo must be less than or equal to VkPhysicalDeviceLimits::maxUniformBufferRange
If descriptorType is DESCRIPTOR_TYPE_STORAGE_BUFFER or DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, the range member of any given element of pBufferInfo must be less than or equal to VkPhysicalDeviceLimits::maxStorageBufferRange
If descriptorType is DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER, the VkBuffer that any given element of pTexelBufferView was created from must have been created with BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT set
If descriptorType is DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, the VkBuffer that any given element of pTexelBufferView was created from must have been created with BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT set
If descriptorType is DESCRIPTOR_TYPE_STORAGE_IMAGE or DESCRIPTOR_TYPE_INPUT_ATTACHMENT, the imageView member of any given element of pImageInfo must have been created with the identity swizzle

Member documentation

sType – the type of this structure. Must be: STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET
pNext – reserved for use by extensions
dstSet – the destination descriptor set to update
dstBinding – the descriptor binding within that set
dstArrayElement – the starting element in that array
descriptorCount – the number of descriptors to update (the number of elements in pImageInfO, pBufferInfO, or pTexelBufferVieW)

descriptorType – the type of each descriptor in pImageInfo, pBufferInfo, or pTexelBufferView, and must be the same type as what was specified in VkDescriptorSetLayoutBinding for dstSet at dstBinding. The type of the descriptor also controls which array the descriptors are taken from. 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`

pImageInfo – points to an array of VkDescriptorImageInfo structures or is ignored
pBufferInfo – points to an array of VkDescriptorBufferInfo structures or is ignored
pTexelBufferView – points to an array of VkBufferView handles or is ignored

Layout

struct VkWriteDescriptorSet {
    VkStructureType sType;
    const void * pNext;
    VkDescriptorSet dstSet;
    uint32_t dstBinding;
    uint32_t dstArrayElement;
    uint32_t descriptorCount;
    VkDescriptorType descriptorType;
    const VkDescriptorImageInfo * pImageInfo;
    const VkDescriptorBufferInfo * pBufferInfo;
    const VkBufferView * pTexelBufferView;
}

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkWriteDescriptorSet.Buffer
An array of VkWriteDescriptorSet 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
`VkWriteDescriptorSet(java.nio.ByteBuffer container)` Creates a `VkWriteDescriptorSet` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkWriteDescriptorSet`	`calloc()` Returns a new `VkWriteDescriptorSet` instance allocated with `memCalloc`.
`static VkWriteDescriptorSet.Buffer`	`calloc(int capacity)` Returns a new `VkWriteDescriptorSet.Buffer` instance allocated with `memCalloc`.
`static VkWriteDescriptorSet`	`callocStack()` Returns a new `VkWriteDescriptorSet` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkWriteDescriptorSet.Buffer`	`callocStack(int capacity)` Returns a new `VkWriteDescriptorSet.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkWriteDescriptorSet.Buffer`	`callocStack(int capacity, MemoryStack stack)` Returns a new `VkWriteDescriptorSet.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkWriteDescriptorSet`	`callocStack(MemoryStack stack)` Returns a new `VkWriteDescriptorSet` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkWriteDescriptorSet`	`create()` Returns a new `VkWriteDescriptorSet` instance allocated with `BufferUtils`.
`static VkWriteDescriptorSet.Buffer`	`create(int capacity)` Returns a new `VkWriteDescriptorSet.Buffer` instance allocated with `BufferUtils`.
`static VkWriteDescriptorSet`	`create(long address)` Returns a new `VkWriteDescriptorSet` instance for the specified memory address or `null` if the address is `NULL`.
`static VkWriteDescriptorSet.Buffer`	`create(long address, int capacity)` Create a `VkWriteDescriptorSet.Buffer` instance at the specified memory.
`int`	`descriptorCount()` Returns the value of the `descriptorCount` field.
`int`	`descriptorType()` Returns the value of the `descriptorType` field.
`VkWriteDescriptorSet`	`descriptorType(int value)` Sets the specified value to the `descriptorType` field.
`int`	`dstArrayElement()` Returns the value of the `dstArrayElement` field.
`VkWriteDescriptorSet`	`dstArrayElement(int value)` Sets the specified value to the `dstArrayElement` field.
`int`	`dstBinding()` Returns the value of the `dstBinding` field.
`VkWriteDescriptorSet`	`dstBinding(int value)` Sets the specified value to the `dstBinding` field.
`long`	`dstSet()` Returns the value of the `dstSet` field.
`VkWriteDescriptorSet`	`dstSet(long value)` Sets the specified value to the `dstSet` field.
`static VkWriteDescriptorSet`	`malloc()` Returns a new `VkWriteDescriptorSet` instance allocated with `memAlloc`.
`static VkWriteDescriptorSet.Buffer`	`malloc(int capacity)` Returns a new `VkWriteDescriptorSet.Buffer` instance allocated with `memAlloc`.
`static VkWriteDescriptorSet`	`mallocStack()` Returns a new `VkWriteDescriptorSet` instance allocated on the thread-local `MemoryStack`.
`static VkWriteDescriptorSet.Buffer`	`mallocStack(int capacity)` Returns a new `VkWriteDescriptorSet.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkWriteDescriptorSet.Buffer`	`mallocStack(int capacity, MemoryStack stack)` Returns a new `VkWriteDescriptorSet.Buffer` instance allocated on the specified `MemoryStack`.
`static VkWriteDescriptorSet`	`mallocStack(MemoryStack stack)` Returns a new `VkWriteDescriptorSet` instance allocated on the specified `MemoryStack`.
`VkWriteDescriptorSet`	`nset(long struct)` Unsafe version of `set`.
`VkDescriptorBufferInfo.Buffer`	`pBufferInfo()` Returns a `VkDescriptorBufferInfo.Buffer` view of the struct array pointed to by the `pBufferInfo` field.
`VkWriteDescriptorSet`	`pBufferInfo(VkDescriptorBufferInfo.Buffer value)` Sets the address of the specified `VkDescriptorBufferInfo.Buffer` to the `pBufferInfo` field.
`VkDescriptorImageInfo.Buffer`	`pImageInfo()` Returns a `VkDescriptorImageInfo.Buffer` view of the struct array pointed to by the `pImageInfo` field.
`VkWriteDescriptorSet`	`pImageInfo(VkDescriptorImageInfo.Buffer value)` Sets the address of the specified `VkDescriptorImageInfo.Buffer` to the `pImageInfo` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkWriteDescriptorSet`	`pNext(long value)` Sets the specified value to the `pNext` field.
`java.nio.LongBuffer`	`pTexelBufferView()` Returns a `LongBuffer` view of the data pointed to by the `pTexelBufferView` field.
`VkWriteDescriptorSet`	`pTexelBufferView(java.nio.LongBuffer value)` Sets the address of the specified `LongBuffer` to the `pTexelBufferView` field.
`VkWriteDescriptorSet`	`set(int sType, long pNext, long dstSet, int dstBinding, int dstArrayElement, int descriptorType, VkDescriptorImageInfo.Buffer pImageInfo, VkDescriptorBufferInfo.Buffer pBufferInfo, java.nio.LongBuffer pTexelBufferView)` Initializes this struct with the specified values.
`VkWriteDescriptorSet`	`set(VkWriteDescriptorSet src)` Copies the specified struct data to this struct.
`int`	`sizeof()` Returns the `sizeof(struct)`.
`int`	`sType()` Returns the value of the `sType` field.
`VkWriteDescriptorSet`	`sType(int value)` Sets the specified value to the `sType` field.
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `VkWriteDescriptorSet.validate(long)` for each struct contained in the specified struct array.

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
  - VkWriteDescriptorSet
```
public VkWriteDescriptorSet(java.nio.ByteBuffer container)
```
    Creates a VkWriteDescriptorSet 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
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - dstSet
```
public long dstSet()
```
    Returns the value of the dstSet field.
  - dstBinding
```
public int dstBinding()
```
    Returns the value of the dstBinding field.
  - dstArrayElement
```
public int dstArrayElement()
```
    Returns the value of the dstArrayElement field.
  - descriptorCount
```
public int descriptorCount()
```
    Returns the value of the descriptorCount field.
  - descriptorType
```
public int descriptorType()
```
    Returns the value of the descriptorType field.
  - pImageInfo
```
public VkDescriptorImageInfo.Buffer pImageInfo()
```
    Returns a VkDescriptorImageInfo.Buffer view of the struct array pointed to by the pImageInfo field.
  - pBufferInfo
```
public VkDescriptorBufferInfo.Buffer pBufferInfo()
```
    Returns a VkDescriptorBufferInfo.Buffer view of the struct array pointed to by the pBufferInfo field.
  - pTexelBufferView
```
public java.nio.LongBuffer pTexelBufferView()
```
    Returns a LongBuffer view of the data pointed to by the pTexelBufferView field.
  - sType
```
public VkWriteDescriptorSet sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkWriteDescriptorSet pNext(long value)
```
    Sets the specified value to the pNext field.
  - dstSet
```
public VkWriteDescriptorSet dstSet(long value)
```
    Sets the specified value to the dstSet field.
  - dstBinding
```
public VkWriteDescriptorSet dstBinding(int value)
```
    Sets the specified value to the dstBinding field.
  - dstArrayElement
```
public VkWriteDescriptorSet dstArrayElement(int value)
```
    Sets the specified value to the dstArrayElement field.
  - descriptorType
```
public VkWriteDescriptorSet descriptorType(int value)
```
    Sets the specified value to the descriptorType field.
  - pImageInfo
```
public VkWriteDescriptorSet pImageInfo(VkDescriptorImageInfo.Buffer value)
```
    Sets the address of the specified VkDescriptorImageInfo.Buffer to the pImageInfo field.
  - pBufferInfo
```
public VkWriteDescriptorSet pBufferInfo(VkDescriptorBufferInfo.Buffer value)
```
    Sets the address of the specified VkDescriptorBufferInfo.Buffer to the pBufferInfo field.
  - pTexelBufferView
```
public VkWriteDescriptorSet pTexelBufferView(java.nio.LongBuffer value)
```
    Sets the address of the specified LongBuffer to the pTexelBufferView field.
  - set
```
public VkWriteDescriptorSet set(int sType,
                                long pNext,
                                long dstSet,
                                int dstBinding,
                                int dstArrayElement,
                                int descriptorType,
                                VkDescriptorImageInfo.Buffer pImageInfo,
                                VkDescriptorBufferInfo.Buffer pBufferInfo,
                                java.nio.LongBuffer pTexelBufferView)
```
    Initializes this struct with the specified values.
  - nset
```
public VkWriteDescriptorSet nset(long struct)
```
    Unsafe version of set.
  - set
```
public VkWriteDescriptorSet set(VkWriteDescriptorSet src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkWriteDescriptorSet malloc()
```
    Returns a new VkWriteDescriptorSet instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkWriteDescriptorSet calloc()
```
    Returns a new VkWriteDescriptorSet instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkWriteDescriptorSet create()
```
    Returns a new VkWriteDescriptorSet instance allocated with BufferUtils.
  - create
```
public static VkWriteDescriptorSet create(long address)
```
    Returns a new VkWriteDescriptorSet instance for the specified memory address or null if the address is NULL.
  - malloc
```
public static VkWriteDescriptorSet.Buffer malloc(int capacity)
```
    Returns a new VkWriteDescriptorSet.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkWriteDescriptorSet.Buffer calloc(int capacity)
```
    Returns a new VkWriteDescriptorSet.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkWriteDescriptorSet.Buffer create(int capacity)
```
    Returns a new VkWriteDescriptorSet.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkWriteDescriptorSet.Buffer create(long address,
                                                 int capacity)
```
    Create a VkWriteDescriptorSet.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkWriteDescriptorSet mallocStack()
```
    Returns a new VkWriteDescriptorSet instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkWriteDescriptorSet callocStack()
```
    Returns a new VkWriteDescriptorSet instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkWriteDescriptorSet mallocStack(MemoryStack stack)
```
    Returns a new VkWriteDescriptorSet instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkWriteDescriptorSet callocStack(MemoryStack stack)
```
    Returns a new VkWriteDescriptorSet instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkWriteDescriptorSet.Buffer mallocStack(int capacity)
```
    Returns a new VkWriteDescriptorSet.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkWriteDescriptorSet.Buffer callocStack(int capacity)
```
    Returns a new VkWriteDescriptorSet.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkWriteDescriptorSet.Buffer mallocStack(int capacity,
                                                      MemoryStack stack)
```
    Returns a new VkWriteDescriptorSet.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkWriteDescriptorSet.Buffer callocStack(int capacity,
                                                      MemoryStack stack)
```
    Returns a new VkWriteDescriptorSet.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
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls VkWriteDescriptorSet.validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class VkWriteDescriptorSet

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

VkWriteDescriptorSet

Method Detail

sizeof

sType

pNext

dstSet

dstBinding

dstArrayElement

descriptorCount

descriptorType

pImageInfo

pBufferInfo

pTexelBufferView

sType

pNext

dstSet

dstBinding

dstArrayElement

descriptorType

pImageInfo

pBufferInfo

pTexelBufferView

set

nset

set

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

validate

validate