Package org.lwjgl.openxr

Class XrSceneSphereBoundMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSceneSphereBoundMSFT>

org.lwjgl.openxr.XrSceneSphereBoundMSFT

All Implemented Interfaces:

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

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

Describe a scene sphere bounds.

Description

The runtime must return ERROR_VALIDATION_FAILURE if radius is not a finite positive value.

Valid Usage (Implicit)

• The XR_MSFT_scene_understanding extension must be enabled prior to using XrSceneSphereBoundMSFT

See Also

XrSceneBoundsMSFT, XrVector3f

Layout

 struct XrSceneSphereBoundMSFT {
     XrVector3f center();
     float radius();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrSceneSphereBoundMSFT	calloc()	Returns a new XrSceneSphereBoundMSFT instance allocated with memCalloc.
static XrSceneSphereBoundMSFT.Buffer	calloc(int capacity)	Returns a new XrSceneSphereBoundMSFT.Buffer instance allocated with memCalloc.
static XrSceneSphereBoundMSFT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneSphereBoundMSFT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSceneSphereBoundMSFT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneSphereBoundMSFT instance allocated on the specified MemoryStack and initializes all its bits to zero.
XrVector3f	center()	an XrVector3f representing the center of the sphere bound within the reference frame of the corresponding XrSceneBoundsMSFT::space.
XrSceneSphereBoundMSFT	center(Consumer<XrVector3f> consumer)	Passes the center() field to the specified Consumer.
XrSceneSphereBoundMSFT	center(XrVector3f value)	Copies the specified XrVector3f to the center() field.
static XrSceneSphereBoundMSFT	create()	Returns a new XrSceneSphereBoundMSFT instance allocated with BufferUtils.
static XrSceneSphereBoundMSFT.Buffer	create(int capacity)	Returns a new XrSceneSphereBoundMSFT.Buffer instance allocated with BufferUtils.
static XrSceneSphereBoundMSFT	create(long address)	Returns a new XrSceneSphereBoundMSFT instance for the specified memory address.
static XrSceneSphereBoundMSFT.Buffer	create(long address, int capacity)	Create a XrSceneSphereBoundMSFT.Buffer instance at the specified memory.
static @Nullable XrSceneSphereBoundMSFT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSceneSphereBoundMSFT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrSceneSphereBoundMSFT	malloc()	Returns a new XrSceneSphereBoundMSFT instance allocated with memAlloc.
static XrSceneSphereBoundMSFT.Buffer	malloc(int capacity)	Returns a new XrSceneSphereBoundMSFT.Buffer instance allocated with memAlloc.
static XrSceneSphereBoundMSFT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneSphereBoundMSFT.Buffer instance allocated on the specified MemoryStack.
static XrSceneSphereBoundMSFT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneSphereBoundMSFT instance allocated on the specified MemoryStack.
static XrVector3f	ncenter(long struct)	Unsafe version of center().
static void	ncenter(long struct, XrVector3f value)	Unsafe version of center.
static float	nradius(long struct)	Unsafe version of radius().
static void	nradius(long struct, float value)	Unsafe version of radius.
float	radius()	the finite positive radius of the sphere bound.
XrSceneSphereBoundMSFT	radius(float value)	Sets the specified value to the radius() field.
XrSceneSphereBoundMSFT	set(XrSceneSphereBoundMSFT src)	Copies the specified struct data to this struct.
XrSceneSphereBoundMSFT	set(XrVector3f center, float radius)	Initializes this struct with the specified values.
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.

CENTER

public static final int CENTER

The struct member offsets.

RADIUS

public static final int RADIUS

The struct member offsets.

Constructor Details

XrSceneSphereBoundMSFT

public XrSceneSphereBoundMSFT(ByteBuffer container)

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

center

public XrVector3f center()

an XrVector3f representing the center of the sphere bound within the reference frame of the corresponding XrSceneBoundsMSFT::space.

radius

public float radius()

the finite positive radius of the sphere bound.

center

public XrSceneSphereBoundMSFT center(XrVector3f value)

Copies the specified XrVector3f to the center() field.

center

public XrSceneSphereBoundMSFT center(Consumer<XrVector3f> consumer)

Passes the center() field to the specified Consumer.

radius

public XrSceneSphereBoundMSFT radius(float value)

Sets the specified value to the radius() field.

set

public XrSceneSphereBoundMSFT set(XrVector3f center,
 float radius)

Initializes this struct with the specified values.

set

public XrSceneSphereBoundMSFT set(XrSceneSphereBoundMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSceneSphereBoundMSFT malloc()

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

calloc

public static XrSceneSphereBoundMSFT calloc()

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

create

public static XrSceneSphereBoundMSFT create()

Returns a new XrSceneSphereBoundMSFT instance allocated with BufferUtils.

create

public static XrSceneSphereBoundMSFT create(long address)

Returns a new XrSceneSphereBoundMSFT instance for the specified memory address.

createSafe

public static @Nullable XrSceneSphereBoundMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSceneSphereBoundMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSceneSphereBoundMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSceneSphereBoundMSFT.Buffer create(int capacity)

Returns a new XrSceneSphereBoundMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSceneSphereBoundMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSceneSphereBoundMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ncenter

public static XrVector3f ncenter(long struct)

Unsafe version of center().

nradius

public static float nradius(long struct)

Unsafe version of radius().

ncenter

public static void ncenter(long struct,
 XrVector3f value)

Unsafe version of center.

nradius

public static void nradius(long struct,
 float value)

Unsafe version of radius.