Package org.lwjgl.openxr

Class XrSceneBoundsMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSceneBoundsMSFT>

org.lwjgl.openxr.XrSceneBoundsMSFT

All Implemented Interfaces:

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

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

The scene bounds.

Valid Usage (Implicit)

• The XR_MSFT_scene_understanding extension must be enabled prior to using XrSceneBoundsMSFT
• space must be a valid XrSpace handle
• If sphereCount is not 0, spheres must be a pointer to an array of sphereCount XrSceneSphereBoundMSFT structures
• If boxCount is not 0, boxes must be a pointer to an array of boxCount XrSceneOrientedBoxBoundMSFT structures
• If frustumCount is not 0, frustums must be a pointer to an array of frustumCount XrSceneFrustumBoundMSFT structures

See Also

XrNewSceneComputeInfoMSFT, XrSceneFrustumBoundMSFT, XrSceneOrientedBoxBoundMSFT, XrSceneSphereBoundMSFT, ComputeNewSceneMSFT

Layout

 struct XrSceneBoundsMSFT {
     XrSpace space();
     XrTime time();
     uint32_t sphereCount();
     XrSceneSphereBoundMSFT const * spheres();
     uint32_t boxCount();
     XrSceneOrientedBoxBoundMSFT const * boxes();
     uint32_t frustumCount();
     XrSceneFrustumBoundMSFT const * frustums();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrSceneBoundsMSFT.Buffer	An array of XrSceneBoundsMSFT 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	BOXCOUNT	The struct member offsets.
static final int	BOXES	The struct member offsets.
static final int	FRUSTUMCOUNT	The struct member offsets.
static final int	FRUSTUMS	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SPACE	The struct member offsets.
static final int	SPHERECOUNT	The struct member offsets.
static final int	SPHERES	The struct member offsets.
static final int	TIME	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
XrSceneBoundsMSFT(ByteBuffer container)	Creates a XrSceneBoundsMSFT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
int	boxCount()	the number of oriented box bounds.
XrSceneBoundsMSFT	boxCount(int value)	Sets the specified value to the boxCount() field.
@Nullable XrSceneOrientedBoxBoundMSFT.Buffer	boxes()	an array of XrSceneOrientedBoxBoundMSFT.
XrSceneBoundsMSFT	boxes(@Nullable XrSceneOrientedBoxBoundMSFT.Buffer value)	Sets the address of the specified XrSceneOrientedBoxBoundMSFT.Buffer to the boxes() field.
static XrSceneBoundsMSFT	calloc()	Returns a new XrSceneBoundsMSFT instance allocated with memCalloc.
static XrSceneBoundsMSFT.Buffer	calloc(int capacity)	Returns a new XrSceneBoundsMSFT.Buffer instance allocated with memCalloc.
static XrSceneBoundsMSFT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneBoundsMSFT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSceneBoundsMSFT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneBoundsMSFT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSceneBoundsMSFT	create()	Returns a new XrSceneBoundsMSFT instance allocated with BufferUtils.
static XrSceneBoundsMSFT.Buffer	create(int capacity)	Returns a new XrSceneBoundsMSFT.Buffer instance allocated with BufferUtils.
static XrSceneBoundsMSFT	create(long address)	Returns a new XrSceneBoundsMSFT instance for the specified memory address.
static XrSceneBoundsMSFT.Buffer	create(long address, int capacity)	Create a XrSceneBoundsMSFT.Buffer instance at the specified memory.
static @Nullable XrSceneBoundsMSFT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSceneBoundsMSFT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	frustumCount()	the number of frustum bounds.
XrSceneBoundsMSFT	frustumCount(int value)	Sets the specified value to the frustumCount() field.
@Nullable XrSceneFrustumBoundMSFT.Buffer	frustums()	an array of XrSceneFrustumBoundMSFT.
XrSceneBoundsMSFT	frustums(@Nullable XrSceneFrustumBoundMSFT.Buffer value)	Sets the address of the specified XrSceneFrustumBoundMSFT.Buffer to the frustums() field.
static XrSceneBoundsMSFT	malloc()	Returns a new XrSceneBoundsMSFT instance allocated with memAlloc.
static XrSceneBoundsMSFT.Buffer	malloc(int capacity)	Returns a new XrSceneBoundsMSFT.Buffer instance allocated with memAlloc.
static XrSceneBoundsMSFT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneBoundsMSFT.Buffer instance allocated on the specified MemoryStack.
static XrSceneBoundsMSFT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneBoundsMSFT instance allocated on the specified MemoryStack.
static int	nboxCount(long struct)	Unsafe version of boxCount().
static void	nboxCount(long struct, int value)	Sets the specified value to the boxCount field of the specified struct.
static @Nullable XrSceneOrientedBoxBoundMSFT.Buffer	nboxes(long struct)	Unsafe version of boxes().
static void	nboxes(long struct, @Nullable XrSceneOrientedBoxBoundMSFT.Buffer value)	Unsafe version of boxes.
static int	nfrustumCount(long struct)	Unsafe version of frustumCount().
static void	nfrustumCount(long struct, int value)	Sets the specified value to the frustumCount field of the specified struct.
static @Nullable XrSceneFrustumBoundMSFT.Buffer	nfrustums(long struct)	Unsafe version of frustums().
static void	nfrustums(long struct, @Nullable XrSceneFrustumBoundMSFT.Buffer value)	Unsafe version of frustums.
static long	nspace(long struct)	Unsafe version of space().
static void	nspace(long struct, XrSpace value)	Unsafe version of space.
static int	nsphereCount(long struct)	Unsafe version of sphereCount().
static void	nsphereCount(long struct, int value)	Sets the specified value to the sphereCount field of the specified struct.
static @Nullable XrSceneSphereBoundMSFT.Buffer	nspheres(long struct)	Unsafe version of spheres().
static void	nspheres(long struct, @Nullable XrSceneSphereBoundMSFT.Buffer value)	Unsafe version of spheres.
static long	ntime(long struct)	Unsafe version of time().
static void	ntime(long struct, long value)	Unsafe version of time.
XrSceneBoundsMSFT	set(XrSceneBoundsMSFT src)	Copies the specified struct data to this struct.
XrSceneBoundsMSFT	set(XrSpace space, long time, int sphereCount, @Nullable XrSceneSphereBoundMSFT.Buffer spheres, int boxCount, @Nullable XrSceneOrientedBoxBoundMSFT.Buffer boxes, int frustumCount, @Nullable XrSceneFrustumBoundMSFT.Buffer frustums)	Initializes this struct with the specified values.
int	sizeof()
long	space()	a handle to the XrSpace in which the bounds are specified.
XrSceneBoundsMSFT	space(XrSpace value)	Sets the specified value to the space() field.
int	sphereCount()	the number of sphere bounds.
XrSceneBoundsMSFT	sphereCount(int value)	Sets the specified value to the sphereCount() field.
@Nullable XrSceneSphereBoundMSFT.Buffer	spheres()	an array of XrSceneSphereBoundMSFT.
XrSceneBoundsMSFT	spheres(@Nullable XrSceneSphereBoundMSFT.Buffer value)	Sets the address of the specified XrSceneSphereBoundMSFT.Buffer to the spheres() field.
long	time()	the XrTime at which the bounds will be evaluated within space.
XrSceneBoundsMSFT	time(long value)	Sets the specified value to the time() 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.

SPACE

public static final int SPACE

The struct member offsets.

TIME

public static final int TIME

The struct member offsets.

SPHERECOUNT

public static final int SPHERECOUNT

The struct member offsets.

SPHERES

public static final int SPHERES

The struct member offsets.

BOXCOUNT

public static final int BOXCOUNT

The struct member offsets.

BOXES

public static final int BOXES

The struct member offsets.

FRUSTUMCOUNT

public static final int FRUSTUMCOUNT

The struct member offsets.

FRUSTUMS

public static final int FRUSTUMS

The struct member offsets.

Constructor Details

XrSceneBoundsMSFT

public XrSceneBoundsMSFT(ByteBuffer container)

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

space

public long space()

a handle to the XrSpace in which the bounds are specified.

time

public long time()

the XrTime at which the bounds will be evaluated within space.

sphereCount

public int sphereCount()

the number of sphere bounds.

spheres

public @Nullable XrSceneSphereBoundMSFT.Buffer spheres()

an array of XrSceneSphereBoundMSFT.

boxCount

public int boxCount()

the number of oriented box bounds.

boxes

public @Nullable XrSceneOrientedBoxBoundMSFT.Buffer boxes()

an array of XrSceneOrientedBoxBoundMSFT.

frustumCount

public int frustumCount()

the number of frustum bounds.

frustums

public @Nullable XrSceneFrustumBoundMSFT.Buffer frustums()

an array of XrSceneFrustumBoundMSFT.

space

public XrSceneBoundsMSFT space(XrSpace value)

Sets the specified value to the space() field.

time

public XrSceneBoundsMSFT time(long value)

Sets the specified value to the time() field.

sphereCount

public XrSceneBoundsMSFT sphereCount(int value)

Sets the specified value to the sphereCount() field.

spheres

public XrSceneBoundsMSFT spheres(@Nullable XrSceneSphereBoundMSFT.Buffer value)

Sets the address of the specified XrSceneSphereBoundMSFT.Buffer to the spheres() field.

boxCount

public XrSceneBoundsMSFT boxCount(int value)

Sets the specified value to the boxCount() field.

boxes

public XrSceneBoundsMSFT boxes(@Nullable XrSceneOrientedBoxBoundMSFT.Buffer value)

Sets the address of the specified XrSceneOrientedBoxBoundMSFT.Buffer to the boxes() field.

frustumCount

public XrSceneBoundsMSFT frustumCount(int value)

Sets the specified value to the frustumCount() field.

frustums

public XrSceneBoundsMSFT frustums(@Nullable XrSceneFrustumBoundMSFT.Buffer value)

Sets the address of the specified XrSceneFrustumBoundMSFT.Buffer to the frustums() field.

set

public XrSceneBoundsMSFT set(XrSpace space,
 long time,
 int sphereCount,
 @Nullable XrSceneSphereBoundMSFT.Buffer spheres,
 int boxCount,
 @Nullable XrSceneOrientedBoxBoundMSFT.Buffer boxes,
 int frustumCount,
 @Nullable XrSceneFrustumBoundMSFT.Buffer frustums)

Initializes this struct with the specified values.

set

public XrSceneBoundsMSFT set(XrSceneBoundsMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSceneBoundsMSFT malloc()

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

calloc

public static XrSceneBoundsMSFT calloc()

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

create

public static XrSceneBoundsMSFT create()

Returns a new XrSceneBoundsMSFT instance allocated with BufferUtils.

create

public static XrSceneBoundsMSFT create(long address)

Returns a new XrSceneBoundsMSFT instance for the specified memory address.

createSafe

public static @Nullable XrSceneBoundsMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSceneBoundsMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSceneBoundsMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSceneBoundsMSFT.Buffer create(int capacity)

Returns a new XrSceneBoundsMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSceneBoundsMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSceneBoundsMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nspace

public static long nspace(long struct)

Unsafe version of space().

ntime

public static long ntime(long struct)

Unsafe version of time().

nsphereCount

public static int nsphereCount(long struct)

Unsafe version of sphereCount().

nspheres

public static @Nullable XrSceneSphereBoundMSFT.Buffer nspheres(long struct)

Unsafe version of spheres().

nboxCount

public static int nboxCount(long struct)

Unsafe version of boxCount().

nboxes

public static @Nullable XrSceneOrientedBoxBoundMSFT.Buffer nboxes(long struct)

Unsafe version of boxes().

nfrustumCount

public static int nfrustumCount(long struct)

Unsafe version of frustumCount().

nfrustums

public static @Nullable XrSceneFrustumBoundMSFT.Buffer nfrustums(long struct)

Unsafe version of frustums().

nspace

public static void nspace(long struct,
 XrSpace value)

Unsafe version of space.

ntime

public static void ntime(long struct,
 long value)

Unsafe version of time.

nsphereCount

public static void nsphereCount(long struct,
 int value)

Sets the specified value to the sphereCount field of the specified struct.

nspheres

public static void nspheres(long struct,
 @Nullable XrSceneSphereBoundMSFT.Buffer value)

Unsafe version of spheres.

nboxCount

public static void nboxCount(long struct,
 int value)

Sets the specified value to the boxCount field of the specified struct.

nboxes

public static void nboxes(long struct,
 @Nullable XrSceneOrientedBoxBoundMSFT.Buffer value)

Unsafe version of boxes.

nfrustumCount

public static void nfrustumCount(long struct,
 int value)

Sets the specified value to the frustumCount field of the specified struct.

nfrustums

public static void nfrustums(long struct,
 @Nullable XrSceneFrustumBoundMSFT.Buffer value)

Unsafe version of frustums.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate