Package org.lwjgl.openxr

Class XrSpatialAnchorCreateInfoFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSpatialAnchorCreateInfoFB>

org.lwjgl.openxr.XrSpatialAnchorCreateInfoFB

All Implemented Interfaces:

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

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

Parameters to create a new spatial anchor.

Description

Parameters to create a new spatial anchor.

Valid Usage (Implicit)

• The XR_FB_spatial_entity extension must be enabled prior to using XrSpatialAnchorCreateInfoFB
• type must be TYPE_SPATIAL_ANCHOR_CREATE_INFO_FB
• next must be NULL or a valid pointer to the next structure in a structure chain
• space must be a valid XrSpace handle

See Also

XrPosef, CreateSpatialAnchorFB

Layout

 struct XrSpatialAnchorCreateInfoFB {
     XrStructureType type();
     void const * next();
     XrSpace space();
     XrPosef poseInSpace();
     XrTime time();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrSpatialAnchorCreateInfoFB	calloc()	Returns a new XrSpatialAnchorCreateInfoFB instance allocated with memCalloc.
static XrSpatialAnchorCreateInfoFB.Buffer	calloc(int capacity)	Returns a new XrSpatialAnchorCreateInfoFB.Buffer instance allocated with memCalloc.
static XrSpatialAnchorCreateInfoFB.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorCreateInfoFB.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSpatialAnchorCreateInfoFB	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorCreateInfoFB instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSpatialAnchorCreateInfoFB	create()	Returns a new XrSpatialAnchorCreateInfoFB instance allocated with BufferUtils.
static XrSpatialAnchorCreateInfoFB.Buffer	create(int capacity)	Returns a new XrSpatialAnchorCreateInfoFB.Buffer instance allocated with BufferUtils.
static XrSpatialAnchorCreateInfoFB	create(long address)	Returns a new XrSpatialAnchorCreateInfoFB instance for the specified memory address.
static XrSpatialAnchorCreateInfoFB.Buffer	create(long address, int capacity)	Create a XrSpatialAnchorCreateInfoFB.Buffer instance at the specified memory.
static @Nullable XrSpatialAnchorCreateInfoFB	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSpatialAnchorCreateInfoFB.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrSpatialAnchorCreateInfoFB	malloc()	Returns a new XrSpatialAnchorCreateInfoFB instance allocated with memAlloc.
static XrSpatialAnchorCreateInfoFB.Buffer	malloc(int capacity)	Returns a new XrSpatialAnchorCreateInfoFB.Buffer instance allocated with memAlloc.
static XrSpatialAnchorCreateInfoFB.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorCreateInfoFB.Buffer instance allocated on the specified MemoryStack.
static XrSpatialAnchorCreateInfoFB	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSpatialAnchorCreateInfoFB instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSpatialAnchorCreateInfoFB	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 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 long	ntime(long struct)	Unsafe version of time().
static void	ntime(long struct, long value)	Unsafe version of time.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrPosef	poseInSpace()	the XrPosef location and orientation of the Spatial Anchor in the specified reference space.
XrSpatialAnchorCreateInfoFB	poseInSpace(Consumer<XrPosef> consumer)	Passes the poseInSpace() field to the specified Consumer.
XrSpatialAnchorCreateInfoFB	poseInSpace(XrPosef value)	Copies the specified XrPosef to the poseInSpace() field.
XrSpatialAnchorCreateInfoFB	set(int type, long next, XrSpace space, XrPosef poseInSpace, long time)	Initializes this struct with the specified values.
XrSpatialAnchorCreateInfoFB	set(XrSpatialAnchorCreateInfoFB src)	Copies the specified struct data to this struct.
int	sizeof()
long	space()	the XrSpace handle to the reference space that defines the poseInSpace of the anchor to be defined.
XrSpatialAnchorCreateInfoFB	space(XrSpace value)	Sets the specified value to the space() field.
long	time()	the XrTime timestamp associated with the specified pose.
XrSpatialAnchorCreateInfoFB	time(long value)	Sets the specified value to the time() field.
int	type()	the XrStructureType of this structure.
XrSpatialAnchorCreateInfoFB	type(int value)	Sets the specified value to the type() field.
XrSpatialAnchorCreateInfoFB	type$Default()	Sets the TYPE_SPATIAL_ANCHOR_CREATE_INFO_FB 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.

TIME

public static final int TIME

The struct member offsets.

Constructor Details

XrSpatialAnchorCreateInfoFB

public XrSpatialAnchorCreateInfoFB(ByteBuffer container)

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

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 handle to the reference space that defines the poseInSpace of the anchor to be defined.

poseInSpace

public XrPosef poseInSpace()

the XrPosef location and orientation of the Spatial Anchor in the specified reference space.

time

public long time()

the XrTime timestamp associated with the specified pose.

type

public XrSpatialAnchorCreateInfoFB type(int value)

Sets the specified value to the type() field.

type$Default

public XrSpatialAnchorCreateInfoFB type$Default()

Sets the TYPE_SPATIAL_ANCHOR_CREATE_INFO_FB value to the type() field.

next

public XrSpatialAnchorCreateInfoFB next(long value)

Sets the specified value to the next() field.

space

public XrSpatialAnchorCreateInfoFB space(XrSpace value)

Sets the specified value to the space() field.

poseInSpace

public XrSpatialAnchorCreateInfoFB poseInSpace(XrPosef value)

Copies the specified XrPosef to the poseInSpace() field.

poseInSpace

public XrSpatialAnchorCreateInfoFB poseInSpace(Consumer<XrPosef> consumer)

Passes the poseInSpace() field to the specified Consumer.

time

public XrSpatialAnchorCreateInfoFB time(long value)

Sets the specified value to the time() field.

set

public XrSpatialAnchorCreateInfoFB set(int type,
 long next,
 XrSpace space,
 XrPosef poseInSpace,
 long time)

Initializes this struct with the specified values.

set

public XrSpatialAnchorCreateInfoFB set(XrSpatialAnchorCreateInfoFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSpatialAnchorCreateInfoFB malloc()

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

calloc

public static XrSpatialAnchorCreateInfoFB calloc()

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

create

public static XrSpatialAnchorCreateInfoFB create()

Returns a new XrSpatialAnchorCreateInfoFB instance allocated with BufferUtils.

create

public static XrSpatialAnchorCreateInfoFB create(long address)

Returns a new XrSpatialAnchorCreateInfoFB instance for the specified memory address.

createSafe

public static @Nullable XrSpatialAnchorCreateInfoFB createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSpatialAnchorCreateInfoFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSpatialAnchorCreateInfoFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSpatialAnchorCreateInfoFB.Buffer create(int capacity)

Returns a new XrSpatialAnchorCreateInfoFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSpatialAnchorCreateInfoFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSpatialAnchorCreateInfoFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ntime

public static long ntime(long struct)

Unsafe version of time().

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.

ntime

public static void ntime(long struct,
 long value)

Unsafe version of time.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate