Package org.lwjgl.openxr

Class XrSpatialAnchorNameHTC

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSpatialAnchorNameHTC>

org.lwjgl.openxr.XrSpatialAnchorNameHTC

All Implemented Interfaces:

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

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

The name of a spatial anchor.

Valid Usage (Implicit)

• The XR_HTC_anchor extension must be enabled prior to using XrSpatialAnchorNameHTC
• name must be a null-terminated UTF-8 string whose length is less than or equal to MAX_SPATIAL_ANCHOR_NAME_SIZE_HTC

See Also

XrSpatialAnchorCreateInfoHTC, GetSpatialAnchorNameHTC

Layout

 struct XrSpatialAnchorNameHTC {
     char name()[XR_MAX_SPATIAL_ANCHOR_NAME_SIZE_HTC];
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrSpatialAnchorNameHTC.Buffer	An array of XrSpatialAnchorNameHTC 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
XrSpatialAnchorNameHTC(ByteBuffer container)	Creates a XrSpatialAnchorNameHTC instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrSpatialAnchorNameHTC	calloc()	Returns a new XrSpatialAnchorNameHTC instance allocated with memCalloc.
static XrSpatialAnchorNameHTC.Buffer	calloc(int capacity)	Returns a new XrSpatialAnchorNameHTC.Buffer instance allocated with memCalloc.
static XrSpatialAnchorNameHTC.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorNameHTC.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSpatialAnchorNameHTC	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorNameHTC instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSpatialAnchorNameHTC	create()	Returns a new XrSpatialAnchorNameHTC instance allocated with BufferUtils.
static XrSpatialAnchorNameHTC.Buffer	create(int capacity)	Returns a new XrSpatialAnchorNameHTC.Buffer instance allocated with BufferUtils.
static XrSpatialAnchorNameHTC	create(long address)	Returns a new XrSpatialAnchorNameHTC instance for the specified memory address.
static XrSpatialAnchorNameHTC.Buffer	create(long address, int capacity)	Create a XrSpatialAnchorNameHTC.Buffer instance at the specified memory.
static @Nullable XrSpatialAnchorNameHTC	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSpatialAnchorNameHTC.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrSpatialAnchorNameHTC	malloc()	Returns a new XrSpatialAnchorNameHTC instance allocated with memAlloc.
static XrSpatialAnchorNameHTC.Buffer	malloc(int capacity)	Returns a new XrSpatialAnchorNameHTC.Buffer instance allocated with memAlloc.
static XrSpatialAnchorNameHTC.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorNameHTC.Buffer instance allocated on the specified MemoryStack.
static XrSpatialAnchorNameHTC	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorNameHTC instance allocated on the specified MemoryStack.
ByteBuffer	name()	a null-terminated UTF-8 string whose length is less than or equal to MAX_SPATIAL_ANCHOR_NAME_SIZE_HTC.
XrSpatialAnchorNameHTC	name(ByteBuffer value)	Copies the specified encoded string to the name() field.
String	nameString()	a null-terminated UTF-8 string whose length is less than or equal to MAX_SPATIAL_ANCHOR_NAME_SIZE_HTC.
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().
XrSpatialAnchorNameHTC	set(XrSpatialAnchorNameHTC 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

XrSpatialAnchorNameHTC

public XrSpatialAnchorNameHTC(ByteBuffer container)

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

name

public ByteBuffer name()

a null-terminated UTF-8 string whose length is less than or equal to MAX_SPATIAL_ANCHOR_NAME_SIZE_HTC.

nameString

public String nameString()

a null-terminated UTF-8 string whose length is less than or equal to MAX_SPATIAL_ANCHOR_NAME_SIZE_HTC.

name

public XrSpatialAnchorNameHTC name(ByteBuffer value)

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

set

public XrSpatialAnchorNameHTC set(XrSpatialAnchorNameHTC src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSpatialAnchorNameHTC malloc()

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

calloc

public static XrSpatialAnchorNameHTC calloc()

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

create

public static XrSpatialAnchorNameHTC create()

Returns a new XrSpatialAnchorNameHTC instance allocated with BufferUtils.

create

public static XrSpatialAnchorNameHTC create(long address)

Returns a new XrSpatialAnchorNameHTC instance for the specified memory address.

createSafe

public static @Nullable XrSpatialAnchorNameHTC createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSpatialAnchorNameHTC.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSpatialAnchorNameHTC.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSpatialAnchorNameHTC.Buffer create(int capacity)

Returns a new XrSpatialAnchorNameHTC.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSpatialAnchorNameHTC.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSpatialAnchorNameHTC instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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