Class VkDescriptorUpdateTemplateEntry

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDescriptorUpdateTemplateEntry>

org.lwjgl.vulkan.VkDescriptorUpdateTemplateEntry

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkDescriptorUpdateTemplateEntryKHR

public class VkDescriptorUpdateTemplateEntry
extends Struct<VkDescriptorUpdateTemplateEntry>
implements NativeResource

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	Description
static class	VkDescriptorUpdateTemplateEntry.Buffer	An array of VkDescriptorUpdateTemplateEntry 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	OFFSET	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STRIDE	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkDescriptorUpdateTemplateEntry(ByteBuffer container)	Creates a VkDescriptorUpdateTemplateEntry instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	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.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkDescriptorUpdateTemplateEntry.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDescriptorUpdateTemplateEntry	calloc(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 @Nullable VkDescriptorUpdateTemplateEntry	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDescriptorUpdateTemplateEntry.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	descriptorCount()
VkDescriptorUpdateTemplateEntry	descriptorCount(int value)	Sets the specified value to the descriptorCount field.
int	descriptorType()
VkDescriptorUpdateTemplateEntry	descriptorType(int value)	Sets the specified value to the descriptorType field.
int	dstArrayElement()
VkDescriptorUpdateTemplateEntry	dstArrayElement(int value)	Sets the specified value to the dstArrayElement field.
int	dstBinding()
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.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkDescriptorUpdateTemplateEntry.Buffer instance allocated on the specified MemoryStack.
static VkDescriptorUpdateTemplateEntry	malloc(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()
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()	Returns sizeof(struct).
long	stride()
VkDescriptorUpdateTemplateEntry	stride(long value)	Sets the specified value to the stride 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.

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 Details

VkDescriptorUpdateTemplateEntry

public VkDescriptorUpdateTemplateEntry(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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkDescriptorUpdateTemplateEntry>

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.

offset

@NativeType("size_t")
public long offset()

Returns:

the value of the offset field.

stride

@NativeType("size_t")
public long stride()

Returns:

the value of the stride field.

dstBinding

public VkDescriptorUpdateTemplateEntry dstBinding(@NativeType("uint32_t")
 int value)

Sets the specified value to the dstBinding field.

dstArrayElement

public VkDescriptorUpdateTemplateEntry dstArrayElement(@NativeType("uint32_t")
 int value)

Sets the specified value to the dstArrayElement field.

descriptorCount

public VkDescriptorUpdateTemplateEntry descriptorCount(@NativeType("uint32_t")
 int value)

Sets the specified value to the descriptorCount field.

descriptorType

public VkDescriptorUpdateTemplateEntry descriptorType(@NativeType("VkDescriptorType")
 int value)

Sets the specified value to the descriptorType field.

offset

public VkDescriptorUpdateTemplateEntry offset(@NativeType("size_t")
 long value)

Sets the specified value to the offset field.

stride

public VkDescriptorUpdateTemplateEntry stride(@NativeType("size_t")
 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

public static @Nullable 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

public static @Nullable VkDescriptorUpdateTemplateEntry.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkDescriptorUpdateTemplateEntry malloc(MemoryStack stack)

Returns a new VkDescriptorUpdateTemplateEntry instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkDescriptorUpdateTemplateEntry calloc(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

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkDescriptorUpdateTemplateEntry.Buffer calloc(int capacity,
 MemoryStack stack)

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

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.