Package org.lwjgl.vulkan

Class VkWriteDescriptorSetInlineUniformBlock

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkWriteDescriptorSetInlineUniformBlock>

org.lwjgl.vulkan.VkWriteDescriptorSetInlineUniformBlock

All Implemented Interfaces:

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

Direct Known Subclasses:

VkWriteDescriptorSetInlineUniformBlockEXT

public class VkWriteDescriptorSetInlineUniformBlock
extends org.lwjgl.system.Struct<VkWriteDescriptorSetInlineUniformBlock>
implements org.lwjgl.system.NativeResource

Structure specifying inline uniform block data.

Valid Usage

• dataSize must be an integer multiple of 4

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET_INLINE_UNIFORM_BLOCK
• pData must be a valid pointer to an array of dataSize bytes
• dataSize must be greater than 0

Layout

 struct VkWriteDescriptorSetInlineUniformBlock {
     VkStructureType sType();
     void const * pNext();
     uint32_t dataSize();
     void const * pData();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkWriteDescriptorSetInlineUniformBlock.Buffer	An array of VkWriteDescriptorSetInlineUniformBlock structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DATASIZE	The struct member offsets.
static final int	PDATA	The struct member offsets.
static final int	PNEXT	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 org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkWriteDescriptorSetInlineUniformBlock	calloc()	Returns a new VkWriteDescriptorSetInlineUniformBlock instance allocated with memCalloc.
static VkWriteDescriptorSetInlineUniformBlock.Buffer	calloc(int capacity)	Returns a new VkWriteDescriptorSetInlineUniformBlock.Buffer instance allocated with memCalloc.
static VkWriteDescriptorSetInlineUniformBlock.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkWriteDescriptorSetInlineUniformBlock.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkWriteDescriptorSetInlineUniformBlock	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkWriteDescriptorSetInlineUniformBlock instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkWriteDescriptorSetInlineUniformBlock	create()	Returns a new VkWriteDescriptorSetInlineUniformBlock instance allocated with BufferUtils.
static VkWriteDescriptorSetInlineUniformBlock.Buffer	create(int capacity)	Returns a new VkWriteDescriptorSetInlineUniformBlock.Buffer instance allocated with BufferUtils.
static VkWriteDescriptorSetInlineUniformBlock	create(long address)	Returns a new VkWriteDescriptorSetInlineUniformBlock instance for the specified memory address.
static VkWriteDescriptorSetInlineUniformBlock.Buffer	create(long address, int capacity)	Create a VkWriteDescriptorSetInlineUniformBlock.Buffer instance at the specified memory.
static @Nullable VkWriteDescriptorSetInlineUniformBlock	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkWriteDescriptorSetInlineUniformBlock.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	dataSize()	the number of bytes of inline uniform block data pointed to by pData.
static VkWriteDescriptorSetInlineUniformBlock	malloc()	Returns a new VkWriteDescriptorSetInlineUniformBlock instance allocated with memAlloc.
static VkWriteDescriptorSetInlineUniformBlock.Buffer	malloc(int capacity)	Returns a new VkWriteDescriptorSetInlineUniformBlock.Buffer instance allocated with memAlloc.
static VkWriteDescriptorSetInlineUniformBlock.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkWriteDescriptorSetInlineUniformBlock.Buffer instance allocated on the specified MemoryStack.
static VkWriteDescriptorSetInlineUniformBlock	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkWriteDescriptorSetInlineUniformBlock instance allocated on the specified MemoryStack.
static int	ndataSize(long struct)	Unsafe version of dataSize().
static void	ndataSize(long struct, int value)	Sets the specified value to the dataSize field of the specified struct.
static ByteBuffer	npData(long struct)	Unsafe version of pData.
static void	npData(long struct, ByteBuffer value)	Unsafe version of pData.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
ByteBuffer	pData()	a pointer to dataSize number of bytes of data to write to the inline uniform block.
VkWriteDescriptorSetInlineUniformBlock	pData(ByteBuffer value)	Sets the address of the specified ByteBuffer to the pData() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkWriteDescriptorSetInlineUniformBlock	pNext(long value)	Sets the specified value to the pNext() field.
VkWriteDescriptorSetInlineUniformBlock	set(int sType, long pNext, ByteBuffer pData)	Initializes this struct with the specified values.
VkWriteDescriptorSetInlineUniformBlock	set(VkWriteDescriptorSetInlineUniformBlock src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkWriteDescriptorSetInlineUniformBlock	sType(int value)	Sets the specified value to the sType() field.
VkWriteDescriptorSetInlineUniformBlock	sType$Default()	Sets the STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET_INLINE_UNIFORM_BLOCK value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

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

DATASIZE

public static final int DATASIZE

The struct member offsets.

PDATA

public static final int PDATA

The struct member offsets.

Constructor Details

VkWriteDescriptorSetInlineUniformBlock

public VkWriteDescriptorSetInlineUniformBlock(ByteBuffer container)

Creates a VkWriteDescriptorSetInlineUniformBlock 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()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkWriteDescriptorSetInlineUniformBlock>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

dataSize

public int dataSize()

the number of bytes of inline uniform block data pointed to by pData.

pData

public ByteBuffer pData()

a pointer to dataSize number of bytes of data to write to the inline uniform block.

sType

public VkWriteDescriptorSetInlineUniformBlock sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkWriteDescriptorSetInlineUniformBlock sType$Default()

Sets the STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET_INLINE_UNIFORM_BLOCK value to the sType() field.

pNext

public VkWriteDescriptorSetInlineUniformBlock pNext(long value)

Sets the specified value to the pNext() field.

pData

public VkWriteDescriptorSetInlineUniformBlock pData(ByteBuffer value)

Sets the address of the specified ByteBuffer to the pData() field.

set

public VkWriteDescriptorSetInlineUniformBlock set(int sType,
 long pNext,
 ByteBuffer pData)

Initializes this struct with the specified values.

set

public VkWriteDescriptorSetInlineUniformBlock set(VkWriteDescriptorSetInlineUniformBlock src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkWriteDescriptorSetInlineUniformBlock malloc()

Returns a new VkWriteDescriptorSetInlineUniformBlock instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkWriteDescriptorSetInlineUniformBlock calloc()

Returns a new VkWriteDescriptorSetInlineUniformBlock instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkWriteDescriptorSetInlineUniformBlock create()

Returns a new VkWriteDescriptorSetInlineUniformBlock instance allocated with BufferUtils.

create

public static VkWriteDescriptorSetInlineUniformBlock create(long address)

Returns a new VkWriteDescriptorSetInlineUniformBlock instance for the specified memory address.

createSafe

public static @Nullable VkWriteDescriptorSetInlineUniformBlock createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkWriteDescriptorSetInlineUniformBlock.Buffer malloc(int capacity)

Returns a new VkWriteDescriptorSetInlineUniformBlock.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkWriteDescriptorSetInlineUniformBlock.Buffer calloc(int capacity)

Returns a new VkWriteDescriptorSetInlineUniformBlock.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkWriteDescriptorSetInlineUniformBlock.Buffer create(int capacity)

Returns a new VkWriteDescriptorSetInlineUniformBlock.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkWriteDescriptorSetInlineUniformBlock.Buffer create(long address,
 int capacity)

Create a VkWriteDescriptorSetInlineUniformBlock.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkWriteDescriptorSetInlineUniformBlock malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkWriteDescriptorSetInlineUniformBlock instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkWriteDescriptorSetInlineUniformBlock calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkWriteDescriptorSetInlineUniformBlock.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkWriteDescriptorSetInlineUniformBlock.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkWriteDescriptorSetInlineUniformBlock.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().

ndataSize

public static int ndataSize(long struct)

Unsafe version of dataSize().

npData

public static ByteBuffer npData(long struct)

Unsafe version of pData.

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.

ndataSize

public static void ndataSize(long struct,
 int value)

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

npData

public static void npData(long struct,
 ByteBuffer value)

Unsafe version of pData.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate