Package org.lwjgl.openxr

Class XrSpatialAnchorPersistenceNameMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSpatialAnchorPersistenceNameMSFT>

org.lwjgl.openxr.XrSpatialAnchorPersistenceNameMSFT

All Implemented Interfaces:

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

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

The name to identify a Spatial anchor persistence operations.

Description

If an XrSpatialAnchorPersistenceNameMSFT with an empty name 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 XrSpatialAnchorPersistenceNameMSFT
• name must be a null-terminated UTF-8 string whose length is less than or equal to MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT

See Also

XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT, XrSpatialAnchorPersistenceInfoMSFT, ClearSpatialAnchorStoreMSFT, EnumeratePersistedSpatialAnchorNamesMSFT, UnpersistSpatialAnchorMSFT

Layout

 struct XrSpatialAnchorPersistenceNameMSFT {
     char name()[XR_MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT];
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrSpatialAnchorPersistenceNameMSFT.Buffer	An array of XrSpatialAnchorPersistenceNameMSFT 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	NAME	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
XrSpatialAnchorPersistenceNameMSFT(ByteBuffer container)	Creates a XrSpatialAnchorPersistenceNameMSFT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrSpatialAnchorPersistenceNameMSFT	calloc()	Returns a new XrSpatialAnchorPersistenceNameMSFT instance allocated with memCalloc.
static XrSpatialAnchorPersistenceNameMSFT.Buffer	calloc(int capacity)	Returns a new XrSpatialAnchorPersistenceNameMSFT.Buffer instance allocated with memCalloc.
static XrSpatialAnchorPersistenceNameMSFT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorPersistenceNameMSFT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSpatialAnchorPersistenceNameMSFT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorPersistenceNameMSFT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSpatialAnchorPersistenceNameMSFT	create()	Returns a new XrSpatialAnchorPersistenceNameMSFT instance allocated with BufferUtils.
static XrSpatialAnchorPersistenceNameMSFT.Buffer	create(int capacity)	Returns a new XrSpatialAnchorPersistenceNameMSFT.Buffer instance allocated with BufferUtils.
static XrSpatialAnchorPersistenceNameMSFT	create(long address)	Returns a new XrSpatialAnchorPersistenceNameMSFT instance for the specified memory address.
static XrSpatialAnchorPersistenceNameMSFT.Buffer	create(long address, int capacity)	Create a XrSpatialAnchorPersistenceNameMSFT.Buffer instance at the specified memory.
static @Nullable XrSpatialAnchorPersistenceNameMSFT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSpatialAnchorPersistenceNameMSFT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrSpatialAnchorPersistenceNameMSFT	malloc()	Returns a new XrSpatialAnchorPersistenceNameMSFT instance allocated with memAlloc.
static XrSpatialAnchorPersistenceNameMSFT.Buffer	malloc(int capacity)	Returns a new XrSpatialAnchorPersistenceNameMSFT.Buffer instance allocated with memAlloc.
static XrSpatialAnchorPersistenceNameMSFT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorPersistenceNameMSFT.Buffer instance allocated on the specified MemoryStack.
static XrSpatialAnchorPersistenceNameMSFT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorPersistenceNameMSFT instance allocated on the specified MemoryStack.
ByteBuffer	name()	a null terminated character array of size MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT.
XrSpatialAnchorPersistenceNameMSFT	name(ByteBuffer value)	Copies the specified encoded string to the name() field.
String	nameString()	a null terminated character array of size MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT.
static ByteBuffer	nname(long struct)	Unsafe version of name().
static void	nname(long struct, ByteBuffer value)	Unsafe version of name.
static String	nnameString(long struct)	Unsafe version of nameString().
XrSpatialAnchorPersistenceNameMSFT	set(XrSpatialAnchorPersistenceNameMSFT src)	Copies the specified struct data to this struct.
int	sizeof()

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.

NAME

public static final int NAME

The struct member offsets.

Constructor Details

XrSpatialAnchorPersistenceNameMSFT

public XrSpatialAnchorPersistenceNameMSFT(ByteBuffer container)

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

name

public ByteBuffer name()

a null terminated character array of size MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT.

nameString

public String nameString()

a null terminated character array of size MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT.

name

public XrSpatialAnchorPersistenceNameMSFT name(ByteBuffer value)

Copies the specified encoded string to the name() field.

set

public XrSpatialAnchorPersistenceNameMSFT set(XrSpatialAnchorPersistenceNameMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSpatialAnchorPersistenceNameMSFT malloc()

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

calloc

public static XrSpatialAnchorPersistenceNameMSFT calloc()

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

create

public static XrSpatialAnchorPersistenceNameMSFT create()

Returns a new XrSpatialAnchorPersistenceNameMSFT instance allocated with BufferUtils.

create

public static XrSpatialAnchorPersistenceNameMSFT create(long address)

Returns a new XrSpatialAnchorPersistenceNameMSFT instance for the specified memory address.

createSafe

public static @Nullable XrSpatialAnchorPersistenceNameMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSpatialAnchorPersistenceNameMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSpatialAnchorPersistenceNameMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSpatialAnchorPersistenceNameMSFT.Buffer create(int capacity)

Returns a new XrSpatialAnchorPersistenceNameMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSpatialAnchorPersistenceNameMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSpatialAnchorPersistenceNameMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new XrSpatialAnchorPersistenceNameMSFT.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

nname

public static ByteBuffer nname(long struct)

Unsafe version of name().

nnameString

public static String nnameString(long struct)

Unsafe version of nameString().

nname

public static void nname(long struct,
 ByteBuffer value)

Unsafe version of name.