Package org.lwjgl.openxr

Class XrSpatialAnchorsQueryCompletionML

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSpatialAnchorsQueryCompletionML>

org.lwjgl.openxr.XrSpatialAnchorsQueryCompletionML

All Implemented Interfaces:

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

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

Completion structure to retrieve the result of the anchor query.

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
• ERROR_VALIDATION_FAILURE
• ERROR_SPACE_NOT_LOCATABLE_EXT
• ERROR_SPATIAL_ANCHORS_SPACE_NOT_LOCATABLE_ML
• ERROR_SPATIAL_ANCHORS_NOT_LOCALIZED_ML

Valid Usage (Implicit)

• The XR_ML_spatial_anchors_storage extension must be enabled prior to using XrSpatialAnchorsQueryCompletionML
• type must be TYPE_SPATIAL_ANCHORS_QUERY_COMPLETION_ML
• next must be NULL or a valid pointer to the next structure in a structure chain
• If futureResult is not 0, futureResult must be a valid XrResult value
• If uuidCapacityInput is not 0, uuids must be a pointer to an array of uuidCapacityInput XrUuidEXT structures

See Also

XrUuidEXT, QuerySpatialAnchorsAsyncML, QuerySpatialAnchorsCompleteML

Layout

 struct XrSpatialAnchorsQueryCompletionML {
     XrStructureType type();
     void * next();
     XrResult futureResult();
     uint32_t uuidCapacityInput();
     uint32_t uuidCountOutput();
     XrUuidEXT * uuids();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrSpatialAnchorsQueryCompletionML.Buffer	An array of XrSpatialAnchorsQueryCompletionML 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	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.
static final int	UUIDCAPACITYINPUT	The struct member offsets.
static final int	UUIDCOUNTOUTPUT	The struct member offsets.
static final int	UUIDS	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
XrSpatialAnchorsQueryCompletionML(ByteBuffer container)	Creates a XrSpatialAnchorsQueryCompletionML instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrSpatialAnchorsQueryCompletionML	calloc()	Returns a new XrSpatialAnchorsQueryCompletionML instance allocated with memCalloc.
static XrSpatialAnchorsQueryCompletionML.Buffer	calloc(int capacity)	Returns a new XrSpatialAnchorsQueryCompletionML.Buffer instance allocated with memCalloc.
static XrSpatialAnchorsQueryCompletionML.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorsQueryCompletionML.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSpatialAnchorsQueryCompletionML	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorsQueryCompletionML instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSpatialAnchorsQueryCompletionML	create()	Returns a new XrSpatialAnchorsQueryCompletionML instance allocated with BufferUtils.
static XrSpatialAnchorsQueryCompletionML.Buffer	create(int capacity)	Returns a new XrSpatialAnchorsQueryCompletionML.Buffer instance allocated with BufferUtils.
static XrSpatialAnchorsQueryCompletionML	create(long address)	Returns a new XrSpatialAnchorsQueryCompletionML instance for the specified memory address.
static XrSpatialAnchorsQueryCompletionML.Buffer	create(long address, int capacity)	Create a XrSpatialAnchorsQueryCompletionML.Buffer instance at the specified memory.
static XrSpatialAnchorsQueryCompletionML	create(XrFutureCompletionBaseHeaderEXT value)	Downcasts the specified XrFutureCompletionBaseHeaderEXT instance to XrSpatialAnchorsQueryCompletionML.
static XrSpatialAnchorsQueryCompletionML.Buffer	create(XrFutureCompletionBaseHeaderEXT.Buffer value)	Downcasts the specified XrFutureCompletionBaseHeaderEXT.Buffer instance to XrSpatialAnchorsQueryCompletionML.Buffer.
static @Nullable XrSpatialAnchorsQueryCompletionML	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSpatialAnchorsQueryCompletionML.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	futureResult()	the XrResult of the asynchronous operation.
XrSpatialAnchorsQueryCompletionML	futureResult(int value)	Sets the specified value to the futureResult() field.
static XrSpatialAnchorsQueryCompletionML	malloc()	Returns a new XrSpatialAnchorsQueryCompletionML instance allocated with memAlloc.
static XrSpatialAnchorsQueryCompletionML.Buffer	malloc(int capacity)	Returns a new XrSpatialAnchorsQueryCompletionML.Buffer instance allocated with memAlloc.
static XrSpatialAnchorsQueryCompletionML.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorsQueryCompletionML.Buffer instance allocated on the specified MemoryStack.
static XrSpatialAnchorsQueryCompletionML	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorsQueryCompletionML instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSpatialAnchorsQueryCompletionML	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.
static int	nuuidCapacityInput(long struct)	Unsafe version of uuidCapacityInput().
static void	nuuidCapacityInput(long struct, int value)	Sets the specified value to the uuidCapacityInput field of the specified struct.
static int	nuuidCountOutput(long struct)	Unsafe version of uuidCountOutput().
static void	nuuidCountOutput(long struct, int value)	Unsafe version of uuidCountOutput.
static @Nullable XrUuidEXT.Buffer	nuuids(long struct)	Unsafe version of uuids().
static void	nuuids(long struct, @Nullable XrUuidEXT.Buffer value)	Unsafe version of uuids.
XrSpatialAnchorsQueryCompletionML	set(int type, long next, int futureResult, int uuidCapacityInput, int uuidCountOutput, @Nullable XrUuidEXT.Buffer uuids)	Initializes this struct with the specified values.
XrSpatialAnchorsQueryCompletionML	set(XrSpatialAnchorsQueryCompletionML src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrSpatialAnchorsQueryCompletionML	type(int value)	Sets the specified value to the type() field.
XrSpatialAnchorsQueryCompletionML	type$Default()	Sets the TYPE_SPATIAL_ANCHORS_QUERY_COMPLETION_ML value to the type() field.
int	uuidCapacityInput()	the capacity of the uuids array, or 0 to indicate a request to retrieve the required capacity.
XrSpatialAnchorsQueryCompletionML	uuidCapacityInput(int value)	Sets the specified value to the uuidCapacityInput() field.
int	uuidCountOutput()	the number of elements populated in uuids, or the required capacity in the case that uuidCapacityInput is insufficient.
XrSpatialAnchorsQueryCompletionML	uuidCountOutput(int value)	Sets the specified value to the uuidCountOutput() field.
@Nullable XrUuidEXT.Buffer	uuids()	an array of XrUuidEXT.
XrSpatialAnchorsQueryCompletionML	uuids(@Nullable XrUuidEXT.Buffer value)	Sets the address of the specified XrUuidEXT.Buffer to the uuids() field.

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.

UUIDCAPACITYINPUT

public static final int UUIDCAPACITYINPUT

The struct member offsets.

UUIDCOUNTOUTPUT

public static final int UUIDCOUNTOUTPUT

The struct member offsets.

UUIDS

public static final int UUIDS

The struct member offsets.

Constructor Details

XrSpatialAnchorsQueryCompletionML

public XrSpatialAnchorsQueryCompletionML(ByteBuffer container)

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

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.

uuidCapacityInput

public int uuidCapacityInput()

the capacity of the uuids array, or 0 to indicate a request to retrieve the required capacity.

uuidCountOutput

public int uuidCountOutput()

the number of elements populated in uuids, or the required capacity in the case that uuidCapacityInput is insufficient.

uuids

public @Nullable XrUuidEXT.Buffer uuids()

an array of XrUuidEXT.

type

public XrSpatialAnchorsQueryCompletionML type(int value)

Sets the specified value to the type() field.

type$Default

public XrSpatialAnchorsQueryCompletionML type$Default()

Sets the TYPE_SPATIAL_ANCHORS_QUERY_COMPLETION_ML value to the type() field.

next

public XrSpatialAnchorsQueryCompletionML next(long value)

Sets the specified value to the next() field.

futureResult

public XrSpatialAnchorsQueryCompletionML futureResult(int value)

Sets the specified value to the futureResult() field.

uuidCapacityInput

public XrSpatialAnchorsQueryCompletionML uuidCapacityInput(int value)

Sets the specified value to the uuidCapacityInput() field.

uuidCountOutput

public XrSpatialAnchorsQueryCompletionML uuidCountOutput(int value)

Sets the specified value to the uuidCountOutput() field.

uuids

public XrSpatialAnchorsQueryCompletionML uuids(@Nullable XrUuidEXT.Buffer value)

Sets the address of the specified XrUuidEXT.Buffer to the uuids() field.

set

public XrSpatialAnchorsQueryCompletionML set(int type,
 long next,
 int futureResult,
 int uuidCapacityInput,
 int uuidCountOutput,
 @Nullable XrUuidEXT.Buffer uuids)

Initializes this struct with the specified values.

set

public XrSpatialAnchorsQueryCompletionML set(XrSpatialAnchorsQueryCompletionML src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSpatialAnchorsQueryCompletionML malloc()

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

calloc

public static XrSpatialAnchorsQueryCompletionML calloc()

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

create

public static XrSpatialAnchorsQueryCompletionML create()

Returns a new XrSpatialAnchorsQueryCompletionML instance allocated with BufferUtils.

create

public static XrSpatialAnchorsQueryCompletionML create(long address)

Returns a new XrSpatialAnchorsQueryCompletionML instance for the specified memory address.

createSafe

public static @Nullable XrSpatialAnchorsQueryCompletionML createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrSpatialAnchorsQueryCompletionML create(XrFutureCompletionBaseHeaderEXT value)

Downcasts the specified XrFutureCompletionBaseHeaderEXT instance to XrSpatialAnchorsQueryCompletionML.

malloc

public static XrSpatialAnchorsQueryCompletionML.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSpatialAnchorsQueryCompletionML.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSpatialAnchorsQueryCompletionML.Buffer create(int capacity)

Returns a new XrSpatialAnchorsQueryCompletionML.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSpatialAnchorsQueryCompletionML.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

create

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

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

malloc

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

Returns a new XrSpatialAnchorsQueryCompletionML instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nuuidCapacityInput

public static int nuuidCapacityInput(long struct)

Unsafe version of uuidCapacityInput().

nuuidCountOutput

public static int nuuidCountOutput(long struct)

Unsafe version of uuidCountOutput().

nuuids

public static @Nullable XrUuidEXT.Buffer nuuids(long struct)

Unsafe version of uuids().

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.

nuuidCapacityInput

public static void nuuidCapacityInput(long struct,
 int value)

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

nuuidCountOutput

public static void nuuidCountOutput(long struct,
 int value)

Unsafe version of uuidCountOutput.

nuuids

public static void nuuids(long struct,
 @Nullable XrUuidEXT.Buffer value)

Unsafe version of uuids.