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

Layout


struct XrSpatialAnchorPersistenceNameMSFT {
    char name[XR_MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT];
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	XrSpatialAnchorPersistenceNameMSFT.Buffer An array of `XrSpatialAnchorPersistenceNameMSFT` structs.

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	NAME The struct member offsets.
public static final int	SIZEOF The struct size in bytes.

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	XrSpatialAnchorPersistenceNameMSFT(long address, ByteBuffer container)
public	XrSpatialAnchorPersistenceNameMSFT(ByteBuffer container) Creates a `XrSpatialAnchorPersistenceNameMSFT` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static XrSpatialAnchorPersistenceNameMSFT	calloc() Returns a new `XrSpatialAnchorPersistenceNameMSFT` instance allocated with `memCalloc`.
public static XrSpatialAnchorPersistenceNameMSFT.Buffer	calloc(int the buffer capacity capacity) Returns a new `XrSpatialAnchorPersistenceNameMSFT.Buffer` instance allocated with `memCalloc`.
public static XrSpatialAnchorPersistenceNameMSFT	calloc(MemoryStack the stack from which to allocate stack) Returns a new `XrSpatialAnchorPersistenceNameMSFT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static XrSpatialAnchorPersistenceNameMSFT.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrSpatialAnchorPersistenceNameMSFT.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected XrSpatialAnchorPersistenceNameMSFT	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static XrSpatialAnchorPersistenceNameMSFT	create() Returns a new `XrSpatialAnchorPersistenceNameMSFT` instance allocated with `BufferUtils`.
public static XrSpatialAnchorPersistenceNameMSFT	create(long address) Returns a new `XrSpatialAnchorPersistenceNameMSFT` instance for the specified memory address.
public static XrSpatialAnchorPersistenceNameMSFT.Buffer	create(int the buffer capacity capacity) Returns a new `XrSpatialAnchorPersistenceNameMSFT.Buffer` instance allocated with `BufferUtils`.
public static XrSpatialAnchorPersistenceNameMSFT.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `XrSpatialAnchorPersistenceNameMSFT.Buffer` instance at the specified memory.
public static XrSpatialAnchorPersistenceNameMSFT	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static XrSpatialAnchorPersistenceNameMSFT.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static XrSpatialAnchorPersistenceNameMSFT	malloc() Returns a new `XrSpatialAnchorPersistenceNameMSFT` instance allocated with `memAlloc`.
public static XrSpatialAnchorPersistenceNameMSFT.Buffer	malloc(int the buffer capacity capacity) Returns a new `XrSpatialAnchorPersistenceNameMSFT.Buffer` instance allocated with `memAlloc`.
public static XrSpatialAnchorPersistenceNameMSFT	malloc(MemoryStack the stack from which to allocate stack) Returns a new `XrSpatialAnchorPersistenceNameMSFT` instance allocated on the specified `MemoryStack`.
public static XrSpatialAnchorPersistenceNameMSFT.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrSpatialAnchorPersistenceNameMSFT.Buffer` instance allocated on the specified `MemoryStack`.
public ByteBuffer	name() a null terminated character array of size `MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT`.
public XrSpatialAnchorPersistenceNameMSFT	name(ByteBuffer value) Copies the specified encoded string to the `name` field.
public String	nameString() a null terminated character array of size `MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT`.
public static ByteBuffer	nname(long struct) Unsafe version of `name`.
public static void	nname(long struct, ByteBuffer value) Unsafe version of `name`.
public static String	nnameString(long struct) Unsafe version of `nameString`.
public XrSpatialAnchorPersistenceNameMSFT	Returns: this struct set(XrSpatialAnchorPersistenceNameMSFT the source struct src) Copies the specified struct data to this struct.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

NAME	back to summary
public static final int NAME The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

Constructor Detail

XrSpatialAnchorPersistenceNameMSFT	back to summary
protected XrSpatialAnchorPersistenceNameMSFT(long address, ByteBuffer container)

XrSpatialAnchorPersistenceNameMSFT back to summary

XrSpatialAnchorPersistenceNameMSFT	back to summary
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.

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 Detail

calloc	back to summary
public static XrSpatialAnchorPersistenceNameMSFT calloc() Returns a new `XrSpatialAnchorPersistenceNameMSFT` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static XrSpatialAnchorPersistenceNameMSFT.Buffer calloc(int capacity) Returns a new `XrSpatialAnchorPersistenceNameMSFT.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrSpatialAnchorPersistenceNameMSFT.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static XrSpatialAnchorPersistenceNameMSFT calloc(MemoryStack stack) Returns a new `XrSpatialAnchorPersistenceNameMSFT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static XrSpatialAnchorPersistenceNameMSFT calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static XrSpatialAnchorPersistenceNameMSFT.Buffer calloc(int capacity, MemoryStack stack) Returns a new `XrSpatialAnchorPersistenceNameMSFT.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

create back to summary

create	back to summary
protected XrSpatialAnchorPersistenceNameMSFT create(long address, ByteBuffer container) Implements abstract org.lwjgl.system.Struct.create. Doc from org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass. Effectively, every `Struct` instance is a factory for more instances of the same type. This is used by `StructBuffer`. Parameters address:long the struct memory address container:ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. Annotations @Override

protected XrSpatialAnchorPersistenceNameMSFT create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters

address:long: the struct memory address
container:ByteBuffer: an optional container buffer, to be referenced strongly by the struct instance.

Annotations

@Override

create	back to summary
public static XrSpatialAnchorPersistenceNameMSFT create() Returns a new `XrSpatialAnchorPersistenceNameMSFT` instance allocated with `BufferUtils`.

create	back to summary
public static XrSpatialAnchorPersistenceNameMSFT create(long address) Returns a new `XrSpatialAnchorPersistenceNameMSFT` instance for the specified memory address.

create back to summary

create	back to summary
public static XrSpatialAnchorPersistenceNameMSFT.Buffer create(int capacity) Returns a new `XrSpatialAnchorPersistenceNameMSFT.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static XrSpatialAnchorPersistenceNameMSFT.Buffer create(int capacity)

Returns a new XrSpatialAnchorPersistenceNameMSFT.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static XrSpatialAnchorPersistenceNameMSFT.Buffer create(long address, int capacity) Create a `XrSpatialAnchorPersistenceNameMSFT.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a XrSpatialAnchorPersistenceNameMSFT.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static XrSpatialAnchorPersistenceNameMSFT createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static XrSpatialAnchorPersistenceNameMSFT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static XrSpatialAnchorPersistenceNameMSFT.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

malloc	back to summary
public static XrSpatialAnchorPersistenceNameMSFT malloc() Returns a new `XrSpatialAnchorPersistenceNameMSFT` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static XrSpatialAnchorPersistenceNameMSFT.Buffer malloc(int capacity) Returns a new `XrSpatialAnchorPersistenceNameMSFT.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrSpatialAnchorPersistenceNameMSFT.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static XrSpatialAnchorPersistenceNameMSFT malloc(MemoryStack stack) Returns a new `XrSpatialAnchorPersistenceNameMSFT` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static XrSpatialAnchorPersistenceNameMSFT malloc(MemoryStack stack)

Returns a new XrSpatialAnchorPersistenceNameMSFT instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static XrSpatialAnchorPersistenceNameMSFT.Buffer malloc(int capacity, MemoryStack stack) Returns a new `XrSpatialAnchorPersistenceNameMSFT.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

name back to summary

name	back to summary
public ByteBuffer name() a null terminated character array of size `MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT`. Annotations @NativeType:char[XR_MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT]

public ByteBuffer name()

a null terminated character array of size MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT.

Annotations

@NativeType:char[XR_MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT]

name	back to summary
public XrSpatialAnchorPersistenceNameMSFT name(ByteBuffer value) Copies the specified encoded string to the `name` field.

nameString back to summary

nameString	back to summary
public String nameString() a null terminated character array of size `MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT`. Annotations @NativeType:char[XR_MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT]

public String nameString()

a null terminated character array of size MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT.

Annotations

@NativeType:char[XR_MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT]

nname	back to summary
public static ByteBuffer nname(long struct) Unsafe version of `name`.

nname	back to summary
public static void nname(long struct, ByteBuffer value) Unsafe version of `name`.

nnameString	back to summary
public static String nnameString(long struct) Unsafe version of `nameString`.

set	back to summary
public XrSpatialAnchorPersistenceNameMSFT set(XrSpatialAnchorPersistenceNameMSFT src) Copies the specified struct data to this struct. Parameters src:XrSpatialAnchorPersistenceNameMSFT the source struct Returns:XrSpatialAnchorPersistenceNameMSFT this struct

set

back to summary

public XrSpatialAnchorPersistenceNameMSFT set(XrSpatialAnchorPersistenceNameMSFT src)

Copies the specified struct data to this struct.

Parameters

src:XrSpatialAnchorPersistenceNameMSFT: the source struct

Returns:XrSpatialAnchorPersistenceNameMSFT

this struct

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

org.lwjgl.openxr back to summary

public Class XrSpatialAnchorPersistenceNameMSFT.Buffer

Class Inheritance

extends StructBuffer<XrSpatialAnchorPersistenceNameMSFT, XrSpatialAnchorPersistenceNameMSFT.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.openxr.XrSpatialAnchorPersistenceNameMSFT.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrSpatialAnchorPersistenceNameMSFT structs.

Field Summary

Modifier and Type	Field and Description
private static final XrSpatialAnchorPersistenceNameMSFT	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `XrSpatialAnchorPersistenceNameMSFT.Buffer` instance backed by the specified container.
public	Buffer(long address, int cap)
pack-priv	Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and Type	Method and Description
protected XrSpatialAnchorPersistenceNameMSFT	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public ByteBuffer	Returns: a `ByteBuffer` view of the `XrSpatialAnchorPersistenceNameMSFT#name` field. name()
public XrSpatialAnchorPersistenceNameMSFT.Buffer	name(ByteBuffer value) Copies the specified encoded string to the `XrSpatialAnchorPersistenceNameMSFT#name` field.
public String	Returns: the null-terminated string stored in the `XrSpatialAnchorPersistenceNameMSFT#name` field. nameString()
protected XrSpatialAnchorPersistenceNameMSFT.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final XrSpatialAnchorPersistenceNameMSFT ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `XrSpatialAnchorPersistenceNameMSFT.Buffer` instance backed by the specified container. Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by `XrSpatialAnchorPersistenceNameMSFT#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

Creates a new XrSpatialAnchorPersistenceNameMSFT.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by XrSpatialAnchorPersistenceNameMSFT#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactory	back to summary
protected XrSpatialAnchorPersistenceNameMSFT getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory. Annotations @Override

getElementFactory

back to summary

protected XrSpatialAnchorPersistenceNameMSFT getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations

@Override

name	back to summary
public ByteBuffer name() Returns:ByteBuffer a `ByteBuffer` view of the `XrSpatialAnchorPersistenceNameMSFT#name` field. Annotations @NativeType:char[XR_MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT]

name	back to summary
public XrSpatialAnchorPersistenceNameMSFT.Buffer name(ByteBuffer value) Copies the specified encoded string to the `XrSpatialAnchorPersistenceNameMSFT#name` field.

nameString	back to summary
public String nameString() Returns:String the null-terminated string stored in the `XrSpatialAnchorPersistenceNameMSFT#name` field. Annotations @NativeType:char[XR_MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT]

self	back to summary
protected XrSpatialAnchorPersistenceNameMSFT.Buffer self() Implements abstract org.lwjgl.system.CustomBuffer.self. Annotations @Override

self

back to summary

protected XrSpatialAnchorPersistenceNameMSFT.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations

@Override

public Class XrSpatialAnchorPersistenceNameMSFT

Description

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class XrSpatialAnchorPersistenceNameMSFT.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail