Package org.lwjgl.openxr

Class XrSceneComponentLocationMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSceneComponentLocationMSFT>

org.lwjgl.openxr.XrSceneComponentLocationMSFT

All Implemented Interfaces:

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

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

Describes the location of a scene component.

Valid Usage (Implicit)

• The XR_MSFT_scene_understanding extension must be enabled prior to using XrSceneComponentLocationMSFT
• flags must be 0 or a valid combination of XrSpaceLocationFlagBits values

See Also

XrPosef, XrSceneComponentLocationsMSFT

Layout

 struct XrSceneComponentLocationMSFT {
     XrSpaceLocationFlags flags();
     XrPosef pose();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrSceneComponentLocationMSFT.Buffer	An array of XrSceneComponentLocationMSFT 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	FLAGS	The struct member offsets.
static final int	POSE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
XrSceneComponentLocationMSFT(ByteBuffer container)	Creates a XrSceneComponentLocationMSFT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrSceneComponentLocationMSFT	calloc()	Returns a new XrSceneComponentLocationMSFT instance allocated with memCalloc.
static XrSceneComponentLocationMSFT.Buffer	calloc(int capacity)	Returns a new XrSceneComponentLocationMSFT.Buffer instance allocated with memCalloc.
static XrSceneComponentLocationMSFT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneComponentLocationMSFT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSceneComponentLocationMSFT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneComponentLocationMSFT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSceneComponentLocationMSFT	create()	Returns a new XrSceneComponentLocationMSFT instance allocated with BufferUtils.
static XrSceneComponentLocationMSFT.Buffer	create(int capacity)	Returns a new XrSceneComponentLocationMSFT.Buffer instance allocated with BufferUtils.
static XrSceneComponentLocationMSFT	create(long address)	Returns a new XrSceneComponentLocationMSFT instance for the specified memory address.
static XrSceneComponentLocationMSFT.Buffer	create(long address, int capacity)	Create a XrSceneComponentLocationMSFT.Buffer instance at the specified memory.
static @Nullable XrSceneComponentLocationMSFT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSceneComponentLocationMSFT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	flags()	a bitfield, with bit masks defined in XrSpaceLocationFlagBits, to indicate which members contain valid data.
XrSceneComponentLocationMSFT	flags(long value)	Sets the specified value to the flags() field.
static XrSceneComponentLocationMSFT	malloc()	Returns a new XrSceneComponentLocationMSFT instance allocated with memAlloc.
static XrSceneComponentLocationMSFT.Buffer	malloc(int capacity)	Returns a new XrSceneComponentLocationMSFT.Buffer instance allocated with memAlloc.
static XrSceneComponentLocationMSFT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneComponentLocationMSFT.Buffer instance allocated on the specified MemoryStack.
static XrSceneComponentLocationMSFT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneComponentLocationMSFT instance allocated on the specified MemoryStack.
static long	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, long value)	Unsafe version of flags.
static XrPosef	npose(long struct)	Unsafe version of pose().
static void	npose(long struct, XrPosef value)	Unsafe version of pose.
XrPosef	pose()	an XrPosef defining the position and orientation of the scene component within the reference frame of the corresponding XrSceneComponentsLocateInfoMSFT::baseSpace.
XrSceneComponentLocationMSFT	pose(Consumer<XrPosef> consumer)	Passes the pose() field to the specified Consumer.
XrSceneComponentLocationMSFT	pose(XrPosef value)	Copies the specified XrPosef to the pose() field.
XrSceneComponentLocationMSFT	set(long flags, XrPosef pose)	Initializes this struct with the specified values.
XrSceneComponentLocationMSFT	set(XrSceneComponentLocationMSFT src)	Copies the specified struct data to this struct.
int	sizeof()

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.

FLAGS

public static final int FLAGS

The struct member offsets.

POSE

public static final int POSE

The struct member offsets.

Constructor Details

XrSceneComponentLocationMSFT

public XrSceneComponentLocationMSFT(ByteBuffer container)

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

flags

public long flags()

a bitfield, with bit masks defined in XrSpaceLocationFlagBits, to indicate which members contain valid data.

pose

public XrPosef pose()

an XrPosef defining the position and orientation of the scene component within the reference frame of the corresponding XrSceneComponentsLocateInfoMSFT::baseSpace.

flags

public XrSceneComponentLocationMSFT flags(long value)

Sets the specified value to the flags() field.

pose

public XrSceneComponentLocationMSFT pose(XrPosef value)

Copies the specified XrPosef to the pose() field.

pose

public XrSceneComponentLocationMSFT pose(Consumer<XrPosef> consumer)

Passes the pose() field to the specified Consumer.

set

public XrSceneComponentLocationMSFT set(long flags,
 XrPosef pose)

Initializes this struct with the specified values.

set

public XrSceneComponentLocationMSFT set(XrSceneComponentLocationMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSceneComponentLocationMSFT malloc()

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

calloc

public static XrSceneComponentLocationMSFT calloc()

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

create

public static XrSceneComponentLocationMSFT create()

Returns a new XrSceneComponentLocationMSFT instance allocated with BufferUtils.

create

public static XrSceneComponentLocationMSFT create(long address)

Returns a new XrSceneComponentLocationMSFT instance for the specified memory address.

createSafe

public static @Nullable XrSceneComponentLocationMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSceneComponentLocationMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSceneComponentLocationMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSceneComponentLocationMSFT.Buffer create(int capacity)

Returns a new XrSceneComponentLocationMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSceneComponentLocationMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSceneComponentLocationMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new XrSceneComponentLocationMSFT.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

nflags

public static long nflags(long struct)

Unsafe version of flags().

npose

public static XrPosef npose(long struct)

Unsafe version of pose().

nflags

public static void nflags(long struct,
 long value)

Unsafe version of flags.

npose

public static void npose(long struct,
 XrPosef value)

Unsafe version of pose.