Package org.lwjgl.openxr

Class XrSpatialAnchorSpaceCreateInfoMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSpatialAnchorSpaceCreateInfoMSFT>

org.lwjgl.openxr.XrSpatialAnchorSpaceCreateInfoMSFT

All Implemented Interfaces:

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

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

Information to create a space from a spatial anchor.

Valid Usage (Implicit)

• The XR_MSFT_spatial_anchor extension must be enabled prior to using XrSpatialAnchorSpaceCreateInfoMSFT
• type must be TYPE_SPATIAL_ANCHOR_SPACE_CREATE_INFO_MSFT
• next must be NULL or a valid pointer to the next structure in a structure chain
• anchor must be a valid XrSpatialAnchorMSFT handle

See Also

XrPosef, CreateSpatialAnchorSpaceMSFT

Layout

 struct XrSpatialAnchorSpaceCreateInfoMSFT {
     XrStructureType type();
     void const * next();
     XrSpatialAnchorMSFT anchor();
     XrPosef poseInAnchorSpace();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

ANCHOR

public static final int ANCHOR

The struct member offsets.

POSEINANCHORSPACE

public static final int POSEINANCHORSPACE

The struct member offsets.

Constructor Details

XrSpatialAnchorSpaceCreateInfoMSFT

public XrSpatialAnchorSpaceCreateInfoMSFT(ByteBuffer container)

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

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.

anchor

public long anchor()

a handle to an XrSpatialAnchorMSFT previously created with CreateSpatialAnchorMSFT.

poseInAnchorSpace

public XrPosef poseInAnchorSpace()

an XrPosef defining the position and orientation of the new space’s origin relative to the anchor’s natural origin.

type

public XrSpatialAnchorSpaceCreateInfoMSFT type(int value)

Sets the specified value to the type() field.

type$Default

public XrSpatialAnchorSpaceCreateInfoMSFT type$Default()

Sets the TYPE_SPATIAL_ANCHOR_SPACE_CREATE_INFO_MSFT value to the type() field.

next

public XrSpatialAnchorSpaceCreateInfoMSFT next(long value)

Sets the specified value to the next() field.

anchor

public XrSpatialAnchorSpaceCreateInfoMSFT anchor(XrSpatialAnchorMSFT value)

Sets the specified value to the anchor() field.

poseInAnchorSpace

public XrSpatialAnchorSpaceCreateInfoMSFT poseInAnchorSpace(XrPosef value)

Copies the specified XrPosef to the poseInAnchorSpace() field.

poseInAnchorSpace

public XrSpatialAnchorSpaceCreateInfoMSFT poseInAnchorSpace(Consumer<XrPosef> consumer)

Passes the poseInAnchorSpace() field to the specified Consumer.

set

public XrSpatialAnchorSpaceCreateInfoMSFT set(int type,
 long next,
 XrSpatialAnchorMSFT anchor,
 XrPosef poseInAnchorSpace)

Initializes this struct with the specified values.

set

public XrSpatialAnchorSpaceCreateInfoMSFT set(XrSpatialAnchorSpaceCreateInfoMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSpatialAnchorSpaceCreateInfoMSFT malloc()

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

calloc

public static XrSpatialAnchorSpaceCreateInfoMSFT calloc()

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

create

public static XrSpatialAnchorSpaceCreateInfoMSFT create()

Returns a new XrSpatialAnchorSpaceCreateInfoMSFT instance allocated with BufferUtils.

create

public static XrSpatialAnchorSpaceCreateInfoMSFT create(long address)

Returns a new XrSpatialAnchorSpaceCreateInfoMSFT instance for the specified memory address.

createSafe

public static @Nullable XrSpatialAnchorSpaceCreateInfoMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSpatialAnchorSpaceCreateInfoMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSpatialAnchorSpaceCreateInfoMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSpatialAnchorSpaceCreateInfoMSFT.Buffer create(int capacity)

Returns a new XrSpatialAnchorSpaceCreateInfoMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSpatialAnchorSpaceCreateInfoMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSpatialAnchorSpaceCreateInfoMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nanchor

public static long nanchor(long struct)

Unsafe version of anchor().

nposeInAnchorSpace

public static XrPosef nposeInAnchorSpace(long struct)

Unsafe version of poseInAnchorSpace().

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.

nanchor

public static void nanchor(long struct,
 XrSpatialAnchorMSFT value)

Unsafe version of anchor.

nposeInAnchorSpace

public static void nposeInAnchorSpace(long struct,
 XrPosef value)

Unsafe version of poseInAnchorSpace.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate