Package org.lwjgl.openxr

Class XrSpatialAnchorsCreateInfoFromUuidsML

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSpatialAnchorsCreateInfoFromUuidsML>

org.lwjgl.openxr.XrSpatialAnchorsCreateInfoFromUuidsML

All Implemented Interfaces:

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

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

Structure used to create tracked spatial anchors from uuids.

Description

The XrSpace handle or handles returned via XrCreateSpatialAnchorsCompletionML::spaces must be in the same order as uuids.

The XrCreateSpatialAnchorsCompletionML::spaceCount field must match uuidCount. If not the runtime must return ERROR_VALIDATION_FAILURE in XrCreateSpatialAnchorsCompletionML::futureResult.

If an anchor with a given UUID is not found, the runtime must return NULL_HANDLE for the corresponding XrSpace handle(s) and return SUCCESS in XrCreateSpatialAnchorsCompletionML::futureResult.

Valid Usage (Implicit)

• The XR_ML_spatial_anchors_storage extension must be enabled prior to using XrSpatialAnchorsCreateInfoFromUuidsML
• type must be TYPE_SPATIAL_ANCHORS_CREATE_INFO_FROM_UUIDS_ML
• next must be NULL or a valid pointer to the next structure in a structure chain
• storage must be a valid XrSpatialAnchorsStorageML handle
• uuids must be a pointer to an array of uuidCount XrUuidEXT structures
• The uuidCount parameter must be greater than 0

See Also

XrUuidEXT, CreateSpatialAnchorsAsyncML

Layout

 struct XrSpatialAnchorsCreateInfoFromUuidsML {
     XrStructureType type();
     void const * next();
     XrSpatialAnchorsStorageML storage();
     uint32_t uuidCount();
     XrUuidEXT const * uuids();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrSpatialAnchorsCreateInfoFromUuidsML	calloc()	Returns a new XrSpatialAnchorsCreateInfoFromUuidsML instance allocated with memCalloc.
static XrSpatialAnchorsCreateInfoFromUuidsML.Buffer	calloc(int capacity)	Returns a new XrSpatialAnchorsCreateInfoFromUuidsML.Buffer instance allocated with memCalloc.
static XrSpatialAnchorsCreateInfoFromUuidsML.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorsCreateInfoFromUuidsML.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSpatialAnchorsCreateInfoFromUuidsML	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorsCreateInfoFromUuidsML instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSpatialAnchorsCreateInfoFromUuidsML	create()	Returns a new XrSpatialAnchorsCreateInfoFromUuidsML instance allocated with BufferUtils.
static XrSpatialAnchorsCreateInfoFromUuidsML.Buffer	create(int capacity)	Returns a new XrSpatialAnchorsCreateInfoFromUuidsML.Buffer instance allocated with BufferUtils.
static XrSpatialAnchorsCreateInfoFromUuidsML	create(long address)	Returns a new XrSpatialAnchorsCreateInfoFromUuidsML instance for the specified memory address.
static XrSpatialAnchorsCreateInfoFromUuidsML.Buffer	create(long address, int capacity)	Create a XrSpatialAnchorsCreateInfoFromUuidsML.Buffer instance at the specified memory.
static XrSpatialAnchorsCreateInfoFromUuidsML	create(XrSpatialAnchorsCreateInfoBaseHeaderML value)	Downcasts the specified XrSpatialAnchorsCreateInfoBaseHeaderML instance to XrSpatialAnchorsCreateInfoFromUuidsML.
static XrSpatialAnchorsCreateInfoFromUuidsML.Buffer	create(XrSpatialAnchorsCreateInfoBaseHeaderML.Buffer value)	Downcasts the specified XrSpatialAnchorsCreateInfoBaseHeaderML.Buffer instance to XrSpatialAnchorsCreateInfoFromUuidsML.Buffer.
static @Nullable XrSpatialAnchorsCreateInfoFromUuidsML	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSpatialAnchorsCreateInfoFromUuidsML.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrSpatialAnchorsCreateInfoFromUuidsML	malloc()	Returns a new XrSpatialAnchorsCreateInfoFromUuidsML instance allocated with memAlloc.
static XrSpatialAnchorsCreateInfoFromUuidsML.Buffer	malloc(int capacity)	Returns a new XrSpatialAnchorsCreateInfoFromUuidsML.Buffer instance allocated with memAlloc.
static XrSpatialAnchorsCreateInfoFromUuidsML.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorsCreateInfoFromUuidsML.Buffer instance allocated on the specified MemoryStack.
static XrSpatialAnchorsCreateInfoFromUuidsML	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorsCreateInfoFromUuidsML instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSpatialAnchorsCreateInfoFromUuidsML	next(long value)	Sets the specified value to the next() field.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static long	nstorage(long struct)	Unsafe version of storage().
static void	nstorage(long struct, XrSpatialAnchorsStorageML value)	Unsafe version of storage.
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.
XrSpatialAnchorsCreateInfoFromUuidsML	set(int type, long next, XrSpatialAnchorsStorageML storage, XrUuidEXT.Buffer uuids)	Initializes this struct with the specified values.
XrSpatialAnchorsCreateInfoFromUuidsML	set(XrSpatialAnchorsCreateInfoFromUuidsML src)	Copies the specified struct data to this struct.
int	sizeof()
long	storage()	the XrSpatialAnchorsStorageML to use.
XrSpatialAnchorsCreateInfoFromUuidsML	storage(XrSpatialAnchorsStorageML value)	Sets the specified value to the storage() field.
int	type()	the XrStructureType of this structure.
XrSpatialAnchorsCreateInfoFromUuidsML	type(int value)	Sets the specified value to the type() field.
XrSpatialAnchorsCreateInfoFromUuidsML	type$Default()	Sets the TYPE_SPATIAL_ANCHORS_CREATE_INFO_FROM_UUIDS_ML value to the type() field.
int	uuidCount()	the number of elements in the uuids array.
XrUuidEXT.Buffer	uuids()	pointer to an array of XrUuidEXT.
XrSpatialAnchorsCreateInfoFromUuidsML	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.

STORAGE

public static final int STORAGE

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

XrSpatialAnchorsCreateInfoFromUuidsML

public XrSpatialAnchorsCreateInfoFromUuidsML(ByteBuffer container)

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

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.

storage

public long storage()

the XrSpatialAnchorsStorageML to use.

uuidCount

public int uuidCount()

the number of elements in the uuids array.

uuids

public XrUuidEXT.Buffer uuids()

pointer to an array of XrUuidEXT.

type

public XrSpatialAnchorsCreateInfoFromUuidsML type(int value)

Sets the specified value to the type() field.

type$Default

public XrSpatialAnchorsCreateInfoFromUuidsML type$Default()

Sets the TYPE_SPATIAL_ANCHORS_CREATE_INFO_FROM_UUIDS_ML value to the type() field.

next

public XrSpatialAnchorsCreateInfoFromUuidsML next(long value)

Sets the specified value to the next() field.

storage

public XrSpatialAnchorsCreateInfoFromUuidsML storage(XrSpatialAnchorsStorageML value)

Sets the specified value to the storage() field.

uuids

public XrSpatialAnchorsCreateInfoFromUuidsML uuids(XrUuidEXT.Buffer value)

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

set

public XrSpatialAnchorsCreateInfoFromUuidsML set(int type,
 long next,
 XrSpatialAnchorsStorageML storage,
 XrUuidEXT.Buffer uuids)

Initializes this struct with the specified values.

set

public XrSpatialAnchorsCreateInfoFromUuidsML set(XrSpatialAnchorsCreateInfoFromUuidsML src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSpatialAnchorsCreateInfoFromUuidsML malloc()

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

calloc

public static XrSpatialAnchorsCreateInfoFromUuidsML calloc()

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

create

public static XrSpatialAnchorsCreateInfoFromUuidsML create()

Returns a new XrSpatialAnchorsCreateInfoFromUuidsML instance allocated with BufferUtils.

create

public static XrSpatialAnchorsCreateInfoFromUuidsML create(long address)

Returns a new XrSpatialAnchorsCreateInfoFromUuidsML instance for the specified memory address.

createSafe

public static @Nullable XrSpatialAnchorsCreateInfoFromUuidsML createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrSpatialAnchorsCreateInfoFromUuidsML create(XrSpatialAnchorsCreateInfoBaseHeaderML value)

Downcasts the specified XrSpatialAnchorsCreateInfoBaseHeaderML instance to XrSpatialAnchorsCreateInfoFromUuidsML.

malloc

public static XrSpatialAnchorsCreateInfoFromUuidsML.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSpatialAnchorsCreateInfoFromUuidsML.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSpatialAnchorsCreateInfoFromUuidsML.Buffer create(int capacity)

Returns a new XrSpatialAnchorsCreateInfoFromUuidsML.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSpatialAnchorsCreateInfoFromUuidsML.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

create

public static XrSpatialAnchorsCreateInfoFromUuidsML.Buffer create(XrSpatialAnchorsCreateInfoBaseHeaderML.Buffer value)

Downcasts the specified XrSpatialAnchorsCreateInfoBaseHeaderML.Buffer instance to XrSpatialAnchorsCreateInfoFromUuidsML.Buffer.

malloc

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

Returns a new XrSpatialAnchorsCreateInfoFromUuidsML instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nstorage

public static long nstorage(long struct)

Unsafe version of storage().

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.

nstorage

public static void nstorage(long struct,
 XrSpatialAnchorsStorageML value)

Unsafe version of storage.

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