Package org.lwjgl.openxr

Class XrSpatialAnchorsPublishCompletionML

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSpatialAnchorsPublishCompletionML>

org.lwjgl.openxr.XrSpatialAnchorsPublishCompletionML

All Implemented Interfaces:

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

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

Completion structure 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_VALIDATION_FAILURE
• ERROR_SPATIAL_ANCHORS_NOT_LOCALIZED_ML
• ERROR_SPATIAL_ANCHORS_OUT_OF_MAP_BOUNDS_ML

Valid Usage (Implicit)

• The XR_ML_spatial_anchors_storage extension must be enabled prior to using XrSpatialAnchorsPublishCompletionML
• type must be TYPE_SPATIAL_ANCHORS_PUBLISH_COMPLETION_ML
• next must be NULL or a valid pointer to the next structure in a structure chain. See also: XrSpatialAnchorsPublishCompletionDetailsML
• futureResult must be a valid XrResult value
• uuids must be a pointer to an array of uuidCount XrUuidEXT structures
• The uuidCount parameter must be greater than 0

See Also

XrUuidEXT, CreateSpatialAnchorsCompleteML, PublishSpatialAnchorsCompleteML, QuerySpatialAnchorsAsyncML

Layout

 struct XrSpatialAnchorsPublishCompletionML {
     XrStructureType type();
     void * next();
     XrResult futureResult();
     uint32_t uuidCount();
     XrUuidEXT * uuids();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrSpatialAnchorsPublishCompletionML.Buffer	An array of XrSpatialAnchorsPublishCompletionML 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	UUIDCOUNT	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
XrSpatialAnchorsPublishCompletionML(ByteBuffer container)	Creates a XrSpatialAnchorsPublishCompletionML instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrSpatialAnchorsPublishCompletionML	calloc()	Returns a new XrSpatialAnchorsPublishCompletionML instance allocated with memCalloc.
static XrSpatialAnchorsPublishCompletionML.Buffer	calloc(int capacity)	Returns a new XrSpatialAnchorsPublishCompletionML.Buffer instance allocated with memCalloc.
static XrSpatialAnchorsPublishCompletionML.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorsPublishCompletionML.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSpatialAnchorsPublishCompletionML	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorsPublishCompletionML instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSpatialAnchorsPublishCompletionML	create()	Returns a new XrSpatialAnchorsPublishCompletionML instance allocated with BufferUtils.
static XrSpatialAnchorsPublishCompletionML.Buffer	create(int capacity)	Returns a new XrSpatialAnchorsPublishCompletionML.Buffer instance allocated with BufferUtils.
static XrSpatialAnchorsPublishCompletionML	create(long address)	Returns a new XrSpatialAnchorsPublishCompletionML instance for the specified memory address.
static XrSpatialAnchorsPublishCompletionML.Buffer	create(long address, int capacity)	Create a XrSpatialAnchorsPublishCompletionML.Buffer instance at the specified memory.
static XrSpatialAnchorsPublishCompletionML	create(XrFutureCompletionBaseHeaderEXT value)	Downcasts the specified XrFutureCompletionBaseHeaderEXT instance to XrSpatialAnchorsPublishCompletionML.
static XrSpatialAnchorsPublishCompletionML.Buffer	create(XrFutureCompletionBaseHeaderEXT.Buffer value)	Downcasts the specified XrFutureCompletionBaseHeaderEXT.Buffer instance to XrSpatialAnchorsPublishCompletionML.Buffer.
static @Nullable XrSpatialAnchorsPublishCompletionML	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSpatialAnchorsPublishCompletionML.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	futureResult()	the XrResult of the asynchronous operation.
XrSpatialAnchorsPublishCompletionML	futureResult(int value)	Sets the specified value to the futureResult() field.
static XrSpatialAnchorsPublishCompletionML	malloc()	Returns a new XrSpatialAnchorsPublishCompletionML instance allocated with memAlloc.
static XrSpatialAnchorsPublishCompletionML.Buffer	malloc(int capacity)	Returns a new XrSpatialAnchorsPublishCompletionML.Buffer instance allocated with memAlloc.
static XrSpatialAnchorsPublishCompletionML.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorsPublishCompletionML.Buffer instance allocated on the specified MemoryStack.
static XrSpatialAnchorsPublishCompletionML	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorsPublishCompletionML instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSpatialAnchorsPublishCompletionML	next(long value)	Sets the specified value to the next() field.
XrSpatialAnchorsPublishCompletionML	next(XrSpatialAnchorsPublishCompletionDetailsML value)	Prepends the specified XrSpatialAnchorsPublishCompletionDetailsML value to the next chain.
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	nuuidCount(long struct)	Unsafe version of uuidCount().
static void	nuuidCount(long struct, int value)	Sets the specified value to the uuidCount field of the specified struct.
static XrUuidEXT.Buffer	nuuids(long struct)	Unsafe version of uuids().
static void	nuuids(long struct, XrUuidEXT.Buffer value)	Unsafe version of uuids.
XrSpatialAnchorsPublishCompletionML	set(int type, long next, int futureResult, XrUuidEXT.Buffer uuids)	Initializes this struct with the specified values.
XrSpatialAnchorsPublishCompletionML	set(XrSpatialAnchorsPublishCompletionML src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrSpatialAnchorsPublishCompletionML	type(int value)	Sets the specified value to the type() field.
XrSpatialAnchorsPublishCompletionML	type$Default()	Sets the TYPE_SPATIAL_ANCHORS_PUBLISH_COMPLETION_ML value to the type() field.
int	uuidCount()	the capacity of the uuids array and must match the number of anchors passed to PublishSpatialAnchorsAsyncML
XrUuidEXT.Buffer	uuids()	an array of XrUuidEXT.
XrSpatialAnchorsPublishCompletionML	uuids(XrUuidEXT.Buffer value)	Sets the address of the specified XrUuidEXT.Buffer to the uuids() 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.

UUIDCOUNT

public static final int UUIDCOUNT

The struct member offsets.

UUIDS

public static final int UUIDS

The struct member offsets.

Constructor Details

XrSpatialAnchorsPublishCompletionML

public XrSpatialAnchorsPublishCompletionML(ByteBuffer container)

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

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.

uuidCount

public int uuidCount()

the capacity of the uuids array and must match the number of anchors passed to PublishSpatialAnchorsAsyncML

uuids

public XrUuidEXT.Buffer uuids()

an array of XrUuidEXT.

type

public XrSpatialAnchorsPublishCompletionML type(int value)

Sets the specified value to the type() field.

type$Default

public XrSpatialAnchorsPublishCompletionML type$Default()

Sets the TYPE_SPATIAL_ANCHORS_PUBLISH_COMPLETION_ML value to the type() field.

next

public XrSpatialAnchorsPublishCompletionML next(long value)

Sets the specified value to the next() field.

next

public XrSpatialAnchorsPublishCompletionML next(XrSpatialAnchorsPublishCompletionDetailsML value)

Prepends the specified XrSpatialAnchorsPublishCompletionDetailsML value to the next chain.

futureResult

public XrSpatialAnchorsPublishCompletionML futureResult(int value)

Sets the specified value to the futureResult() field.

uuids

public XrSpatialAnchorsPublishCompletionML uuids(XrUuidEXT.Buffer value)

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

set

public XrSpatialAnchorsPublishCompletionML set(int type,
 long next,
 int futureResult,
 XrUuidEXT.Buffer uuids)

Initializes this struct with the specified values.

set

public XrSpatialAnchorsPublishCompletionML set(XrSpatialAnchorsPublishCompletionML src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSpatialAnchorsPublishCompletionML malloc()

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

calloc

public static XrSpatialAnchorsPublishCompletionML calloc()

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

create

public static XrSpatialAnchorsPublishCompletionML create()

Returns a new XrSpatialAnchorsPublishCompletionML instance allocated with BufferUtils.

create

public static XrSpatialAnchorsPublishCompletionML create(long address)

Returns a new XrSpatialAnchorsPublishCompletionML instance for the specified memory address.

createSafe

public static @Nullable XrSpatialAnchorsPublishCompletionML createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrSpatialAnchorsPublishCompletionML create(XrFutureCompletionBaseHeaderEXT value)

Downcasts the specified XrFutureCompletionBaseHeaderEXT instance to XrSpatialAnchorsPublishCompletionML.

malloc

public static XrSpatialAnchorsPublishCompletionML.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSpatialAnchorsPublishCompletionML.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSpatialAnchorsPublishCompletionML.Buffer create(int capacity)

Returns a new XrSpatialAnchorsPublishCompletionML.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSpatialAnchorsPublishCompletionML.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

create

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

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

malloc

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

Returns a new XrSpatialAnchorsPublishCompletionML instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nuuidCount

public static int nuuidCount(long struct)

Unsafe version of uuidCount().

nuuids

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

nuuidCount

public static void nuuidCount(long struct,
 int value)

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

nuuids

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

Unsafe version of uuids.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate