Package org.lwjgl.openxr

Class XrSpatialAnchorCreateInfoHTC

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSpatialAnchorCreateInfoHTC>

org.lwjgl.openxr.XrSpatialAnchorCreateInfoHTC

All Implemented Interfaces:

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

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

Information to create a spatial anchor.

Description

The poseInSpace is transformed into world space to specify the point in the real world. The anchor tracks changes of the reality and may not be affected by the changes of space.

Valid Usage (Implicit)

• The XR_HTC_anchor extension must be enabled prior to using XrSpatialAnchorCreateInfoHTC
• type must be TYPE_SPATIAL_ANCHOR_CREATE_INFO_HTC
• next must be NULL or a valid pointer to the next structure in a structure chain
• space must be a valid XrSpace handle
• name must be a valid XrSpatialAnchorNameHTC structure

See Also

XrPosef, XrSpatialAnchorNameHTC, CreateSpatialAnchorHTC

Layout

 struct XrSpatialAnchorCreateInfoHTC {
     XrStructureType type();
     void const * next();
     XrSpace space();
     XrPosef poseInSpace();
     XrSpatialAnchorNameHTC name();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrSpatialAnchorCreateInfoHTC.Buffer	An array of XrSpatialAnchorCreateInfoHTC 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	NEXT	The struct member offsets.
static final int	POSEINSPACE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SPACE	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
XrSpatialAnchorCreateInfoHTC(ByteBuffer container)	Creates a XrSpatialAnchorCreateInfoHTC instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrSpatialAnchorCreateInfoHTC	calloc()	Returns a new XrSpatialAnchorCreateInfoHTC instance allocated with memCalloc.
static XrSpatialAnchorCreateInfoHTC.Buffer	calloc(int capacity)	Returns a new XrSpatialAnchorCreateInfoHTC.Buffer instance allocated with memCalloc.
static XrSpatialAnchorCreateInfoHTC.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorCreateInfoHTC.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSpatialAnchorCreateInfoHTC	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorCreateInfoHTC instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSpatialAnchorCreateInfoHTC	create()	Returns a new XrSpatialAnchorCreateInfoHTC instance allocated with BufferUtils.
static XrSpatialAnchorCreateInfoHTC.Buffer	create(int capacity)	Returns a new XrSpatialAnchorCreateInfoHTC.Buffer instance allocated with BufferUtils.
static XrSpatialAnchorCreateInfoHTC	create(long address)	Returns a new XrSpatialAnchorCreateInfoHTC instance for the specified memory address.
static XrSpatialAnchorCreateInfoHTC.Buffer	create(long address, int capacity)	Create a XrSpatialAnchorCreateInfoHTC.Buffer instance at the specified memory.
static @Nullable XrSpatialAnchorCreateInfoHTC	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSpatialAnchorCreateInfoHTC.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrSpatialAnchorCreateInfoHTC	malloc()	Returns a new XrSpatialAnchorCreateInfoHTC instance allocated with memAlloc.
static XrSpatialAnchorCreateInfoHTC.Buffer	malloc(int capacity)	Returns a new XrSpatialAnchorCreateInfoHTC.Buffer instance allocated with memAlloc.
static XrSpatialAnchorCreateInfoHTC.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorCreateInfoHTC.Buffer instance allocated on the specified MemoryStack.
static XrSpatialAnchorCreateInfoHTC	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorCreateInfoHTC instance allocated on the specified MemoryStack.
XrSpatialAnchorNameHTC	name()	the XrSpatialAnchorNameHTC containing the name of the anchor.
XrSpatialAnchorCreateInfoHTC	name(Consumer<XrSpatialAnchorNameHTC> consumer)	Passes the name() field to the specified Consumer.
XrSpatialAnchorCreateInfoHTC	name(XrSpatialAnchorNameHTC value)	Copies the specified XrSpatialAnchorNameHTC to the name() field.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSpatialAnchorCreateInfoHTC	next(long value)	Sets the specified value to the next() field.
static XrSpatialAnchorNameHTC	nname(long struct)	Unsafe version of name().
static void	nname(long struct, XrSpatialAnchorNameHTC value)	Unsafe version of name.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static XrPosef	nposeInSpace(long struct)	Unsafe version of poseInSpace().
static void	nposeInSpace(long struct, XrPosef value)	Unsafe version of poseInSpace.
static long	nspace(long struct)	Unsafe version of space().
static void	nspace(long struct, XrSpace value)	Unsafe version of space.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrPosef	poseInSpace()	the XrPosef specifying the point in the real world within space.
XrSpatialAnchorCreateInfoHTC	poseInSpace(Consumer<XrPosef> consumer)	Passes the poseInSpace() field to the specified Consumer.
XrSpatialAnchorCreateInfoHTC	poseInSpace(XrPosef value)	Copies the specified XrPosef to the poseInSpace() field.
XrSpatialAnchorCreateInfoHTC	set(int type, long next, XrSpace space, XrPosef poseInSpace, XrSpatialAnchorNameHTC name)	Initializes this struct with the specified values.
XrSpatialAnchorCreateInfoHTC	set(XrSpatialAnchorCreateInfoHTC src)	Copies the specified struct data to this struct.
int	sizeof()
long	space()	the XrSpace in which poseInSpace is specified.
XrSpatialAnchorCreateInfoHTC	space(XrSpace value)	Sets the specified value to the space() field.
int	type()	the XrStructureType of this structure.
XrSpatialAnchorCreateInfoHTC	type(int value)	Sets the specified value to the type() field.
XrSpatialAnchorCreateInfoHTC	type$Default()	Sets the TYPE_SPATIAL_ANCHOR_CREATE_INFO_HTC 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.

SPACE

public static final int SPACE

The struct member offsets.

POSEINSPACE

public static final int POSEINSPACE

The struct member offsets.

NAME

public static final int NAME

The struct member offsets.

Constructor Details

XrSpatialAnchorCreateInfoHTC

public XrSpatialAnchorCreateInfoHTC(ByteBuffer container)

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

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 or this extension.

space

public long space()

the XrSpace in which poseInSpace is specified.

poseInSpace

public XrPosef poseInSpace()

the XrPosef specifying the point in the real world within space.

name

public XrSpatialAnchorNameHTC name()

the XrSpatialAnchorNameHTC containing the name of the anchor.

type

public XrSpatialAnchorCreateInfoHTC type(int value)

Sets the specified value to the type() field.

type$Default

public XrSpatialAnchorCreateInfoHTC type$Default()

Sets the TYPE_SPATIAL_ANCHOR_CREATE_INFO_HTC value to the type() field.

next

public XrSpatialAnchorCreateInfoHTC next(long value)

Sets the specified value to the next() field.

space

public XrSpatialAnchorCreateInfoHTC space(XrSpace value)

Sets the specified value to the space() field.

poseInSpace

public XrSpatialAnchorCreateInfoHTC poseInSpace(XrPosef value)

Copies the specified XrPosef to the poseInSpace() field.

poseInSpace

public XrSpatialAnchorCreateInfoHTC poseInSpace(Consumer<XrPosef> consumer)

Passes the poseInSpace() field to the specified Consumer.

name

public XrSpatialAnchorCreateInfoHTC name(XrSpatialAnchorNameHTC value)

Copies the specified XrSpatialAnchorNameHTC to the name() field.

name

public XrSpatialAnchorCreateInfoHTC name(Consumer<XrSpatialAnchorNameHTC> consumer)

Passes the name() field to the specified Consumer.

set

public XrSpatialAnchorCreateInfoHTC set(int type,
 long next,
 XrSpace space,
 XrPosef poseInSpace,
 XrSpatialAnchorNameHTC name)

Initializes this struct with the specified values.

set

public XrSpatialAnchorCreateInfoHTC set(XrSpatialAnchorCreateInfoHTC src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSpatialAnchorCreateInfoHTC malloc()

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

calloc

public static XrSpatialAnchorCreateInfoHTC calloc()

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

create

public static XrSpatialAnchorCreateInfoHTC create()

Returns a new XrSpatialAnchorCreateInfoHTC instance allocated with BufferUtils.

create

public static XrSpatialAnchorCreateInfoHTC create(long address)

Returns a new XrSpatialAnchorCreateInfoHTC instance for the specified memory address.

createSafe

public static @Nullable XrSpatialAnchorCreateInfoHTC createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSpatialAnchorCreateInfoHTC.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSpatialAnchorCreateInfoHTC.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSpatialAnchorCreateInfoHTC.Buffer create(int capacity)

Returns a new XrSpatialAnchorCreateInfoHTC.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSpatialAnchorCreateInfoHTC.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSpatialAnchorCreateInfoHTC instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nspace

public static long nspace(long struct)

Unsafe version of space().

nposeInSpace

public static XrPosef nposeInSpace(long struct)

Unsafe version of poseInSpace().

nname

public static XrSpatialAnchorNameHTC nname(long struct)

Unsafe version of name().

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.

nspace

public static void nspace(long struct,
 XrSpace value)

Unsafe version of space.

nposeInSpace

public static void nposeInSpace(long struct,
 XrPosef value)

Unsafe version of poseInSpace.

nname

public static void nname(long struct,
 XrSpatialAnchorNameHTC value)

Unsafe version of name.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate