Package org.lwjgl.openxr

Class XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT>

org.lwjgl.openxr.XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT

All Implemented Interfaces:

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

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

Creation info for creating a spatial anchor handle from a persisted anchor.

Description

The spatialAnchorPersistenceName is a character array of maximum size MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT, which must include a null terminator and must not be empty (i.e. the first element is the null terminator). If an empty spatialAnchorPersistenceName value is passed to any function as a parameter, that function must return ERROR_SPATIAL_ANCHOR_NAME_INVALID_MSFT.

Valid Usage (Implicit)

• The XR_MSFT_spatial_anchor_persistence extension must be enabled prior to using XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT
• type must be TYPE_SPATIAL_ANCHOR_FROM_PERSISTED_ANCHOR_CREATE_INFO_MSFT
• next must be NULL or a valid pointer to the next structure in a structure chain
• spatialAnchorStore must be a valid XrSpatialAnchorStoreConnectionMSFT handle
• spatialAnchorPersistenceName must be a valid XrSpatialAnchorPersistenceNameMSFT structure

See Also

XrSpatialAnchorPersistenceNameMSFT, CreateSpatialAnchorFromPersistedNameMSFT

Layout

 struct XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT {
     XrStructureType type();
     void const * next();
     XrSpatialAnchorStoreConnectionMSFT spatialAnchorStore();
     XrSpatialAnchorPersistenceNameMSFT spatialAnchorPersistenceName();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT	calloc()	Returns a new XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT instance allocated with memCalloc.
static XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT.Buffer	calloc(int capacity)	Returns a new XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT.Buffer instance allocated with memCalloc.
static XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT	create()	Returns a new XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT instance allocated with BufferUtils.
static XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT.Buffer	create(int capacity)	Returns a new XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT.Buffer instance allocated with BufferUtils.
static XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT	create(long address)	Returns a new XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT instance for the specified memory address.
static XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT.Buffer	create(long address, int capacity)	Create a XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT.Buffer instance at the specified memory.
static @Nullable XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT	malloc()	Returns a new XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT instance allocated with memAlloc.
static XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT.Buffer	malloc(int capacity)	Returns a new XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT.Buffer instance allocated with memAlloc.
static XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT.Buffer instance allocated on the specified MemoryStack.
static XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT	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 XrSpatialAnchorPersistenceNameMSFT	nspatialAnchorPersistenceName(long struct)	Unsafe version of spatialAnchorPersistenceName().
static void	nspatialAnchorPersistenceName(long struct, XrSpatialAnchorPersistenceNameMSFT value)	Unsafe version of spatialAnchorPersistenceName.
static long	nspatialAnchorStore(long struct)	Unsafe version of spatialAnchorStore().
static void	nspatialAnchorStore(long struct, XrSpatialAnchorStoreConnectionMSFT value)	Unsafe version of spatialAnchorStore.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT	set(int type, long next, XrSpatialAnchorStoreConnectionMSFT spatialAnchorStore, XrSpatialAnchorPersistenceNameMSFT spatialAnchorPersistenceName)	Initializes this struct with the specified values.
XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT	set(XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT src)	Copies the specified struct data to this struct.
int	sizeof()
XrSpatialAnchorPersistenceNameMSFT	spatialAnchorPersistenceName()	the XrSpatialAnchorPersistenceNameMSFT associated with the XrSpatialAnchorMSFT in the spatial anchor store.
XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT	spatialAnchorPersistenceName(Consumer<XrSpatialAnchorPersistenceNameMSFT> consumer)	Passes the spatialAnchorPersistenceName() field to the specified Consumer.
XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT	spatialAnchorPersistenceName(XrSpatialAnchorPersistenceNameMSFT value)	Copies the specified XrSpatialAnchorPersistenceNameMSFT to the spatialAnchorPersistenceName() field.
long	spatialAnchorStore()	the XrSpatialAnchorStoreConnectionMSFT from which the spatial anchor will be loaded from.
XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT	spatialAnchorStore(XrSpatialAnchorStoreConnectionMSFT value)	Sets the specified value to the spatialAnchorStore() field.
int	type()	the XrStructureType of this structure.
XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT	type(int value)	Sets the specified value to the type() field.
XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT	type$Default()	Sets the TYPE_SPATIAL_ANCHOR_FROM_PERSISTED_ANCHOR_CREATE_INFO_MSFT 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.

SPATIALANCHORSTORE

public static final int SPATIALANCHORSTORE

The struct member offsets.

SPATIALANCHORPERSISTENCENAME

public static final int SPATIALANCHORPERSISTENCENAME

The struct member offsets.

Constructor Details

XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT

public XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT(ByteBuffer container)

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

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. No such structures are defined in core OpenXR.

spatialAnchorStore

public long spatialAnchorStore()

the XrSpatialAnchorStoreConnectionMSFT from which the spatial anchor will be loaded from.

spatialAnchorPersistenceName

public XrSpatialAnchorPersistenceNameMSFT spatialAnchorPersistenceName()

the XrSpatialAnchorPersistenceNameMSFT associated with the XrSpatialAnchorMSFT in the spatial anchor store. This name is used to create an XrSpatialAnchorMSFT handle from a spatial anchor persisted in the spatial anchor store.

type

public XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT type(int value)

Sets the specified value to the type() field.

type$Default

public XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT type$Default()

Sets the TYPE_SPATIAL_ANCHOR_FROM_PERSISTED_ANCHOR_CREATE_INFO_MSFT value to the type() field.

next

public XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT next(long value)

Sets the specified value to the next() field.

spatialAnchorStore

public XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT spatialAnchorStore(XrSpatialAnchorStoreConnectionMSFT value)

Sets the specified value to the spatialAnchorStore() field.

spatialAnchorPersistenceName

public XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT spatialAnchorPersistenceName(XrSpatialAnchorPersistenceNameMSFT value)

Copies the specified XrSpatialAnchorPersistenceNameMSFT to the spatialAnchorPersistenceName() field.

spatialAnchorPersistenceName

public XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT spatialAnchorPersistenceName(Consumer<XrSpatialAnchorPersistenceNameMSFT> consumer)

Passes the spatialAnchorPersistenceName() field to the specified Consumer.

set

public XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT set(int type,
 long next,
 XrSpatialAnchorStoreConnectionMSFT spatialAnchorStore,
 XrSpatialAnchorPersistenceNameMSFT spatialAnchorPersistenceName)

Initializes this struct with the specified values.

set

public XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT set(XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT malloc()

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

calloc

public static XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT calloc()

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

create

public static XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT create()

Returns a new XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT instance allocated with BufferUtils.

create

public static XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT create(long address)

Returns a new XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT instance for the specified memory address.

createSafe

public static @Nullable XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT.Buffer create(int capacity)

Returns a new XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nspatialAnchorStore

public static long nspatialAnchorStore(long struct)

Unsafe version of spatialAnchorStore().

nspatialAnchorPersistenceName

public static XrSpatialAnchorPersistenceNameMSFT nspatialAnchorPersistenceName(long struct)

Unsafe version of spatialAnchorPersistenceName().

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.

nspatialAnchorStore

public static void nspatialAnchorStore(long struct,
 XrSpatialAnchorStoreConnectionMSFT value)

Unsafe version of spatialAnchorStore.

nspatialAnchorPersistenceName

public static void nspatialAnchorPersistenceName(long struct,
 XrSpatialAnchorPersistenceNameMSFT value)

Unsafe version of spatialAnchorPersistenceName.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate