Package org.lwjgl.openxr

Class XrCoordinateSpaceCreateInfoML

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrCoordinateSpaceCreateInfoML>

org.lwjgl.openxr.XrCoordinateSpaceCreateInfoML

All Implemented Interfaces:

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

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

Structure used to create an XrSpace from a cfuid.

Description

XrCoordinateSpaceCreateInfoML is provided as input when calling CreateSpaceFromCoordinateFrameUIDML to convert a Magic Leap SDK generated MLCoordinateFrameUID to an XrSpace. The conversion only needs to be done once even if the underlying MLCoordinateFrameUID changes its pose.

Valid Usage (Implicit)

• The XR_ML_compat extension must be enabled prior to using XrCoordinateSpaceCreateInfoML
• type must be TYPE_COORDINATE_SPACE_CREATE_INFO_ML
• next must be NULL or a valid pointer to the next structure in a structure chain
• cfuid must be a valid MLCoordinateFrameUID value

See Also

XrPosef, CreateSpaceFromCoordinateFrameUIDML

Layout

 struct XrCoordinateSpaceCreateInfoML {
     XrStructureType type();
     void const * next();
     MLCoordinateFrameUID cfuid();
     XrPosef poseInCoordinateSpace();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrCoordinateSpaceCreateInfoML	calloc()	Returns a new XrCoordinateSpaceCreateInfoML instance allocated with memCalloc.
static XrCoordinateSpaceCreateInfoML.Buffer	calloc(int capacity)	Returns a new XrCoordinateSpaceCreateInfoML.Buffer instance allocated with memCalloc.
static XrCoordinateSpaceCreateInfoML.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCoordinateSpaceCreateInfoML.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCoordinateSpaceCreateInfoML	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCoordinateSpaceCreateInfoML instance allocated on the specified MemoryStack and initializes all its bits to zero.
MLCoordinateFrameUID	cfuid()	the MLCoordinateFrameUID as generated by the non-OpenXR API in the Magic Leap SDK.
XrCoordinateSpaceCreateInfoML	cfuid(MLCoordinateFrameUID value)	Copies the specified MLCoordinateFrameUID to the cfuid() field.
static XrCoordinateSpaceCreateInfoML	create()	Returns a new XrCoordinateSpaceCreateInfoML instance allocated with BufferUtils.
static XrCoordinateSpaceCreateInfoML.Buffer	create(int capacity)	Returns a new XrCoordinateSpaceCreateInfoML.Buffer instance allocated with BufferUtils.
static XrCoordinateSpaceCreateInfoML	create(long address)	Returns a new XrCoordinateSpaceCreateInfoML instance for the specified memory address.
static XrCoordinateSpaceCreateInfoML.Buffer	create(long address, int capacity)	Create a XrCoordinateSpaceCreateInfoML.Buffer instance at the specified memory.
static @Nullable XrCoordinateSpaceCreateInfoML	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrCoordinateSpaceCreateInfoML.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrCoordinateSpaceCreateInfoML	malloc()	Returns a new XrCoordinateSpaceCreateInfoML instance allocated with memAlloc.
static XrCoordinateSpaceCreateInfoML.Buffer	malloc(int capacity)	Returns a new XrCoordinateSpaceCreateInfoML.Buffer instance allocated with memAlloc.
static XrCoordinateSpaceCreateInfoML.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCoordinateSpaceCreateInfoML.Buffer instance allocated on the specified MemoryStack.
static XrCoordinateSpaceCreateInfoML	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCoordinateSpaceCreateInfoML instance allocated on the specified MemoryStack.
static MLCoordinateFrameUID	ncfuid(long struct)	Unsafe version of cfuid().
static void	ncfuid(long struct, MLCoordinateFrameUID value)	Unsafe version of cfuid.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrCoordinateSpaceCreateInfoML	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	nposeInCoordinateSpace(long struct)	Unsafe version of poseInCoordinateSpace().
static void	nposeInCoordinateSpace(long struct, XrPosef value)	Unsafe version of poseInCoordinateSpace.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrPosef	poseInCoordinateSpace()	an XrPosef defining the position and orientation of the new space’s origin within the natural reference frame of the cfuid.
XrCoordinateSpaceCreateInfoML	poseInCoordinateSpace(Consumer<XrPosef> consumer)	Passes the poseInCoordinateSpace() field to the specified Consumer.
XrCoordinateSpaceCreateInfoML	poseInCoordinateSpace(XrPosef value)	Copies the specified XrPosef to the poseInCoordinateSpace() field.
XrCoordinateSpaceCreateInfoML	set(int type, long next, MLCoordinateFrameUID cfuid, XrPosef poseInCoordinateSpace)	Initializes this struct with the specified values.
XrCoordinateSpaceCreateInfoML	set(XrCoordinateSpaceCreateInfoML src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrCoordinateSpaceCreateInfoML	type(int value)	Sets the specified value to the type() field.
XrCoordinateSpaceCreateInfoML	type$Default()	Sets the TYPE_COORDINATE_SPACE_CREATE_INFO_ML value to the type() field.

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.

CFUID

public static final int CFUID

The struct member offsets.

POSEINCOORDINATESPACE

public static final int POSEINCOORDINATESPACE

The struct member offsets.

Constructor Details

XrCoordinateSpaceCreateInfoML

public XrCoordinateSpaceCreateInfoML(ByteBuffer container)

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

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.

cfuid

public MLCoordinateFrameUID cfuid()

the MLCoordinateFrameUID as generated by the non-OpenXR API in the Magic Leap SDK.

poseInCoordinateSpace

public XrPosef poseInCoordinateSpace()

an XrPosef defining the position and orientation of the new space’s origin within the natural reference frame of the cfuid.

type

public XrCoordinateSpaceCreateInfoML type(int value)

Sets the specified value to the type() field.

type$Default

public XrCoordinateSpaceCreateInfoML type$Default()

Sets the TYPE_COORDINATE_SPACE_CREATE_INFO_ML value to the type() field.

next

public XrCoordinateSpaceCreateInfoML next(long value)

Sets the specified value to the next() field.

cfuid

public XrCoordinateSpaceCreateInfoML cfuid(MLCoordinateFrameUID value)

Copies the specified MLCoordinateFrameUID to the cfuid() field.

poseInCoordinateSpace

public XrCoordinateSpaceCreateInfoML poseInCoordinateSpace(XrPosef value)

Copies the specified XrPosef to the poseInCoordinateSpace() field.

poseInCoordinateSpace

public XrCoordinateSpaceCreateInfoML poseInCoordinateSpace(Consumer<XrPosef> consumer)

Passes the poseInCoordinateSpace() field to the specified Consumer.

set

public XrCoordinateSpaceCreateInfoML set(int type,
 long next,
 MLCoordinateFrameUID cfuid,
 XrPosef poseInCoordinateSpace)

Initializes this struct with the specified values.

set

public XrCoordinateSpaceCreateInfoML set(XrCoordinateSpaceCreateInfoML src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrCoordinateSpaceCreateInfoML malloc()

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

calloc

public static XrCoordinateSpaceCreateInfoML calloc()

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

create

public static XrCoordinateSpaceCreateInfoML create()

Returns a new XrCoordinateSpaceCreateInfoML instance allocated with BufferUtils.

create

public static XrCoordinateSpaceCreateInfoML create(long address)

Returns a new XrCoordinateSpaceCreateInfoML instance for the specified memory address.

createSafe

public static @Nullable XrCoordinateSpaceCreateInfoML createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrCoordinateSpaceCreateInfoML.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrCoordinateSpaceCreateInfoML.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrCoordinateSpaceCreateInfoML.Buffer create(int capacity)

Returns a new XrCoordinateSpaceCreateInfoML.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrCoordinateSpaceCreateInfoML.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrCoordinateSpaceCreateInfoML instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ncfuid

public static MLCoordinateFrameUID ncfuid(long struct)

Unsafe version of cfuid().

nposeInCoordinateSpace

public static XrPosef nposeInCoordinateSpace(long struct)

Unsafe version of poseInCoordinateSpace().

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.

ncfuid

public static void ncfuid(long struct,
 MLCoordinateFrameUID value)

Unsafe version of cfuid.

nposeInCoordinateSpace

public static void nposeInCoordinateSpace(long struct,
 XrPosef value)

Unsafe version of poseInCoordinateSpace.