Package org.lwjgl.openxr

Class XrReferenceSpaceCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrReferenceSpaceCreateInfo>

org.lwjgl.openxr.XrReferenceSpaceCreateInfo

All Implemented Interfaces:

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

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

Creation info for a reference space.

Valid Usage (Implicit)

• type must be TYPE_REFERENCE_SPACE_CREATE_INFO
• next must be NULL or a valid pointer to the next structure in a structure chain
• referenceSpaceType must be a valid XrReferenceSpaceType value

See Also

XrPosef, CreateReferenceSpace

Layout

 struct XrReferenceSpaceCreateInfo {
     XrStructureType type();
     void const * next();
     XrReferenceSpaceType referenceSpaceType();
     XrPosef poseInReferenceSpace();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrReferenceSpaceCreateInfo.Buffer	An array of XrReferenceSpaceCreateInfo 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	POSEINREFERENCESPACE	The struct member offsets.
static final int	REFERENCESPACETYPE	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
XrReferenceSpaceCreateInfo(ByteBuffer container)	Creates a XrReferenceSpaceCreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

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

REFERENCESPACETYPE

public static final int REFERENCESPACETYPE

The struct member offsets.

POSEINREFERENCESPACE

public static final int POSEINREFERENCESPACE

The struct member offsets.

Constructor Details

XrReferenceSpaceCreateInfo

public XrReferenceSpaceCreateInfo(ByteBuffer container)

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

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.

referenceSpaceType

public int referenceSpaceType()

the chosen XrReferenceSpaceType.

poseInReferenceSpace

public XrPosef poseInReferenceSpace()

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

type

public XrReferenceSpaceCreateInfo type(int value)

Sets the specified value to the type() field.

type$Default

public XrReferenceSpaceCreateInfo type$Default()

Sets the TYPE_REFERENCE_SPACE_CREATE_INFO value to the type() field.

next

public XrReferenceSpaceCreateInfo next(long value)

Sets the specified value to the next() field.

referenceSpaceType

public XrReferenceSpaceCreateInfo referenceSpaceType(int value)

Sets the specified value to the referenceSpaceType() field.

poseInReferenceSpace

public XrReferenceSpaceCreateInfo poseInReferenceSpace(XrPosef value)

Copies the specified XrPosef to the poseInReferenceSpace() field.

poseInReferenceSpace

public XrReferenceSpaceCreateInfo poseInReferenceSpace(Consumer<XrPosef> consumer)

Passes the poseInReferenceSpace() field to the specified Consumer.

set

public XrReferenceSpaceCreateInfo set(int type,
 long next,
 int referenceSpaceType,
 XrPosef poseInReferenceSpace)

Initializes this struct with the specified values.

set

public XrReferenceSpaceCreateInfo set(XrReferenceSpaceCreateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrReferenceSpaceCreateInfo malloc()

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

calloc

public static XrReferenceSpaceCreateInfo calloc()

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

create

public static XrReferenceSpaceCreateInfo create()

Returns a new XrReferenceSpaceCreateInfo instance allocated with BufferUtils.

create

public static XrReferenceSpaceCreateInfo create(long address)

Returns a new XrReferenceSpaceCreateInfo instance for the specified memory address.

createSafe

public static @Nullable XrReferenceSpaceCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrReferenceSpaceCreateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrReferenceSpaceCreateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrReferenceSpaceCreateInfo.Buffer create(int capacity)

Returns a new XrReferenceSpaceCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrReferenceSpaceCreateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrReferenceSpaceCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nreferenceSpaceType

public static int nreferenceSpaceType(long struct)

Unsafe version of referenceSpaceType().

nposeInReferenceSpace

public static XrPosef nposeInReferenceSpace(long struct)

Unsafe version of poseInReferenceSpace().

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.

nreferenceSpaceType

public static void nreferenceSpaceType(long struct,
 int value)

Unsafe version of referenceSpaceType.

nposeInReferenceSpace

public static void nposeInReferenceSpace(long struct,
 XrPosef value)

Unsafe version of poseInReferenceSpace.