Package org.lwjgl.openxr

Class XrWorldMeshRequestCompletionML

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrWorldMeshRequestCompletionML>

org.lwjgl.openxr.XrWorldMeshRequestCompletionML

All Implemented Interfaces:

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

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

Block Request Completion.

Future Return Codes

futureResult values:

Success

• SUCCESS
• SESSION_LOSS_PENDING

Failure

• ERROR_RUNTIME_FAILURE
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_OUT_OF_MEMORY
• ERROR_LIMIT_REACHED

Valid Usage (Implicit)

• The XR_ML_world_mesh_detection extension must be enabled prior to using XrWorldMeshRequestCompletionML
• type must be TYPE_WORLD_MESH_REQUEST_COMPLETION_ML
• next must be NULL or a valid pointer to the next structure in a structure chain
• futureResult must be a valid XrResult value
• blocks must be a pointer to an array of blockCount XrWorldMeshBlockML structures
• The blockCount parameter must be greater than 0

See Also

XrWorldMeshBlockML, RequestWorldMeshCompleteML

Layout

 struct XrWorldMeshRequestCompletionML {
     XrStructureType type();
     void * next();
     XrResult futureResult();
     uint32_t blockCount();
     XrWorldMeshBlockML * blocks();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrWorldMeshRequestCompletionML.Buffer	An array of XrWorldMeshRequestCompletionML 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	BLOCKCOUNT	The struct member offsets.
static final int	BLOCKS	The struct member offsets.
static final int	FUTURERESULT	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TYPE	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
XrWorldMeshRequestCompletionML(ByteBuffer container)	Creates a XrWorldMeshRequestCompletionML instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
int	blockCount()	a uint32_t that must match XrWorldMeshGetInfoML::blockCount parameter.
XrWorldMeshBlockML.Buffer	blocks()	an array of XrWorldMeshBlockML structures containing the vertex data pointers.
XrWorldMeshRequestCompletionML	blocks(XrWorldMeshBlockML.Buffer value)	Sets the address of the specified XrWorldMeshBlockML.Buffer to the blocks() field.
static XrWorldMeshRequestCompletionML	calloc()	Returns a new XrWorldMeshRequestCompletionML instance allocated with memCalloc.
static XrWorldMeshRequestCompletionML.Buffer	calloc(int capacity)	Returns a new XrWorldMeshRequestCompletionML.Buffer instance allocated with memCalloc.
static XrWorldMeshRequestCompletionML.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrWorldMeshRequestCompletionML.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrWorldMeshRequestCompletionML	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrWorldMeshRequestCompletionML instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrWorldMeshRequestCompletionML	create()	Returns a new XrWorldMeshRequestCompletionML instance allocated with BufferUtils.
static XrWorldMeshRequestCompletionML.Buffer	create(int capacity)	Returns a new XrWorldMeshRequestCompletionML.Buffer instance allocated with BufferUtils.
static XrWorldMeshRequestCompletionML	create(long address)	Returns a new XrWorldMeshRequestCompletionML instance for the specified memory address.
static XrWorldMeshRequestCompletionML.Buffer	create(long address, int capacity)	Create a XrWorldMeshRequestCompletionML.Buffer instance at the specified memory.
static XrWorldMeshRequestCompletionML	create(XrFutureCompletionBaseHeaderEXT value)	Downcasts the specified XrFutureCompletionBaseHeaderEXT instance to XrWorldMeshRequestCompletionML.
static XrWorldMeshRequestCompletionML.Buffer	create(XrFutureCompletionBaseHeaderEXT.Buffer value)	Downcasts the specified XrFutureCompletionBaseHeaderEXT.Buffer instance to XrWorldMeshRequestCompletionML.Buffer.
static @Nullable XrWorldMeshRequestCompletionML	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrWorldMeshRequestCompletionML.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	futureResult()	the XrResult of the asynchronous operation.
XrWorldMeshRequestCompletionML	futureResult(int value)	Sets the specified value to the futureResult() field.
static XrWorldMeshRequestCompletionML	malloc()	Returns a new XrWorldMeshRequestCompletionML instance allocated with memAlloc.
static XrWorldMeshRequestCompletionML.Buffer	malloc(int capacity)	Returns a new XrWorldMeshRequestCompletionML.Buffer instance allocated with memAlloc.
static XrWorldMeshRequestCompletionML.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrWorldMeshRequestCompletionML.Buffer instance allocated on the specified MemoryStack.
static XrWorldMeshRequestCompletionML	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrWorldMeshRequestCompletionML instance allocated on the specified MemoryStack.
static int	nblockCount(long struct)	Unsafe version of blockCount().
static void	nblockCount(long struct, int value)	Sets the specified value to the blockCount field of the specified struct.
static XrWorldMeshBlockML.Buffer	nblocks(long struct)	Unsafe version of blocks().
static void	nblocks(long struct, XrWorldMeshBlockML.Buffer value)	Unsafe version of blocks.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrWorldMeshRequestCompletionML	next(long value)	Sets the specified value to the next() field.
static int	nfutureResult(long struct)	Unsafe version of futureResult().
static void	nfutureResult(long struct, int value)	Unsafe version of futureResult.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrWorldMeshRequestCompletionML	set(int type, long next, int futureResult, XrWorldMeshBlockML.Buffer blocks)	Initializes this struct with the specified values.
XrWorldMeshRequestCompletionML	set(XrWorldMeshRequestCompletionML src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrWorldMeshRequestCompletionML	type(int value)	Sets the specified value to the type() field.
XrWorldMeshRequestCompletionML	type$Default()	Sets the TYPE_WORLD_MESH_REQUEST_COMPLETION_ML value to the type() 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.

TYPE

public static final int TYPE

The struct member offsets.

NEXT

public static final int NEXT

The struct member offsets.

FUTURERESULT

public static final int FUTURERESULT

The struct member offsets.

BLOCKCOUNT

public static final int BLOCKCOUNT

The struct member offsets.

BLOCKS

public static final int BLOCKS

The struct member offsets.

Constructor Details

XrWorldMeshRequestCompletionML

public XrWorldMeshRequestCompletionML(ByteBuffer container)

Creates a XrWorldMeshRequestCompletionML 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<XrWorldMeshRequestCompletionML>

type

public int type()

the XrStructureType of this structure.

next

public long next()

NULL or a pointer to the next structure in a structure chain.

futureResult

public int futureResult()

the XrResult of the asynchronous operation.

blockCount

public int blockCount()

a uint32_t that must match XrWorldMeshGetInfoML::blockCount parameter.

blocks

public XrWorldMeshBlockML.Buffer blocks()

an array of XrWorldMeshBlockML structures containing the vertex data pointers.

type

public XrWorldMeshRequestCompletionML type(int value)

Sets the specified value to the type() field.

type$Default

public XrWorldMeshRequestCompletionML type$Default()

Sets the TYPE_WORLD_MESH_REQUEST_COMPLETION_ML value to the type() field.

next

public XrWorldMeshRequestCompletionML next(long value)

Sets the specified value to the next() field.

futureResult

public XrWorldMeshRequestCompletionML futureResult(int value)

Sets the specified value to the futureResult() field.

blocks

public XrWorldMeshRequestCompletionML blocks(XrWorldMeshBlockML.Buffer value)

Sets the address of the specified XrWorldMeshBlockML.Buffer to the blocks() field.

set

public XrWorldMeshRequestCompletionML set(int type,
 long next,
 int futureResult,
 XrWorldMeshBlockML.Buffer blocks)

Initializes this struct with the specified values.

set

public XrWorldMeshRequestCompletionML set(XrWorldMeshRequestCompletionML src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrWorldMeshRequestCompletionML malloc()

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

calloc

public static XrWorldMeshRequestCompletionML calloc()

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

create

public static XrWorldMeshRequestCompletionML create()

Returns a new XrWorldMeshRequestCompletionML instance allocated with BufferUtils.

create

public static XrWorldMeshRequestCompletionML create(long address)

Returns a new XrWorldMeshRequestCompletionML instance for the specified memory address.

createSafe

public static @Nullable XrWorldMeshRequestCompletionML createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrWorldMeshRequestCompletionML create(XrFutureCompletionBaseHeaderEXT value)

Downcasts the specified XrFutureCompletionBaseHeaderEXT instance to XrWorldMeshRequestCompletionML.

malloc

public static XrWorldMeshRequestCompletionML.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrWorldMeshRequestCompletionML.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrWorldMeshRequestCompletionML.Buffer create(int capacity)

Returns a new XrWorldMeshRequestCompletionML.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrWorldMeshRequestCompletionML.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

create

public static XrWorldMeshRequestCompletionML.Buffer create(XrFutureCompletionBaseHeaderEXT.Buffer value)

Downcasts the specified XrFutureCompletionBaseHeaderEXT.Buffer instance to XrWorldMeshRequestCompletionML.Buffer.

malloc

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

Returns a new XrWorldMeshRequestCompletionML instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ntype

public static int ntype(long struct)

Unsafe version of type().

nnext

public static long nnext(long struct)

Unsafe version of next().

nfutureResult

public static int nfutureResult(long struct)

Unsafe version of futureResult().

nblockCount

public static int nblockCount(long struct)

Unsafe version of blockCount().

nblocks

public static XrWorldMeshBlockML.Buffer nblocks(long struct)

Unsafe version of blocks().

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

nnext

public static void nnext(long struct,
 long value)

Unsafe version of next.

nfutureResult

public static void nfutureResult(long struct,
 int value)

Unsafe version of futureResult.

nblockCount

public static void nblockCount(long struct,
 int value)

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

nblocks

public static void nblocks(long struct,
 XrWorldMeshBlockML.Buffer value)

Unsafe version of blocks.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate