Package org.lwjgl.openxr

Class XrSceneFrustumBoundMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSceneFrustumBoundMSFT>

org.lwjgl.openxr.XrSceneFrustumBoundMSFT

All Implemented Interfaces:

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

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

Describe a scene frustum bounds.

Description

The runtime must return ERROR_VALIDATION_FAILURE if farDistance is less than or equal to zero. The runtime must return ERROR_VALIDATION_FAILURE if the fov angles are not between between -π/2 and π/2 exclusively.

Valid Usage (Implicit)

• The XR_MSFT_scene_understanding extension must be enabled prior to using XrSceneFrustumBoundMSFT

See Also

XrFovf, XrPosef, XrSceneBoundsMSFT

Layout

 struct XrSceneFrustumBoundMSFT {
     XrPosef pose();
     XrFovf fov();
     float farDistance();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrSceneFrustumBoundMSFT	calloc()	Returns a new XrSceneFrustumBoundMSFT instance allocated with memCalloc.
static XrSceneFrustumBoundMSFT.Buffer	calloc(int capacity)	Returns a new XrSceneFrustumBoundMSFT.Buffer instance allocated with memCalloc.
static XrSceneFrustumBoundMSFT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneFrustumBoundMSFT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSceneFrustumBoundMSFT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneFrustumBoundMSFT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSceneFrustumBoundMSFT	create()	Returns a new XrSceneFrustumBoundMSFT instance allocated with BufferUtils.
static XrSceneFrustumBoundMSFT.Buffer	create(int capacity)	Returns a new XrSceneFrustumBoundMSFT.Buffer instance allocated with BufferUtils.
static XrSceneFrustumBoundMSFT	create(long address)	Returns a new XrSceneFrustumBoundMSFT instance for the specified memory address.
static XrSceneFrustumBoundMSFT.Buffer	create(long address, int capacity)	Create a XrSceneFrustumBoundMSFT.Buffer instance at the specified memory.
static @Nullable XrSceneFrustumBoundMSFT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSceneFrustumBoundMSFT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
float	farDistance()	the positive distance of the far plane of the frustum bound along the -Z direction of the frustum bound space.
XrSceneFrustumBoundMSFT	farDistance(float value)	Sets the specified value to the farDistance() field.
XrFovf	fov()	an XrFovf for the four sides of the frustum bound where XrFovf::angleLeft and XrFovf::angleRight are along the X axis and XrFovf::angleUp and XrFovf::angleDown are along the Y axis of the frustum bound space.
XrSceneFrustumBoundMSFT	fov(Consumer<XrFovf> consumer)	Passes the fov() field to the specified Consumer.
XrSceneFrustumBoundMSFT	fov(XrFovf value)	Copies the specified XrFovf to the fov() field.
static XrSceneFrustumBoundMSFT	malloc()	Returns a new XrSceneFrustumBoundMSFT instance allocated with memAlloc.
static XrSceneFrustumBoundMSFT.Buffer	malloc(int capacity)	Returns a new XrSceneFrustumBoundMSFT.Buffer instance allocated with memAlloc.
static XrSceneFrustumBoundMSFT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneFrustumBoundMSFT.Buffer instance allocated on the specified MemoryStack.
static XrSceneFrustumBoundMSFT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneFrustumBoundMSFT instance allocated on the specified MemoryStack.
static float	nfarDistance(long struct)	Unsafe version of farDistance().
static void	nfarDistance(long struct, float value)	Unsafe version of farDistance.
static XrFovf	nfov(long struct)	Unsafe version of fov().
static void	nfov(long struct, XrFovf value)	Unsafe version of fov.
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 tip of the frustum bound within the reference frame of the corresponding XrSceneBoundsMSFT::space.
XrSceneFrustumBoundMSFT	pose(Consumer<XrPosef> consumer)	Passes the pose() field to the specified Consumer.
XrSceneFrustumBoundMSFT	pose(XrPosef value)	Copies the specified XrPosef to the pose() field.
XrSceneFrustumBoundMSFT	set(XrPosef pose, XrFovf fov, float farDistance)	Initializes this struct with the specified values.
XrSceneFrustumBoundMSFT	set(XrSceneFrustumBoundMSFT 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.

FOV

public static final int FOV

The struct member offsets.

FARDISTANCE

public static final int FARDISTANCE

The struct member offsets.

Constructor Details

XrSceneFrustumBoundMSFT

public XrSceneFrustumBoundMSFT(ByteBuffer container)

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

pose

public XrPosef pose()

an XrPosef defining the position and orientation of the tip of the frustum bound within the reference frame of the corresponding XrSceneBoundsMSFT::space.

fov

public XrFovf fov()

an XrFovf for the four sides of the frustum bound where XrFovf::angleLeft and XrFovf::angleRight are along the X axis and XrFovf::angleUp and XrFovf::angleDown are along the Y axis of the frustum bound space.

farDistance

public float farDistance()

the positive distance of the far plane of the frustum bound along the -Z direction of the frustum bound space.

pose

public XrSceneFrustumBoundMSFT pose(XrPosef value)

Copies the specified XrPosef to the pose() field.

pose

public XrSceneFrustumBoundMSFT pose(Consumer<XrPosef> consumer)

Passes the pose() field to the specified Consumer.

fov

public XrSceneFrustumBoundMSFT fov(XrFovf value)

Copies the specified XrFovf to the fov() field.

fov

public XrSceneFrustumBoundMSFT fov(Consumer<XrFovf> consumer)

Passes the fov() field to the specified Consumer.

farDistance

public XrSceneFrustumBoundMSFT farDistance(float value)

Sets the specified value to the farDistance() field.

set

public XrSceneFrustumBoundMSFT set(XrPosef pose,
 XrFovf fov,
 float farDistance)

Initializes this struct with the specified values.

set

public XrSceneFrustumBoundMSFT set(XrSceneFrustumBoundMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSceneFrustumBoundMSFT malloc()

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

calloc

public static XrSceneFrustumBoundMSFT calloc()

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

create

public static XrSceneFrustumBoundMSFT create()

Returns a new XrSceneFrustumBoundMSFT instance allocated with BufferUtils.

create

public static XrSceneFrustumBoundMSFT create(long address)

Returns a new XrSceneFrustumBoundMSFT instance for the specified memory address.

createSafe

public static @Nullable XrSceneFrustumBoundMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSceneFrustumBoundMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSceneFrustumBoundMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSceneFrustumBoundMSFT.Buffer create(int capacity)

Returns a new XrSceneFrustumBoundMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSceneFrustumBoundMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSceneFrustumBoundMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nfov

public static XrFovf nfov(long struct)

Unsafe version of fov().

nfarDistance

public static float nfarDistance(long struct)

Unsafe version of farDistance().

npose

public static void npose(long struct,
 XrPosef value)

Unsafe version of pose.

nfov

public static void nfov(long struct,
 XrFovf value)

Unsafe version of fov.

nfarDistance

public static void nfarDistance(long struct,
 float value)

Unsafe version of farDistance.