org.lwjgl.vulkan.VkWriteDescriptorSet

All Implemented Interfaces:: AutoCloseable, NativeResource, Pointer

public class VkWriteDescriptorSet extends Struct<VkWriteDescriptorSet> implements NativeResource

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

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

VkWriteDescriptorSet.Buffer

An array of VkWriteDescriptorSet structs.

Nested classes/interfaces inherited from class Struct
Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer
Pointer.Default
Field Summary

Fields

Modifier and Type

Field

Description

static final int

ALIGNOF

The struct alignment in bytes.

static final int

DESCRIPTORCOUNT

The struct member offsets.

static final int

DESCRIPTORTYPE

The struct member offsets.

static final int

DSTARRAYELEMENT

The struct member offsets.

static final int

DSTBINDING

The struct member offsets.

static final int

DSTSET

The struct member offsets.

static final int

PBUFFERINFO

The struct member offsets.

static final int

PIMAGEINFO

The struct member offsets.

static final int

PNEXT

The struct member offsets.

static final int

PTEXELBUFFERVIEW

The struct member offsets.

static final int

SIZEOF

The struct size in bytes.

static final int

STYPE

The struct member offsets.

Fields inherited from interface Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
Constructor Summary

Constructors

Constructor

Description

VkWriteDescriptorSet(ByteBuffer container)

Creates a VkWriteDescriptorSet instance at the current position of the specified ByteBuffer container.
Method Summary

Modifier and Type

Method

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.Buffer

calloc(int capacity, MemoryStack stack)

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

static VkWriteDescriptorSet

calloc(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.

static VkWriteDescriptorSet.Buffer

create(long address, int capacity)

Create a VkWriteDescriptorSet.Buffer instance at the specified memory.

static @Nullable VkWriteDescriptorSet

createSafe(long address)

Like create, but returns null if address is NULL.

static @Nullable VkWriteDescriptorSet.Buffer

createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

int

descriptorCount()

VkWriteDescriptorSet

descriptorCount(int value)

Sets the specified value to the descriptorCount field.

int

descriptorType()

VkWriteDescriptorSet

descriptorType(int value)

Sets the specified value to the descriptorType field.

int

dstArrayElement()

VkWriteDescriptorSet

dstArrayElement(int value)

Sets the specified value to the dstArrayElement field.

int

dstBinding()

VkWriteDescriptorSet

dstBinding(int value)

Sets the specified value to the dstBinding field.

long

dstSet()

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.Buffer

malloc(int capacity, MemoryStack stack)

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

static VkWriteDescriptorSet

malloc(MemoryStack stack)

Returns a new VkWriteDescriptorSet instance allocated on the specified MemoryStack.

static int

ndescriptorCount(long struct)

Unsafe version of descriptorCount().

static void

ndescriptorCount(long struct, int value)

Sets the specified value to the descriptorCount field of the specified struct.

static int

ndescriptorType(long struct)

Unsafe version of descriptorType().

static void

ndescriptorType(long struct, int value)

Unsafe version of descriptorType.

static int

ndstArrayElement(long struct)

Unsafe version of dstArrayElement().

static void

ndstArrayElement(long struct, int value)

Unsafe version of dstArrayElement.

static int

ndstBinding(long struct)

Unsafe version of dstBinding().

static void

ndstBinding(long struct, int value)

Unsafe version of dstBinding.

static long

ndstSet(long struct)

Unsafe version of dstSet().

static void

ndstSet(long struct, long value)

Unsafe version of dstSet.

static @Nullable VkDescriptorBufferInfo.Buffer

npBufferInfo(long struct)

Unsafe version of pBufferInfo().

static void

npBufferInfo(long struct, @Nullable VkDescriptorBufferInfo.Buffer value)

Unsafe version of pBufferInfo.

static @Nullable VkDescriptorImageInfo.Buffer

npImageInfo(long struct)

Unsafe version of pImageInfo().

static void

npImageInfo(long struct, @Nullable VkDescriptorImageInfo.Buffer value)

Unsafe version of pImageInfo.

static long

npNext(long struct)

Unsafe version of pNext().

static void

npNext(long struct, long value)

Unsafe version of pNext.

static @Nullable LongBuffer

npTexelBufferView(long struct)

Unsafe version of pTexelBufferView.

static void

npTexelBufferView(long struct, @Nullable LongBuffer value)

Unsafe version of pTexelBufferView.

static int

nsType(long struct)

Unsafe version of sType().

static void

nsType(long struct, int value)

Unsafe version of sType.

@Nullable VkDescriptorBufferInfo.Buffer

pBufferInfo()

VkWriteDescriptorSet

pBufferInfo(@Nullable VkDescriptorBufferInfo.Buffer value)

Sets the address of the specified VkDescriptorBufferInfo.Buffer to the pBufferInfo field.

@Nullable VkDescriptorImageInfo.Buffer

pImageInfo()

VkWriteDescriptorSet

pImageInfo(@Nullable VkDescriptorImageInfo.Buffer value)

Sets the address of the specified VkDescriptorImageInfo.Buffer to the pImageInfo field.

long

pNext()

VkWriteDescriptorSet

pNext(long value)

Sets the specified value to the pNext field.

VkWriteDescriptorSet

pNext(VkWriteDescriptorSetAccelerationStructureKHR value)

Prepends the specified VkWriteDescriptorSetAccelerationStructureKHR value to the pNext chain.

VkWriteDescriptorSet

pNext(VkWriteDescriptorSetAccelerationStructureNV value)

Prepends the specified VkWriteDescriptorSetAccelerationStructureNV value to the pNext chain.

VkWriteDescriptorSet

pNext(VkWriteDescriptorSetInlineUniformBlock value)

Prepends the specified VkWriteDescriptorSetInlineUniformBlock value to the pNext chain.

VkWriteDescriptorSet

pNext(VkWriteDescriptorSetInlineUniformBlockEXT value)

Prepends the specified VkWriteDescriptorSetInlineUniformBlockEXT value to the pNext chain.

VkWriteDescriptorSet

pNext(VkWriteDescriptorSetPartitionedAccelerationStructureNV value)

Prepends the specified VkWriteDescriptorSetPartitionedAccelerationStructureNV value to the pNext chain.

VkWriteDescriptorSet

pNext(VkWriteDescriptorSetTensorARM value)

Prepends the specified VkWriteDescriptorSetTensorARM value to the pNext chain.

@Nullable LongBuffer

pTexelBufferView()

VkWriteDescriptorSet

pTexelBufferView(@Nullable 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 descriptorCount, int descriptorType, @Nullable VkDescriptorImageInfo.Buffer pImageInfo, @Nullable VkDescriptorBufferInfo.Buffer pBufferInfo, @Nullable LongBuffer pTexelBufferView)

Initializes this struct with the specified values.

VkWriteDescriptorSet

set(VkWriteDescriptorSet src)

Copies the specified struct data to this struct.

int

sizeof()

Returns sizeof(struct).

int

sType()

VkWriteDescriptorSet

sType(int value)

Sets the specified value to the sType field.

VkWriteDescriptorSet

sType$Default()

Sets the STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET value to the sType field.

Methods inherited from class Struct
clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default
address, equals, hashCode, toString

Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NativeResource
close, free

Field Details
- SIZEOF
  
  public static final int SIZEOF
  
  The struct size in bytes.
- ALIGNOF
  
  public static final int ALIGNOF
  
  The struct alignment in bytes.
- STYPE
  
  public static final int STYPE
  
  The struct member offsets.
- PNEXT
  
  public static final int PNEXT
  
  The struct member offsets.
- DSTSET
  
  public static final int DSTSET
  
  The struct member offsets.
- DSTBINDING
  
  public static final int DSTBINDING
  
  The struct member offsets.
- DSTARRAYELEMENT
  
  public static final int DSTARRAYELEMENT
  
  The struct member offsets.
- DESCRIPTORCOUNT
  
  public static final int DESCRIPTORCOUNT
  
  The struct member offsets.
- DESCRIPTORTYPE
  
  public static final int DESCRIPTORTYPE
  
  The struct member offsets.
- PIMAGEINFO
  
  public static final int PIMAGEINFO
  
  The struct member offsets.
- PBUFFERINFO
  
  public static final int PBUFFERINFO
  
  The struct member offsets.
- PTEXELBUFFERVIEW
  
  public static final int PTEXELBUFFERVIEW
  
  The struct member offsets.
Constructor Details
- VkWriteDescriptorSet
  
  public VkWriteDescriptorSet(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 Details
- sizeof
  
  public int sizeof()
  
  Description copied from class: Struct
  
  Returns sizeof(struct).
  
  Specified by:
  
  sizeof in class Struct<VkWriteDescriptorSet>
- sType
  
  @NativeType("VkStructureType") public int sType()
  
  Returns:
  
  the value of the sType field.
- pNext
  
  @NativeType("void const *") public long pNext()
  
  Returns:
  
  the value of the pNext field.
- dstSet
  
  @NativeType("VkDescriptorSet") public long dstSet()
  
  Returns:
  
  the value of the dstSet field.
- dstBinding
  
  @NativeType("uint32_t") public int dstBinding()
  
  Returns:
  
  the value of the dstBinding field.
- dstArrayElement
  
  @NativeType("uint32_t") public int dstArrayElement()
  
  Returns:
  
  the value of the dstArrayElement field.
- descriptorCount
  
  @NativeType("uint32_t") public int descriptorCount()
  
  Returns:
  
  the value of the descriptorCount field.
- descriptorType
  
  @NativeType("VkDescriptorType") public int descriptorType()
  
  Returns:
  
  the value of the descriptorType field.
- pImageInfo
  
  @NativeType("VkDescriptorImageInfo const *") public @Nullable VkDescriptorImageInfo.Buffer pImageInfo()
  
  Returns:
  
  a VkDescriptorImageInfo.Buffer view of the struct array pointed to by the pImageInfo field.
- pBufferInfo
  
  @NativeType("VkDescriptorBufferInfo const *") public @Nullable VkDescriptorBufferInfo.Buffer pBufferInfo()
  
  Returns:
  
  a VkDescriptorBufferInfo.Buffer view of the struct array pointed to by the pBufferInfo field.
- pTexelBufferView
  
  @NativeType("VkBufferView const *") public @Nullable LongBuffer pTexelBufferView()
  
  Returns:
  
  a LongBuffer view of the data pointed to by the pTexelBufferView field.
- sType
  
  public VkWriteDescriptorSet sType(@NativeType("VkStructureType") int value)
  
  Sets the specified value to the sType field.
- sType$Default
  
  public VkWriteDescriptorSet sType$Default()
  
  Sets the STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET value to the sType field.
- pNext
  
  public VkWriteDescriptorSet pNext(@NativeType("void const *") long value)
  
  Sets the specified value to the pNext field.
- pNext
  
  public VkWriteDescriptorSet pNext(VkWriteDescriptorSetAccelerationStructureKHR value)
  
  Prepends the specified VkWriteDescriptorSetAccelerationStructureKHR value to the pNext chain.
- pNext
  
  public VkWriteDescriptorSet pNext(VkWriteDescriptorSetAccelerationStructureNV value)
  
  Prepends the specified VkWriteDescriptorSetAccelerationStructureNV value to the pNext chain.
- pNext
  
  public VkWriteDescriptorSet pNext(VkWriteDescriptorSetInlineUniformBlock value)
  
  Prepends the specified VkWriteDescriptorSetInlineUniformBlock value to the pNext chain.
- pNext
  
  public VkWriteDescriptorSet pNext(VkWriteDescriptorSetInlineUniformBlockEXT value)
  
  Prepends the specified VkWriteDescriptorSetInlineUniformBlockEXT value to the pNext chain.
- pNext
  
  public VkWriteDescriptorSet pNext(VkWriteDescriptorSetPartitionedAccelerationStructureNV value)
  
  Prepends the specified VkWriteDescriptorSetPartitionedAccelerationStructureNV value to the pNext chain.
- pNext
  
  public VkWriteDescriptorSet pNext(VkWriteDescriptorSetTensorARM value)
  
  Prepends the specified VkWriteDescriptorSetTensorARM value to the pNext chain.
- dstSet
  
  public VkWriteDescriptorSet dstSet(@NativeType("VkDescriptorSet") long value)
  
  Sets the specified value to the dstSet field.
- dstBinding
  
  public VkWriteDescriptorSet dstBinding(@NativeType("uint32_t") int value)
  
  Sets the specified value to the dstBinding field.
- dstArrayElement
  
  public VkWriteDescriptorSet dstArrayElement(@NativeType("uint32_t") int value)
  
  Sets the specified value to the dstArrayElement field.
- descriptorCount
  
  public VkWriteDescriptorSet descriptorCount(@NativeType("uint32_t") int value)
  
  Sets the specified value to the descriptorCount field.
- descriptorType
  
  public VkWriteDescriptorSet descriptorType(@NativeType("VkDescriptorType") int value)
  
  Sets the specified value to the descriptorType field.
- pImageInfo
  
  public VkWriteDescriptorSet pImageInfo(@NativeType("VkDescriptorImageInfo const *") @Nullable VkDescriptorImageInfo.Buffer value)
  
  Sets the address of the specified VkDescriptorImageInfo.Buffer to the pImageInfo field.
- pBufferInfo
  
  public VkWriteDescriptorSet pBufferInfo(@NativeType("VkDescriptorBufferInfo const *") @Nullable VkDescriptorBufferInfo.Buffer value)
  
  Sets the address of the specified VkDescriptorBufferInfo.Buffer to the pBufferInfo field.
- pTexelBufferView
  
  public VkWriteDescriptorSet pTexelBufferView(@NativeType("VkBufferView const *") @Nullable 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 descriptorCount, int descriptorType, @Nullable VkDescriptorImageInfo.Buffer pImageInfo, @Nullable VkDescriptorBufferInfo.Buffer pBufferInfo, @Nullable LongBuffer pTexelBufferView)
  
  Initializes this struct with the specified values.
- 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.
- createSafe
  
  public static @Nullable VkWriteDescriptorSet createSafe(long address)
  
  Like create, but returns null if 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
- createSafe
  
  public static @Nullable VkWriteDescriptorSet.Buffer createSafe(long address, int capacity)
  
  Like create, but returns null if address is NULL.
- malloc
  
  public static VkWriteDescriptorSet malloc(MemoryStack stack)
  
  Returns a new VkWriteDescriptorSet instance allocated on the specified MemoryStack.
  
  Parameters:
  
  stack - the stack from which to allocate
- calloc
  
  public static VkWriteDescriptorSet calloc(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
- malloc
  
  public static VkWriteDescriptorSet.Buffer malloc(int capacity, MemoryStack stack)
  
  Returns a new VkWriteDescriptorSet.Buffer instance allocated on the specified MemoryStack.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- calloc
  
  public static VkWriteDescriptorSet.Buffer calloc(int capacity, MemoryStack stack)
  
  Returns a new VkWriteDescriptorSet.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- nsType
  
  public static int nsType(long struct)
  
  Unsafe version of sType().
- npNext
  
  public static long npNext(long struct)
  
  Unsafe version of pNext().
- ndstSet
  
  public static long ndstSet(long struct)
  
  Unsafe version of dstSet().
- ndstBinding
  
  public static int ndstBinding(long struct)
  
  Unsafe version of dstBinding().
- ndstArrayElement
  
  public static int ndstArrayElement(long struct)
  
  Unsafe version of dstArrayElement().
- ndescriptorCount
  
  public static int ndescriptorCount(long struct)
  
  Unsafe version of descriptorCount().
- ndescriptorType
  
  public static int ndescriptorType(long struct)
  
  Unsafe version of descriptorType().
- npImageInfo
  
  public static @Nullable VkDescriptorImageInfo.Buffer npImageInfo(long struct)
  
  Unsafe version of pImageInfo().
- npBufferInfo
  
  public static @Nullable VkDescriptorBufferInfo.Buffer npBufferInfo(long struct)
  
  Unsafe version of pBufferInfo().
- npTexelBufferView
  
  public static @Nullable LongBuffer npTexelBufferView(long struct)
  
  Unsafe version of pTexelBufferView.
- nsType
  
  public static void nsType(long struct, int value)
  
  Unsafe version of sType.
- npNext
  
  public static void npNext(long struct, long value)
  
  Unsafe version of pNext.
- ndstSet
  
  public static void ndstSet(long struct, long value)
  
  Unsafe version of dstSet.
- ndstBinding
  
  public static void ndstBinding(long struct, int value)
  
  Unsafe version of dstBinding.
- ndstArrayElement
  
  public static void ndstArrayElement(long struct, int value)
  
  Unsafe version of dstArrayElement.
- ndescriptorCount
  
  public static void ndescriptorCount(long struct, int value)
  
  Sets the specified value to the descriptorCount field of the specified struct.
- ndescriptorType
  
  public static void ndescriptorType(long struct, int value)
  
  Unsafe version of descriptorType.
- npImageInfo
  
  public static void npImageInfo(long struct, @Nullable VkDescriptorImageInfo.Buffer value)
  
  Unsafe version of pImageInfo.
- npBufferInfo
  
  public static void npBufferInfo(long struct, @Nullable VkDescriptorBufferInfo.Buffer value)
  
  Unsafe version of pBufferInfo.
- npTexelBufferView
  
  public static void npTexelBufferView(long struct, @Nullable LongBuffer value)
  
  Unsafe version of pTexelBufferView.

Class VkWriteDescriptorSet

Nested Class Summary

Nested classes/interfaces inherited from class Struct

Nested classes/interfaces inherited from interface Pointer

Field Summary

Fields inherited from interface Pointer

Constructor Summary

Method Summary

Methods inherited from class Struct

Methods inherited from class Pointer.Default

Methods inherited from class Object

Methods inherited from interface NativeResource

Field Details

SIZEOF

ALIGNOF

STYPE

PNEXT

DSTSET

DSTBINDING

DSTARRAYELEMENT

DESCRIPTORCOUNT

DESCRIPTORTYPE

PIMAGEINFO

PBUFFERINFO

PTEXELBUFFERVIEW

Constructor Details

VkWriteDescriptorSet

Method Details

sizeof

sType

pNext

dstSet

dstBinding

dstArrayElement

descriptorCount

descriptorType

pImageInfo

pBufferInfo

pTexelBufferView

sType

sType$Default

pNext

pNext

pNext

pNext

pNext

pNext

pNext

dstSet

dstBinding

dstArrayElement

descriptorCount

descriptorType

pImageInfo

pBufferInfo

pTexelBufferView

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nsType

npNext

ndstSet

ndstBinding

ndstArrayElement

ndescriptorCount

ndescriptorType

npImageInfo