Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkWriteDescriptorSetInlineUniformBlock

extends Struct<VkWriteDescriptorSetInlineUniformBlock>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkWriteDescriptorSetInlineUniformBlockEXT
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying inline uniform block data.
Valid Usage
Valid Usage (Implicit)

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DATASIZE

The struct member offsets.

public static final int
PDATA

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkWriteDescriptorSetInlineUniformBlock(ByteBuffer container)

Creates a VkWriteDescriptorSetInlineUniformBlock instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkWriteDescriptorSetInlineUniformBlock
calloc()

Returns a new VkWriteDescriptorSetInlineUniformBlock instance allocated with memCalloc.

public static VkWriteDescriptorSetInlineUniformBlock.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkWriteDescriptorSetInlineUniformBlock.Buffer instance allocated with memCalloc.

public static VkWriteDescriptorSetInlineUniformBlock
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkWriteDescriptorSetInlineUniformBlock.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected VkWriteDescriptorSetInlineUniformBlock
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkWriteDescriptorSetInlineUniformBlock
create()

Returns a new VkWriteDescriptorSetInlineUniformBlock instance allocated with BufferUtils.

public static VkWriteDescriptorSetInlineUniformBlock
create(long address)

Returns a new VkWriteDescriptorSetInlineUniformBlock instance for the specified memory address.

public static VkWriteDescriptorSetInlineUniformBlock.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkWriteDescriptorSetInlineUniformBlock.Buffer instance allocated with BufferUtils.

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

Create a VkWriteDescriptorSetInlineUniformBlock.Buffer instance at the specified memory.

public static VkWriteDescriptorSetInlineUniformBlock
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
dataSize()

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

public static VkWriteDescriptorSetInlineUniformBlock
malloc()

Returns a new VkWriteDescriptorSetInlineUniformBlock instance allocated with memAlloc.

public static VkWriteDescriptorSetInlineUniformBlock.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkWriteDescriptorSetInlineUniformBlock.Buffer instance allocated with memAlloc.

public static VkWriteDescriptorSetInlineUniformBlock
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkWriteDescriptorSetInlineUniformBlock instance allocated on the specified MemoryStack.

public static VkWriteDescriptorSetInlineUniformBlock.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static int
ndataSize(long struct)

Unsafe version of dataSize.

public static void
ndataSize(long struct, int value)

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

public static ByteBuffer
npData(long struct)

Unsafe version of pData.

public static void
npData(long struct, ByteBuffer value)

Unsafe version of pData.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public ByteBuffer
pData()

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

public VkWriteDescriptorSetInlineUniformBlock
pData(ByteBuffer value)

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

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkWriteDescriptorSetInlineUniformBlock
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkWriteDescriptorSetInlineUniformBlock

Returns:

this struct
set
(VkWriteDescriptorSetInlineUniformBlock
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkWriteDescriptorSetInlineUniformBlock
sType(int value)

Sets the specified value to the sType field.

public VkWriteDescriptorSetInlineUniformBlock
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

DATASIZEback to summary
public static final int DATASIZE

The struct member offsets.

PDATAback to summary
public static final int PDATA

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkWriteDescriptorSetInlineUniformBlockback to summary
protected VkWriteDescriptorSetInlineUniformBlock(long address, ByteBuffer container)
VkWriteDescriptorSetInlineUniformBlockback to summary
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 Detail

callocback to summary
public static VkWriteDescriptorSetInlineUniformBlock calloc()

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

callocback to summary
public static VkWriteDescriptorSetInlineUniformBlock.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkWriteDescriptorSetInlineUniformBlock calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkWriteDescriptorSetInlineUniformBlock.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VkWriteDescriptorSetInlineUniformBlock create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkWriteDescriptorSetInlineUniformBlock create()

Returns a new VkWriteDescriptorSetInlineUniformBlock instance allocated with BufferUtils.

createback to summary
public static VkWriteDescriptorSetInlineUniformBlock create(long address)

Returns a new VkWriteDescriptorSetInlineUniformBlock instance for the specified memory address.

createback to summary
public static VkWriteDescriptorSetInlineUniformBlock.Buffer create(int capacity)

Returns a new VkWriteDescriptorSetInlineUniformBlock.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkWriteDescriptorSetInlineUniformBlock.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkWriteDescriptorSetInlineUniformBlock createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkWriteDescriptorSetInlineUniformBlock.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
dataSizeback to summary
public int dataSize()

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

Annotations
@NativeType:uint32_t
mallocback to summary
public static VkWriteDescriptorSetInlineUniformBlock malloc()

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

mallocback to summary
public static VkWriteDescriptorSetInlineUniformBlock.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkWriteDescriptorSetInlineUniformBlock malloc(MemoryStack stack)

Returns a new VkWriteDescriptorSetInlineUniformBlock instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkWriteDescriptorSetInlineUniformBlock.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ndataSizeback to summary
public static int ndataSize(long struct)

Unsafe version of dataSize.

ndataSizeback to summary
public static void ndataSize(long struct, int value)

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

npDataback to summary
public static ByteBuffer npData(long struct)

Unsafe version of pData.

npDataback to summary
public static void npData(long struct, ByteBuffer value)

Unsafe version of pData.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pDataback to summary
public ByteBuffer pData()

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

Annotations
@NativeType:void const *
pDataback to summary
public VkWriteDescriptorSetInlineUniformBlock pData(ByteBuffer value)

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

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkWriteDescriptorSetInlineUniformBlock pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkWriteDescriptorSetInlineUniformBlock set(VkWriteDescriptorSetInlineUniformBlock src)

Copies the specified struct data to this struct.

Parameters
src:VkWriteDescriptorSetInlineUniformBlock

the source struct

Returns:VkWriteDescriptorSetInlineUniformBlock

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkWriteDescriptorSetInlineUniformBlock sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkWriteDescriptorSetInlineUniformBlock sType$Default()

Sets the STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET_INLINE_UNIFORM_BLOCK value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkWriteDescriptorSetInlineUniformBlock.Buffer

extends StructBuffer<VkWriteDescriptorSetInlineUniformBlock, VkWriteDescriptorSetInlineUniformBlock.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkWriteDescriptorSetInlineUniformBlockEXT.Buffer

An array of VkWriteDescriptorSetInlineUniformBlock structs.

Field Summary

Modifier and TypeField and Description
private static final VkWriteDescriptorSetInlineUniformBlock

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkWriteDescriptorSetInlineUniformBlock.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int
protected VkWriteDescriptorSetInlineUniformBlock
public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the VkWriteDescriptorSetInlineUniformBlock#pData field.
pData
()

public VkWriteDescriptorSetInlineUniformBlock.Buffer
pData(ByteBuffer value)

Sets the address of the specified ByteBuffer to the VkWriteDescriptorSetInlineUniformBlock#pData field.

public long

Returns:

the value of the VkWriteDescriptorSetInlineUniformBlock#pNext field.
pNext
()

public VkWriteDescriptorSetInlineUniformBlock.Buffer
pNext(long value)

Sets the specified value to the VkWriteDescriptorSetInlineUniformBlock#pNext field.

protected VkWriteDescriptorSetInlineUniformBlock.Buffer
public int

Returns:

the value of the VkWriteDescriptorSetInlineUniformBlock#sType field.
sType
()

public VkWriteDescriptorSetInlineUniformBlock.Buffer
sType(int value)

Sets the specified value to the VkWriteDescriptorSetInlineUniformBlock#sType field.

public VkWriteDescriptorSetInlineUniformBlock.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkWriteDescriptorSetInlineUniformBlock ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkWriteDescriptorSetInlineUniformBlock.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkWriteDescriptorSetInlineUniformBlock#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

dataSizeback to summary
public int dataSize()
Returns:int

the value of the VkWriteDescriptorSetInlineUniformBlock#dataSize field.

Annotations
@NativeType:uint32_t
getElementFactoryback to summary
protected VkWriteDescriptorSetInlineUniformBlock getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pDataback to summary
public ByteBuffer pData()
Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the VkWriteDescriptorSetInlineUniformBlock#pData field.

Annotations
@NativeType:void const *
pDataback to summary
public VkWriteDescriptorSetInlineUniformBlock.Buffer pData(ByteBuffer value)

Sets the address of the specified ByteBuffer to the VkWriteDescriptorSetInlineUniformBlock#pData field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkWriteDescriptorSetInlineUniformBlock#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkWriteDescriptorSetInlineUniformBlock.Buffer pNext(long value)

Sets the specified value to the VkWriteDescriptorSetInlineUniformBlock#pNext field.

selfback to summary
protected VkWriteDescriptorSetInlineUniformBlock.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkWriteDescriptorSetInlineUniformBlock#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkWriteDescriptorSetInlineUniformBlock.Buffer sType(int value)

Sets the specified value to the VkWriteDescriptorSetInlineUniformBlock#sType field.

sType$Defaultback to summary
public VkWriteDescriptorSetInlineUniformBlock.Buffer sType$Default()

Sets the STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET_INLINE_UNIFORM_BLOCK value to the VkWriteDescriptorSetInlineUniformBlock#sType field.