Package org.lwjgl.openxr

Class XrSceneComponentsLocateInfoMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSceneComponentsLocateInfoMSFT>

org.lwjgl.openxr.XrSceneComponentsLocateInfoMSFT

All Implemented Interfaces:

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

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

Describes the information to locate scene components.

Valid Usage (Implicit)

• The XR_MSFT_scene_understanding extension must be enabled prior to using XrSceneComponentsLocateInfoMSFT
• type must be TYPE_SCENE_COMPONENTS_LOCATE_INFO_MSFT
• next must be NULL or a valid pointer to the next structure in a structure chain
• baseSpace must be a valid XrSpace handle
• If componentIdCount is not 0, componentIds must be a pointer to an array of componentIdCount XrUuidMSFT structures

See Also

XrUuidMSFT, LocateSceneComponentsMSFT

Layout

 struct XrSceneComponentsLocateInfoMSFT {
     XrStructureType type();
     void const * next();
     XrSpace baseSpace();
     XrTime time();
     uint32_t componentIdCount();
     XrUuidMSFT const * componentIds();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrSceneComponentsLocateInfoMSFT.Buffer	An array of XrSceneComponentsLocateInfoMSFT 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	BASESPACE	The struct member offsets.
static final int	COMPONENTIDCOUNT	The struct member offsets.
static final int	COMPONENTIDS	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TIME	The struct member offsets.
static final int	TYPE	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
XrSceneComponentsLocateInfoMSFT(ByteBuffer container)	Creates a XrSceneComponentsLocateInfoMSFT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
long	baseSpace()	an XrSpace within which the scene components will be located.
XrSceneComponentsLocateInfoMSFT	baseSpace(XrSpace value)	Sets the specified value to the baseSpace() field.
static XrSceneComponentsLocateInfoMSFT	calloc()	Returns a new XrSceneComponentsLocateInfoMSFT instance allocated with memCalloc.
static XrSceneComponentsLocateInfoMSFT.Buffer	calloc(int capacity)	Returns a new XrSceneComponentsLocateInfoMSFT.Buffer instance allocated with memCalloc.
static XrSceneComponentsLocateInfoMSFT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneComponentsLocateInfoMSFT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSceneComponentsLocateInfoMSFT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneComponentsLocateInfoMSFT instance allocated on the specified MemoryStack and initializes all its bits to zero.
int	componentIdCount()	a uint32_t describing the count of elements in the componentIds array.
XrSceneComponentsLocateInfoMSFT	componentIdCount(int value)	Sets the specified value to the componentIdCount() field.
@Nullable XrUuidMSFT.Buffer	componentIds()	an array of XrUuidMSFT identifiers for the scene components to location.
XrSceneComponentsLocateInfoMSFT	componentIds(@Nullable XrUuidMSFT.Buffer value)	Sets the address of the specified XrUuidMSFT.Buffer to the componentIds() field.
static XrSceneComponentsLocateInfoMSFT	create()	Returns a new XrSceneComponentsLocateInfoMSFT instance allocated with BufferUtils.
static XrSceneComponentsLocateInfoMSFT.Buffer	create(int capacity)	Returns a new XrSceneComponentsLocateInfoMSFT.Buffer instance allocated with BufferUtils.
static XrSceneComponentsLocateInfoMSFT	create(long address)	Returns a new XrSceneComponentsLocateInfoMSFT instance for the specified memory address.
static XrSceneComponentsLocateInfoMSFT.Buffer	create(long address, int capacity)	Create a XrSceneComponentsLocateInfoMSFT.Buffer instance at the specified memory.
static @Nullable XrSceneComponentsLocateInfoMSFT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSceneComponentsLocateInfoMSFT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrSceneComponentsLocateInfoMSFT	malloc()	Returns a new XrSceneComponentsLocateInfoMSFT instance allocated with memAlloc.
static XrSceneComponentsLocateInfoMSFT.Buffer	malloc(int capacity)	Returns a new XrSceneComponentsLocateInfoMSFT.Buffer instance allocated with memAlloc.
static XrSceneComponentsLocateInfoMSFT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneComponentsLocateInfoMSFT.Buffer instance allocated on the specified MemoryStack.
static XrSceneComponentsLocateInfoMSFT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneComponentsLocateInfoMSFT instance allocated on the specified MemoryStack.
static long	nbaseSpace(long struct)	Unsafe version of baseSpace().
static void	nbaseSpace(long struct, XrSpace value)	Unsafe version of baseSpace.
static int	ncomponentIdCount(long struct)	Unsafe version of componentIdCount().
static void	ncomponentIdCount(long struct, int value)	Sets the specified value to the componentIdCount field of the specified struct.
static @Nullable XrUuidMSFT.Buffer	ncomponentIds(long struct)	Unsafe version of componentIds().
static void	ncomponentIds(long struct, @Nullable XrUuidMSFT.Buffer value)	Unsafe version of componentIds.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSceneComponentsLocateInfoMSFT	next(long value)	Sets the specified value to the next() field.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static long	ntime(long struct)	Unsafe version of time().
static void	ntime(long struct, long value)	Unsafe version of time.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrSceneComponentsLocateInfoMSFT	set(int type, long next, XrSpace baseSpace, long time, int componentIdCount, @Nullable XrUuidMSFT.Buffer componentIds)	Initializes this struct with the specified values.
XrSceneComponentsLocateInfoMSFT	set(XrSceneComponentsLocateInfoMSFT src)	Copies the specified struct data to this struct.
int	sizeof()
long	time()	an XrTime at which to locate the scene components.
XrSceneComponentsLocateInfoMSFT	time(long value)	Sets the specified value to the time() field.
int	type()	the XrStructureType of this structure.
XrSceneComponentsLocateInfoMSFT	type(int value)	Sets the specified value to the type() field.
XrSceneComponentsLocateInfoMSFT	type$Default()	Sets the TYPE_SCENE_COMPONENTS_LOCATE_INFO_MSFT value to the type() 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.

TYPE

public static final int TYPE

The struct member offsets.

NEXT

public static final int NEXT

The struct member offsets.

BASESPACE

public static final int BASESPACE

The struct member offsets.

TIME

public static final int TIME

The struct member offsets.

COMPONENTIDCOUNT

public static final int COMPONENTIDCOUNT

The struct member offsets.

COMPONENTIDS

public static final int COMPONENTIDS

The struct member offsets.

Constructor Details

XrSceneComponentsLocateInfoMSFT

public XrSceneComponentsLocateInfoMSFT(ByteBuffer container)

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

type

public int type()

the XrStructureType of this structure.

next

public long next()

NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension.

baseSpace

public long baseSpace()

an XrSpace within which the scene components will be located.

time

public long time()

an XrTime at which to locate the scene components.

componentIdCount

public int componentIdCount()

a uint32_t describing the count of elements in the componentIds array.

componentIds

public @Nullable XrUuidMSFT.Buffer componentIds()

an array of XrUuidMSFT identifiers for the scene components to location.

type

public XrSceneComponentsLocateInfoMSFT type(int value)

Sets the specified value to the type() field.

type$Default

public XrSceneComponentsLocateInfoMSFT type$Default()

Sets the TYPE_SCENE_COMPONENTS_LOCATE_INFO_MSFT value to the type() field.

next

public XrSceneComponentsLocateInfoMSFT next(long value)

Sets the specified value to the next() field.

baseSpace

public XrSceneComponentsLocateInfoMSFT baseSpace(XrSpace value)

Sets the specified value to the baseSpace() field.

time

public XrSceneComponentsLocateInfoMSFT time(long value)

Sets the specified value to the time() field.

componentIdCount

public XrSceneComponentsLocateInfoMSFT componentIdCount(int value)

Sets the specified value to the componentIdCount() field.

componentIds

public XrSceneComponentsLocateInfoMSFT componentIds(@Nullable XrUuidMSFT.Buffer value)

Sets the address of the specified XrUuidMSFT.Buffer to the componentIds() field.

set

public XrSceneComponentsLocateInfoMSFT set(int type,
 long next,
 XrSpace baseSpace,
 long time,
 int componentIdCount,
 @Nullable XrUuidMSFT.Buffer componentIds)

Initializes this struct with the specified values.

set

public XrSceneComponentsLocateInfoMSFT set(XrSceneComponentsLocateInfoMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSceneComponentsLocateInfoMSFT malloc()

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

calloc

public static XrSceneComponentsLocateInfoMSFT calloc()

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

create

public static XrSceneComponentsLocateInfoMSFT create()

Returns a new XrSceneComponentsLocateInfoMSFT instance allocated with BufferUtils.

create

public static XrSceneComponentsLocateInfoMSFT create(long address)

Returns a new XrSceneComponentsLocateInfoMSFT instance for the specified memory address.

createSafe

public static @Nullable XrSceneComponentsLocateInfoMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSceneComponentsLocateInfoMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSceneComponentsLocateInfoMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSceneComponentsLocateInfoMSFT.Buffer create(int capacity)

Returns a new XrSceneComponentsLocateInfoMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSceneComponentsLocateInfoMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSceneComponentsLocateInfoMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ntype

public static int ntype(long struct)

Unsafe version of type().

nnext

public static long nnext(long struct)

Unsafe version of next().

nbaseSpace

public static long nbaseSpace(long struct)

Unsafe version of baseSpace().

ntime

public static long ntime(long struct)

Unsafe version of time().

ncomponentIdCount

public static int ncomponentIdCount(long struct)

Unsafe version of componentIdCount().

ncomponentIds

public static @Nullable XrUuidMSFT.Buffer ncomponentIds(long struct)

Unsafe version of componentIds().

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

nnext

public static void nnext(long struct,
 long value)

Unsafe version of next.

nbaseSpace

public static void nbaseSpace(long struct,
 XrSpace value)

Unsafe version of baseSpace.

ntime

public static void ntime(long struct,
 long value)

Unsafe version of time.

ncomponentIdCount

public static void ncomponentIdCount(long struct,
 int value)

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

ncomponentIds

public static void ncomponentIds(long struct,
 @Nullable XrUuidMSFT.Buffer value)

Unsafe version of componentIds.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate