Package org.lwjgl.openxr

Class XrSceneOrientedBoxBoundMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSceneOrientedBoxBoundMSFT>

org.lwjgl.openxr.XrSceneOrientedBoxBoundMSFT

All Implemented Interfaces:

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

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

Describe a scene oriented box bounds.

Description

The runtime must return ERROR_VALIDATION_FAILURE if any component of extents is not finite or less than or equal to zero.

Valid Usage (Implicit)

• The XR_MSFT_scene_understanding extension must be enabled prior to using XrSceneOrientedBoxBoundMSFT

See Also

XrPosef, XrSceneBoundsMSFT, XrVector3f

Layout

 struct XrSceneOrientedBoxBoundMSFT {
     XrPosef pose();
     XrVector3f extents();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrSceneOrientedBoxBoundMSFT	calloc()	Returns a new XrSceneOrientedBoxBoundMSFT instance allocated with memCalloc.
static XrSceneOrientedBoxBoundMSFT.Buffer	calloc(int capacity)	Returns a new XrSceneOrientedBoxBoundMSFT.Buffer instance allocated with memCalloc.
static XrSceneOrientedBoxBoundMSFT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneOrientedBoxBoundMSFT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSceneOrientedBoxBoundMSFT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneOrientedBoxBoundMSFT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSceneOrientedBoxBoundMSFT	create()	Returns a new XrSceneOrientedBoxBoundMSFT instance allocated with BufferUtils.
static XrSceneOrientedBoxBoundMSFT.Buffer	create(int capacity)	Returns a new XrSceneOrientedBoxBoundMSFT.Buffer instance allocated with BufferUtils.
static XrSceneOrientedBoxBoundMSFT	create(long address)	Returns a new XrSceneOrientedBoxBoundMSFT instance for the specified memory address.
static XrSceneOrientedBoxBoundMSFT.Buffer	create(long address, int capacity)	Create a XrSceneOrientedBoxBoundMSFT.Buffer instance at the specified memory.
static @Nullable XrSceneOrientedBoxBoundMSFT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSceneOrientedBoxBoundMSFT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
XrVector3f	extents()	an XrVector3f defining the edge-to-edge length of the box along each dimension with pose as the center.
XrSceneOrientedBoxBoundMSFT	extents(Consumer<XrVector3f> consumer)	Passes the extents() field to the specified Consumer.
XrSceneOrientedBoxBoundMSFT	extents(XrVector3f value)	Copies the specified XrVector3f to the extents() field.
static XrSceneOrientedBoxBoundMSFT	malloc()	Returns a new XrSceneOrientedBoxBoundMSFT instance allocated with memAlloc.
static XrSceneOrientedBoxBoundMSFT.Buffer	malloc(int capacity)	Returns a new XrSceneOrientedBoxBoundMSFT.Buffer instance allocated with memAlloc.
static XrSceneOrientedBoxBoundMSFT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneOrientedBoxBoundMSFT.Buffer instance allocated on the specified MemoryStack.
static XrSceneOrientedBoxBoundMSFT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneOrientedBoxBoundMSFT instance allocated on the specified MemoryStack.
static XrVector3f	nextents(long struct)	Unsafe version of extents().
static void	nextents(long struct, XrVector3f value)	Unsafe version of extents.
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 center position and orientation of the oriented bounding box bound within the reference frame of the corresponding XrSceneBoundsMSFT::space.
XrSceneOrientedBoxBoundMSFT	pose(Consumer<XrPosef> consumer)	Passes the pose() field to the specified Consumer.
XrSceneOrientedBoxBoundMSFT	pose(XrPosef value)	Copies the specified XrPosef to the pose() field.
XrSceneOrientedBoxBoundMSFT	set(XrPosef pose, XrVector3f extents)	Initializes this struct with the specified values.
XrSceneOrientedBoxBoundMSFT	set(XrSceneOrientedBoxBoundMSFT 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.

POSE

public static final int POSE

The struct member offsets.

EXTENTS

public static final int EXTENTS

The struct member offsets.

Constructor Details

XrSceneOrientedBoxBoundMSFT

public XrSceneOrientedBoxBoundMSFT(ByteBuffer container)

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

pose

public XrPosef pose()

an XrPosef defining the center position and orientation of the oriented bounding box bound within the reference frame of the corresponding XrSceneBoundsMSFT::space.

extents

public XrVector3f extents()

an XrVector3f defining the edge-to-edge length of the box along each dimension with pose as the center.

pose

public XrSceneOrientedBoxBoundMSFT pose(XrPosef value)

Copies the specified XrPosef to the pose() field.

pose

public XrSceneOrientedBoxBoundMSFT pose(Consumer<XrPosef> consumer)

Passes the pose() field to the specified Consumer.

extents

public XrSceneOrientedBoxBoundMSFT extents(XrVector3f value)

Copies the specified XrVector3f to the extents() field.

extents

public XrSceneOrientedBoxBoundMSFT extents(Consumer<XrVector3f> consumer)

Passes the extents() field to the specified Consumer.

set

public XrSceneOrientedBoxBoundMSFT set(XrPosef pose,
 XrVector3f extents)

Initializes this struct with the specified values.

set

public XrSceneOrientedBoxBoundMSFT set(XrSceneOrientedBoxBoundMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSceneOrientedBoxBoundMSFT malloc()

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

calloc

public static XrSceneOrientedBoxBoundMSFT calloc()

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

create

public static XrSceneOrientedBoxBoundMSFT create()

Returns a new XrSceneOrientedBoxBoundMSFT instance allocated with BufferUtils.

create

public static XrSceneOrientedBoxBoundMSFT create(long address)

Returns a new XrSceneOrientedBoxBoundMSFT instance for the specified memory address.

createSafe

public static @Nullable XrSceneOrientedBoxBoundMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSceneOrientedBoxBoundMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSceneOrientedBoxBoundMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSceneOrientedBoxBoundMSFT.Buffer create(int capacity)

Returns a new XrSceneOrientedBoxBoundMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSceneOrientedBoxBoundMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSceneOrientedBoxBoundMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

npose

public static XrPosef npose(long struct)

Unsafe version of pose().

nextents

public static XrVector3f nextents(long struct)

Unsafe version of extents().

npose

public static void npose(long struct,
 XrPosef value)

Unsafe version of pose.

nextents

public static void nextents(long struct,
 XrVector3f value)

Unsafe version of extents.