Package org.lwjgl.openxr

Class XrSpatialAnchorPersistenceInfoMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSpatialAnchorPersistenceInfoMSFT>

org.lwjgl.openxr.XrSpatialAnchorPersistenceInfoMSFT

All Implemented Interfaces:

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

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

Persistence info for a spatial anchor.

Valid Usage (Implicit)

• The XR_MSFT_spatial_anchor_persistence extension must be enabled prior to using XrSpatialAnchorPersistenceInfoMSFT
• type must be TYPE_SPATIAL_ANCHOR_PERSISTENCE_INFO_MSFT
• next must be NULL or a valid pointer to the next structure in a structure chain
• spatialAnchorPersistenceName must be a valid XrSpatialAnchorPersistenceNameMSFT structure
• spatialAnchor must be a valid XrSpatialAnchorMSFT handle

See Also

XrSpatialAnchorPersistenceNameMSFT, PersistSpatialAnchorMSFT

Layout

 struct XrSpatialAnchorPersistenceInfoMSFT {
     XrStructureType type();
     void const * next();
     XrSpatialAnchorPersistenceNameMSFT spatialAnchorPersistenceName();
     XrSpatialAnchorMSFT spatialAnchor();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

SPATIALANCHORPERSISTENCENAME

public static final int SPATIALANCHORPERSISTENCENAME

The struct member offsets.

SPATIALANCHOR

public static final int SPATIALANCHOR

The struct member offsets.

Constructor Details

XrSpatialAnchorPersistenceInfoMSFT

public XrSpatialAnchorPersistenceInfoMSFT(ByteBuffer container)

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

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.

spatialAnchorPersistenceName

public XrSpatialAnchorPersistenceNameMSFT spatialAnchorPersistenceName()

an XrSpatialAnchorPersistenceNameMSFT containing the name associated with the XrSpatialAnchorMSFT in the spatial anchor store.

spatialAnchor

public long spatialAnchor()

the XrSpatialAnchorMSFT that the application wishes to perform persistence operations on.

type

public XrSpatialAnchorPersistenceInfoMSFT type(int value)

Sets the specified value to the type() field.

type$Default

public XrSpatialAnchorPersistenceInfoMSFT type$Default()

Sets the TYPE_SPATIAL_ANCHOR_PERSISTENCE_INFO_MSFT value to the type() field.

next

public XrSpatialAnchorPersistenceInfoMSFT next(long value)

Sets the specified value to the next() field.

spatialAnchorPersistenceName

public XrSpatialAnchorPersistenceInfoMSFT spatialAnchorPersistenceName(XrSpatialAnchorPersistenceNameMSFT value)

Copies the specified XrSpatialAnchorPersistenceNameMSFT to the spatialAnchorPersistenceName() field.

spatialAnchorPersistenceName

public XrSpatialAnchorPersistenceInfoMSFT spatialAnchorPersistenceName(Consumer<XrSpatialAnchorPersistenceNameMSFT> consumer)

Passes the spatialAnchorPersistenceName() field to the specified Consumer.

spatialAnchor

public XrSpatialAnchorPersistenceInfoMSFT spatialAnchor(XrSpatialAnchorMSFT value)

Sets the specified value to the spatialAnchor() field.

set

public XrSpatialAnchorPersistenceInfoMSFT set(int type,
 long next,
 XrSpatialAnchorPersistenceNameMSFT spatialAnchorPersistenceName,
 XrSpatialAnchorMSFT spatialAnchor)

Initializes this struct with the specified values.

set

public XrSpatialAnchorPersistenceInfoMSFT set(XrSpatialAnchorPersistenceInfoMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSpatialAnchorPersistenceInfoMSFT malloc()

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

calloc

public static XrSpatialAnchorPersistenceInfoMSFT calloc()

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

create

public static XrSpatialAnchorPersistenceInfoMSFT create()

Returns a new XrSpatialAnchorPersistenceInfoMSFT instance allocated with BufferUtils.

create

public static XrSpatialAnchorPersistenceInfoMSFT create(long address)

Returns a new XrSpatialAnchorPersistenceInfoMSFT instance for the specified memory address.

createSafe

public static @Nullable XrSpatialAnchorPersistenceInfoMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSpatialAnchorPersistenceInfoMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSpatialAnchorPersistenceInfoMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSpatialAnchorPersistenceInfoMSFT.Buffer create(int capacity)

Returns a new XrSpatialAnchorPersistenceInfoMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSpatialAnchorPersistenceInfoMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSpatialAnchorPersistenceInfoMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nspatialAnchorPersistenceName

public static XrSpatialAnchorPersistenceNameMSFT nspatialAnchorPersistenceName(long struct)

Unsafe version of spatialAnchorPersistenceName().

nspatialAnchor

public static long nspatialAnchor(long struct)

Unsafe version of spatialAnchor().

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.

nspatialAnchorPersistenceName

public static void nspatialAnchorPersistenceName(long struct,
 XrSpatialAnchorPersistenceNameMSFT value)

Unsafe version of spatialAnchorPersistenceName.

nspatialAnchor

public static void nspatialAnchor(long struct,
 XrSpatialAnchorMSFT value)

Unsafe version of spatialAnchor.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate