Package org.lwjgl.openxr

Class XrCreateSpatialAnchorsCompletionML

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrCreateSpatialAnchorsCompletionML>

org.lwjgl.openxr.XrCreateSpatialAnchorsCompletionML

All Implemented Interfaces:

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

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

Completion struct to retrieve the result of the anchor creation.

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_SPATIAL_ANCHORS_SPACE_NOT_LOCATABLE_ML
• ERROR_SPATIAL_ANCHORS_OUT_OF_MAP_BOUNDS_ML

Valid Usage (Implicit)

• The XR_ML_spatial_anchors extension must be enabled prior to using XrCreateSpatialAnchorsCompletionML
• type must be TYPE_CREATE_SPATIAL_ANCHORS_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 spaceCount is not 0, spaces must be a pointer to an array of spaceCount XrSpace handles

See Also

CreateSpatialAnchorsCompleteML

Layout

 struct XrCreateSpatialAnchorsCompletionML {
     XrStructureType type();
     void * next();
     XrResult futureResult();
     uint32_t spaceCount();
     XrSpace * spaces();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrCreateSpatialAnchorsCompletionML	calloc()	Returns a new XrCreateSpatialAnchorsCompletionML instance allocated with memCalloc.
static XrCreateSpatialAnchorsCompletionML.Buffer	calloc(int capacity)	Returns a new XrCreateSpatialAnchorsCompletionML.Buffer instance allocated with memCalloc.
static XrCreateSpatialAnchorsCompletionML.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCreateSpatialAnchorsCompletionML.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCreateSpatialAnchorsCompletionML	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCreateSpatialAnchorsCompletionML instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCreateSpatialAnchorsCompletionML	create()	Returns a new XrCreateSpatialAnchorsCompletionML instance allocated with BufferUtils.
static XrCreateSpatialAnchorsCompletionML.Buffer	create(int capacity)	Returns a new XrCreateSpatialAnchorsCompletionML.Buffer instance allocated with BufferUtils.
static XrCreateSpatialAnchorsCompletionML	create(long address)	Returns a new XrCreateSpatialAnchorsCompletionML instance for the specified memory address.
static XrCreateSpatialAnchorsCompletionML.Buffer	create(long address, int capacity)	Create a XrCreateSpatialAnchorsCompletionML.Buffer instance at the specified memory.
static XrCreateSpatialAnchorsCompletionML	create(XrFutureCompletionBaseHeaderEXT value)	Downcasts the specified XrFutureCompletionBaseHeaderEXT instance to XrCreateSpatialAnchorsCompletionML.
static XrCreateSpatialAnchorsCompletionML.Buffer	create(XrFutureCompletionBaseHeaderEXT.Buffer value)	Downcasts the specified XrFutureCompletionBaseHeaderEXT.Buffer instance to XrCreateSpatialAnchorsCompletionML.Buffer.
static @Nullable XrCreateSpatialAnchorsCompletionML	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrCreateSpatialAnchorsCompletionML.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	futureResult()	the XrResult of the create spatial anchor operation.
XrCreateSpatialAnchorsCompletionML	futureResult(int value)	Sets the specified value to the futureResult() field.
static XrCreateSpatialAnchorsCompletionML	malloc()	Returns a new XrCreateSpatialAnchorsCompletionML instance allocated with memAlloc.
static XrCreateSpatialAnchorsCompletionML.Buffer	malloc(int capacity)	Returns a new XrCreateSpatialAnchorsCompletionML.Buffer instance allocated with memAlloc.
static XrCreateSpatialAnchorsCompletionML.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCreateSpatialAnchorsCompletionML.Buffer instance allocated on the specified MemoryStack.
static XrCreateSpatialAnchorsCompletionML	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCreateSpatialAnchorsCompletionML instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrCreateSpatialAnchorsCompletionML	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	nspaceCount(long struct)	Unsafe version of spaceCount().
static void	nspaceCount(long struct, int value)	Sets the specified value to the spaceCount field of the specified struct.
static @Nullable org.lwjgl.PointerBuffer	nspaces(long struct)	Unsafe version of spaces.
static void	nspaces(long struct, @Nullable org.lwjgl.PointerBuffer value)	Unsafe version of spaces.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrCreateSpatialAnchorsCompletionML	set(int type, long next, int futureResult, int spaceCount, @Nullable org.lwjgl.PointerBuffer spaces)	Initializes this struct with the specified values.
XrCreateSpatialAnchorsCompletionML	set(XrCreateSpatialAnchorsCompletionML src)	Copies the specified struct data to this struct.
int	sizeof()
int	spaceCount()	the number of elements in the spaces array.
XrCreateSpatialAnchorsCompletionML	spaceCount(int value)	Sets the specified value to the spaceCount() field.
@Nullable org.lwjgl.PointerBuffer	spaces()	an array of XrSpace values to populate with the results of the anchor creation.
XrCreateSpatialAnchorsCompletionML	spaces(@Nullable org.lwjgl.PointerBuffer value)	Sets the address of the specified PointerBuffer to the spaces() field.
int	type()	the XrStructureType of this structure.
XrCreateSpatialAnchorsCompletionML	type(int value)	Sets the specified value to the type() field.
XrCreateSpatialAnchorsCompletionML	type$Default()	Sets the TYPE_CREATE_SPATIAL_ANCHORS_COMPLETION_ML value to the type() 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.

SPACECOUNT

public static final int SPACECOUNT

The struct member offsets.

SPACES

public static final int SPACES

The struct member offsets.

Constructor Details

XrCreateSpatialAnchorsCompletionML

public XrCreateSpatialAnchorsCompletionML(ByteBuffer container)

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

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 create spatial anchor operation.

spaceCount

public int spaceCount()

the number of elements in the spaces array. This must match the number of spaces requested to be created.

spaces

public @Nullable org.lwjgl.PointerBuffer spaces()

an array of XrSpace values to populate with the results of the anchor creation. If creation failed, the XrSpace values must be set to NULL_HANDLE.

type

public XrCreateSpatialAnchorsCompletionML type(int value)

Sets the specified value to the type() field.

type$Default

public XrCreateSpatialAnchorsCompletionML type$Default()

Sets the TYPE_CREATE_SPATIAL_ANCHORS_COMPLETION_ML value to the type() field.

next

public XrCreateSpatialAnchorsCompletionML next(long value)

Sets the specified value to the next() field.

futureResult

public XrCreateSpatialAnchorsCompletionML futureResult(int value)

Sets the specified value to the futureResult() field.

spaceCount

public XrCreateSpatialAnchorsCompletionML spaceCount(int value)

Sets the specified value to the spaceCount() field.

spaces

public XrCreateSpatialAnchorsCompletionML spaces(@Nullable org.lwjgl.PointerBuffer value)

Sets the address of the specified PointerBuffer to the spaces() field.

set

public XrCreateSpatialAnchorsCompletionML set(int type,
 long next,
 int futureResult,
 int spaceCount,
 @Nullable org.lwjgl.PointerBuffer spaces)

Initializes this struct with the specified values.

set

public XrCreateSpatialAnchorsCompletionML set(XrCreateSpatialAnchorsCompletionML src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrCreateSpatialAnchorsCompletionML malloc()

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

calloc

public static XrCreateSpatialAnchorsCompletionML calloc()

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

create

public static XrCreateSpatialAnchorsCompletionML create()

Returns a new XrCreateSpatialAnchorsCompletionML instance allocated with BufferUtils.

create

public static XrCreateSpatialAnchorsCompletionML create(long address)

Returns a new XrCreateSpatialAnchorsCompletionML instance for the specified memory address.

createSafe

public static @Nullable XrCreateSpatialAnchorsCompletionML createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrCreateSpatialAnchorsCompletionML create(XrFutureCompletionBaseHeaderEXT value)

Downcasts the specified XrFutureCompletionBaseHeaderEXT instance to XrCreateSpatialAnchorsCompletionML.

malloc

public static XrCreateSpatialAnchorsCompletionML.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrCreateSpatialAnchorsCompletionML.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrCreateSpatialAnchorsCompletionML.Buffer create(int capacity)

Returns a new XrCreateSpatialAnchorsCompletionML.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrCreateSpatialAnchorsCompletionML.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

create

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

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

malloc

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

Returns a new XrCreateSpatialAnchorsCompletionML instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nspaceCount

public static int nspaceCount(long struct)

Unsafe version of spaceCount().

nspaces

public static @Nullable org.lwjgl.PointerBuffer nspaces(long struct)

Unsafe version of spaces.

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.

nspaceCount

public static void nspaceCount(long struct,
 int value)

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

nspaces

public static void nspaces(long struct,
 @Nullable org.lwjgl.PointerBuffer value)

Unsafe version of spaces.