Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkMicromapVersionInfoEXT

extends Struct<VkMicromapVersionInfoEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Micromap version information.
Description
Note

pVersionData is a pointer to an array of 2×UUID_SIZE uint8_t values instead of two UUID_SIZE arrays as the expected use case for this member is to be pointed at the header of a previously serialized micromap (via CmdCopyMicromapToMemoryEXT or CopyMicromapToMemoryEXT) that is loaded in memory. Using arrays would necessitate extra memory copies of the UUIDs.

Valid Usage (Implicit)
See Also

GetDeviceMicromapCompatibilityEXT

Layout


struct VkMicromapVersionInfoEXT {
    VkStructureType sType;
    void const * pNext;
    uint8_t const * pVersionData;
}

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
PNEXT

The struct member offsets.

public static final int
PVERSIONDATA

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
VkMicromapVersionInfoEXT(long address, ByteBuffer container)

public
VkMicromapVersionInfoEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkMicromapVersionInfoEXT
calloc()

Returns a new VkMicromapVersionInfoEXT instance allocated with memCalloc.

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

Returns a new VkMicromapVersionInfoEXT.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkMicromapVersionInfoEXT
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 VkMicromapVersionInfoEXT
create()

Returns a new VkMicromapVersionInfoEXT instance allocated with BufferUtils.

public static VkMicromapVersionInfoEXT
create(long address)

Returns a new VkMicromapVersionInfoEXT instance for the specified memory address.

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

Returns a new VkMicromapVersionInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkMicromapVersionInfoEXT.Buffer instance at the specified memory.

public static VkMicromapVersionInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkMicromapVersionInfoEXT
malloc()

Returns a new VkMicromapVersionInfoEXT instance allocated with memAlloc.

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

Returns a new VkMicromapVersionInfoEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkMicromapVersionInfoEXT instance allocated on the specified MemoryStack.

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

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

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static ByteBuffer
npVersionData(long struct, int capacity)

Unsafe version of pVersionData.

public static void
npVersionData(long struct, ByteBuffer value)

Unsafe version of pVersionData.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkMicromapVersionInfoEXT
pNext(long value)

Sets the specified value to the pNext field.

public ByteBuffer

Returns:

a pointer to the version header of a micromap as defined in CmdCopyMicromapToMemoryEXT
pVersionData
(int
the number of elements in the returned buffer
capacity
)

public VkMicromapVersionInfoEXT
pVersionData(ByteBuffer value)

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

public VkMicromapVersionInfoEXT
set(int sType, long pNext, ByteBuffer pVersionData)

Initializes this struct with the specified values.

public VkMicromapVersionInfoEXT

Returns:

this struct
set
(VkMicromapVersionInfoEXT
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 VkMicromapVersionInfoEXT
sType(int value)

Sets the specified value to the sType field.

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

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

PVERSIONDATAback to summary
public static final int PVERSIONDATA

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

VkMicromapVersionInfoEXTback to summary
protected VkMicromapVersionInfoEXT(long address, ByteBuffer container)
VkMicromapVersionInfoEXTback to summary
public VkMicromapVersionInfoEXT(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkMicromapVersionInfoEXT calloc(MemoryStack stack)

Returns a new VkMicromapVersionInfoEXT 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 VkMicromapVersionInfoEXT.Buffer calloc(int capacity, MemoryStack stack)

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

Returns a new VkMicromapVersionInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkMicromapVersionInfoEXT create(long address)

Returns a new VkMicromapVersionInfoEXT instance for the specified memory address.

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

Returns a new VkMicromapVersionInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkMicromapVersionInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkMicromapVersionInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkMicromapVersionInfoEXT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkMicromapVersionInfoEXT malloc(MemoryStack stack)

Returns a new VkMicromapVersionInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

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.

npVersionDataback to summary
public static ByteBuffer npVersionData(long struct, int capacity)

Unsafe version of pVersionData.

npVersionDataback to summary
public static void npVersionData(long struct, ByteBuffer value)

Unsafe version of pVersionData.

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.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

pVersionDataback to summary
public ByteBuffer pVersionData(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

a pointer to the version header of a micromap as defined in CmdCopyMicromapToMemoryEXT

Annotations
@NativeType:uint8_t const *
pVersionDataback to summary
public VkMicromapVersionInfoEXT pVersionData(ByteBuffer value)

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

setback to summary
public VkMicromapVersionInfoEXT set(int sType, long pNext, ByteBuffer pVersionData)

Initializes this struct with the specified values.

setback to summary
public VkMicromapVersionInfoEXT set(VkMicromapVersionInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkMicromapVersionInfoEXT

the source struct

Returns:VkMicromapVersionInfoEXT

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 VkMicromapVersionInfoEXT sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_MICROMAP_VERSION_INFO_EXT 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 VkMicromapVersionInfoEXT.Buffer

extends StructBuffer<VkMicromapVersionInfoEXT, VkMicromapVersionInfoEXT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkMicromapVersionInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkMicromapVersionInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkMicromapVersionInfoEXT.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
protected VkMicromapVersionInfoEXT
public long

Returns:

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

public VkMicromapVersionInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkMicromapVersionInfoEXT#pNext field.

public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the VkMicromapVersionInfoEXT#pVersionData field.
pVersionData
(int
the number of elements in the returned buffer
capacity
)

public VkMicromapVersionInfoEXT.Buffer
pVersionData(ByteBuffer value)

Sets the address of the specified ByteBuffer to the VkMicromapVersionInfoEXT#pVersionData field.

protected VkMicromapVersionInfoEXT.Buffer
public int

Returns:

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

public VkMicromapVersionInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkMicromapVersionInfoEXT#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkMicromapVersionInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkMicromapVersionInfoEXT.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 VkMicromapVersionInfoEXT#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

getElementFactoryback to summary
protected VkMicromapVersionInfoEXT getElementFactory()

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

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkMicromapVersionInfoEXT#pNext field.

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

Sets the specified value to the VkMicromapVersionInfoEXT#pNext field.

pVersionDataback to summary
public ByteBuffer pVersionData(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the VkMicromapVersionInfoEXT#pVersionData field.

Annotations
@NativeType:uint8_t const *
pVersionDataback to summary
public VkMicromapVersionInfoEXT.Buffer pVersionData(ByteBuffer value)

Sets the address of the specified ByteBuffer to the VkMicromapVersionInfoEXT#pVersionData field.

selfback to summary
protected VkMicromapVersionInfoEXT.Buffer self()

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

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

the value of the VkMicromapVersionInfoEXT#sType field.

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

Sets the specified value to the VkMicromapVersionInfoEXT#sType field.

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

Sets the STRUCTURE_TYPE_MICROMAP_VERSION_INFO_EXT value to the VkMicromapVersionInfoEXT#sType field.