VkDescriptorUpdateTemplateEntry (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

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

Direct Known Subclasses:

VkDescriptorUpdateTemplateEntryKHR
```
public class VkDescriptorUpdateTemplateEntry
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Describes a single descriptor update of the descriptor update template.
Valid Usage
- dstBinding must be a valid binding in the descriptor set layout implicitly specified when using a descriptor update template to update descriptors.
- dstArrayElement and descriptorCount must be less than or equal to the number of array elements in the descriptor set binding implicitly specified when using a descriptor update template to update descriptors, and all applicable consecutive bindings, as described by consecutive binding updates
- If descriptor type is DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT, dstArrayElement must be an integer multiple of 4
- If descriptor type is DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT, descriptorCount must be an integer multiple of 4
Valid Usage (Implicit)
- descriptorType must be a valid VkDescriptorType value
See Also

VkDescriptorUpdateTemplateCreateInfo

Member documentation
- dstBinding – the descriptor binding to update when using this descriptor update template.
- dstArrayElement – the starting element in the array belonging to dstBinding. If the descriptor binding identified by srcBinding has a descriptor type of DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT then dstArrayElement specifies the starting byte offset to update.
- descriptorCount – the number of descriptors to update. If descriptorCount is greater than the number of remaining array elements in the destination binding, those affect consecutive bindings in a manner similar to VkWriteDescriptorSet above. If the descriptor binding identified by dstBinding has a descriptor type of DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT then descriptorCount specifies the number of bytes to update and the remaining array elements in the destination binding refer to the remaining number of bytes in it.
- descriptorType – a VkDescriptorType specifying the type of the descriptor.
- offset – the offset in bytes of the first binding in the raw data structure.
- stride – the stride in bytes between two consecutive array elements of the descriptor update informations in the raw data structure. The actual pointer ptr for each array element j of update entry i is computed using the following formula:
```
     const char *ptr = (const char *)pData + pDescriptorUpdateEntries[i].offset + j * pDescriptorUpdateEntries[i].stride
```
  The stride is useful in case the bindings are stored in structs along with other data. If descriptorType is DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT then the value of stride is ignored and the stride is assumed to be 1, i.e. the descriptor update information for them is always specified as a contiguous range.
Layout
```
 struct VkDescriptorUpdateTemplateEntry {
     uint32_t dstBinding;
     uint32_t dstArrayElement;
     uint32_t descriptorCount;
     VkDescriptorType descriptorType;
     size_t offset;
     size_t stride;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkDescriptorUpdateTemplateEntry.Buffer` An array of `VkDescriptorUpdateTemplateEntry` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`DESCRIPTORCOUNT` The struct member offsets.
`static int`	`DESCRIPTORTYPE` The struct member offsets.
`static int`	`DSTARRAYELEMENT` The struct member offsets.
`static int`	`DSTBINDING` The struct member offsets.
`static int`	`OFFSET` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STRIDE` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkDescriptorUpdateTemplateEntry(java.nio.ByteBuffer container)` Creates a `VkDescriptorUpdateTemplateEntry` 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 VkDescriptorUpdateTemplateEntry`	`calloc()` Returns a new `VkDescriptorUpdateTemplateEntry` instance allocated with `memCalloc`.
`static VkDescriptorUpdateTemplateEntry.Buffer`	`calloc(int capacity)` Returns a new `VkDescriptorUpdateTemplateEntry.Buffer` instance allocated with `memCalloc`.
`static VkDescriptorUpdateTemplateEntry`	`callocStack()` Returns a new `VkDescriptorUpdateTemplateEntry` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDescriptorUpdateTemplateEntry.Buffer`	`callocStack(int capacity)` Returns a new `VkDescriptorUpdateTemplateEntry.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDescriptorUpdateTemplateEntry.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDescriptorUpdateTemplateEntry.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDescriptorUpdateTemplateEntry`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkDescriptorUpdateTemplateEntry` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDescriptorUpdateTemplateEntry`	`create()` Returns a new `VkDescriptorUpdateTemplateEntry` instance allocated with `BufferUtils`.
`static VkDescriptorUpdateTemplateEntry.Buffer`	`create(int capacity)` Returns a new `VkDescriptorUpdateTemplateEntry.Buffer` instance allocated with `BufferUtils`.
`static VkDescriptorUpdateTemplateEntry`	`create(long address)` Returns a new `VkDescriptorUpdateTemplateEntry` instance for the specified memory address.
`static VkDescriptorUpdateTemplateEntry.Buffer`	`create(long address, int capacity)` Create a `VkDescriptorUpdateTemplateEntry.Buffer` instance at the specified memory.
`static VkDescriptorUpdateTemplateEntry`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkDescriptorUpdateTemplateEntry.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`descriptorCount()` Returns the value of the `descriptorCount` field.
`VkDescriptorUpdateTemplateEntry`	`descriptorCount(int value)` Sets the specified value to the `descriptorCount` field.
`int`	`descriptorType()` Returns the value of the `descriptorType` field.
`VkDescriptorUpdateTemplateEntry`	`descriptorType(int value)` Sets the specified value to the `descriptorType` field.
`int`	`dstArrayElement()` Returns the value of the `dstArrayElement` field.
`VkDescriptorUpdateTemplateEntry`	`dstArrayElement(int value)` Sets the specified value to the `dstArrayElement` field.
`int`	`dstBinding()` Returns the value of the `dstBinding` field.
`VkDescriptorUpdateTemplateEntry`	`dstBinding(int value)` Sets the specified value to the `dstBinding` field.
`static VkDescriptorUpdateTemplateEntry`	`malloc()` Returns a new `VkDescriptorUpdateTemplateEntry` instance allocated with `memAlloc`.
`static VkDescriptorUpdateTemplateEntry.Buffer`	`malloc(int capacity)` Returns a new `VkDescriptorUpdateTemplateEntry.Buffer` instance allocated with `memAlloc`.
`static VkDescriptorUpdateTemplateEntry`	`mallocStack()` Returns a new `VkDescriptorUpdateTemplateEntry` instance allocated on the thread-local `MemoryStack`.
`static VkDescriptorUpdateTemplateEntry.Buffer`	`mallocStack(int capacity)` Returns a new `VkDescriptorUpdateTemplateEntry.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkDescriptorUpdateTemplateEntry.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDescriptorUpdateTemplateEntry.Buffer` instance allocated on the specified `MemoryStack`.
`static VkDescriptorUpdateTemplateEntry`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkDescriptorUpdateTemplateEntry` instance allocated on the specified `MemoryStack`.
`static int`	`ndescriptorCount(long struct)` Unsafe version of `descriptorCount()`.
`static void`	`ndescriptorCount(long struct, int value)` Unsafe version of `descriptorCount`.
`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`	`noffset(long struct)` Unsafe version of `offset()`.
`static void`	`noffset(long struct, long value)` Unsafe version of `offset`.
`static long`	`nstride(long struct)` Unsafe version of `stride()`.
`static void`	`nstride(long struct, long value)` Unsafe version of `stride`.
`long`	`offset()` Returns the value of the `offset` field.
`VkDescriptorUpdateTemplateEntry`	`offset(long value)` Sets the specified value to the `offset` field.
`VkDescriptorUpdateTemplateEntry`	`set(int dstBinding, int dstArrayElement, int descriptorCount, int descriptorType, long offset, long stride)` Initializes this struct with the specified values.
`VkDescriptorUpdateTemplateEntry`	`set(VkDescriptorUpdateTemplateEntry src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`long`	`stride()` Returns the value of the `stride` field.
`VkDescriptorUpdateTemplateEntry`	`stride(long value)` Sets the specified value to the `stride` field.

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

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, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - 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.
  - OFFSET
```
public static final int OFFSET
```
    The struct member offsets.
  - STRIDE
```
public static final int STRIDE
```
    The struct member offsets.
- Constructor Detail
  - VkDescriptorUpdateTemplateEntry
```
public VkDescriptorUpdateTemplateEntry(java.nio.ByteBuffer container)
```
    Creates a VkDescriptorUpdateTemplateEntry 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()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - 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.
  - offset
```
public long offset()
```
    Returns the value of the offset field.
  - stride
```
public long stride()
```
    Returns the value of the stride field.
  - dstBinding
```
public VkDescriptorUpdateTemplateEntry dstBinding(int value)
```
    Sets the specified value to the dstBinding field.
  - dstArrayElement
```
public VkDescriptorUpdateTemplateEntry dstArrayElement(int value)
```
    Sets the specified value to the dstArrayElement field.
  - descriptorCount
```
public VkDescriptorUpdateTemplateEntry descriptorCount(int value)
```
    Sets the specified value to the descriptorCount field.
  - descriptorType
```
public VkDescriptorUpdateTemplateEntry descriptorType(int value)
```
    Sets the specified value to the descriptorType field.
  - offset
```
public VkDescriptorUpdateTemplateEntry offset(long value)
```
    Sets the specified value to the offset field.
  - stride
```
public VkDescriptorUpdateTemplateEntry stride(long value)
```
    Sets the specified value to the stride field.
  - set
```
public VkDescriptorUpdateTemplateEntry set(int dstBinding,
                                           int dstArrayElement,
                                           int descriptorCount,
                                           int descriptorType,
                                           long offset,
                                           long stride)
```
    Initializes this struct with the specified values.
  - set
```
public VkDescriptorUpdateTemplateEntry set(VkDescriptorUpdateTemplateEntry src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkDescriptorUpdateTemplateEntry malloc()
```
    Returns a new VkDescriptorUpdateTemplateEntry instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkDescriptorUpdateTemplateEntry calloc()
```
    Returns a new VkDescriptorUpdateTemplateEntry instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkDescriptorUpdateTemplateEntry create()
```
    Returns a new VkDescriptorUpdateTemplateEntry instance allocated with BufferUtils.
  - create
```
public static VkDescriptorUpdateTemplateEntry create(long address)
```
    Returns a new VkDescriptorUpdateTemplateEntry instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkDescriptorUpdateTemplateEntry createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkDescriptorUpdateTemplateEntry.Buffer malloc(int capacity)
```
    Returns a new VkDescriptorUpdateTemplateEntry.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkDescriptorUpdateTemplateEntry.Buffer calloc(int capacity)
```
    Returns a new VkDescriptorUpdateTemplateEntry.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDescriptorUpdateTemplateEntry.Buffer create(int capacity)
```
    Returns a new VkDescriptorUpdateTemplateEntry.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDescriptorUpdateTemplateEntry.Buffer create(long address,
                                                            int capacity)
```
    Create a VkDescriptorUpdateTemplateEntry.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkDescriptorUpdateTemplateEntry.Buffer createSafe(long address,
                                                                          int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkDescriptorUpdateTemplateEntry mallocStack()
```
    Returns a new VkDescriptorUpdateTemplateEntry instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkDescriptorUpdateTemplateEntry callocStack()
```
    Returns a new VkDescriptorUpdateTemplateEntry instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkDescriptorUpdateTemplateEntry mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDescriptorUpdateTemplateEntry instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkDescriptorUpdateTemplateEntry callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDescriptorUpdateTemplateEntry instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkDescriptorUpdateTemplateEntry.Buffer mallocStack(int capacity)
```
    Returns a new VkDescriptorUpdateTemplateEntry.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDescriptorUpdateTemplateEntry.Buffer callocStack(int capacity)
```
    Returns a new VkDescriptorUpdateTemplateEntry.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkDescriptorUpdateTemplateEntry.Buffer mallocStack(int capacity,
                                                                 org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDescriptorUpdateTemplateEntry.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDescriptorUpdateTemplateEntry.Buffer callocStack(int capacity,
                                                                 org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDescriptorUpdateTemplateEntry.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
  - 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().
  - noffset
```
public static long noffset(long struct)
```
    Unsafe version of offset().
  - nstride
```
public static long nstride(long struct)
```
    Unsafe version of stride().
  - 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)
```
    Unsafe version of descriptorCount.
  - ndescriptorType
```
public static void ndescriptorType(long struct,
                                   int value)
```
    Unsafe version of descriptorType.
  - noffset
```
public static void noffset(long struct,
                           long value)
```
    Unsafe version of offset.
  - nstride
```
public static void nstride(long struct,
                           long value)
```
    Unsafe version of stride.

Class VkDescriptorUpdateTemplateEntry

Valid Usage

Valid Usage (Implicit)

See Also

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

ALIGNOF

DSTBINDING

DSTARRAYELEMENT

DESCRIPTORCOUNT

DESCRIPTORTYPE

OFFSET

STRIDE

Constructor Detail

VkDescriptorUpdateTemplateEntry

Method Detail

sizeof

dstBinding

dstArrayElement

descriptorCount

descriptorType

offset

stride

dstBinding

dstArrayElement

descriptorCount

descriptorType

offset

stride

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

ndstBinding

ndstArrayElement

ndescriptorCount

ndescriptorType

noffset

nstride

ndstBinding

ndstArrayElement

ndescriptorCount

ndescriptorType

noffset

nstride