Package org.lwjgl.openxr

Class XrSceneComponentsMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSceneComponentsMSFT>

org.lwjgl.openxr.XrSceneComponentsMSFT

All Implemented Interfaces:

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

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

Scene components.

Valid Usage (Implicit)

• The XR_MSFT_scene_understanding extension must be enabled prior to using XrSceneComponentsMSFT
• type must be TYPE_SCENE_COMPONENTS_MSFT
• next must be NULL or a valid pointer to the next structure in a structure chain. See also: XrSceneMarkerQRCodesMSFT, XrSceneMarkersMSFT, XrSceneMeshesMSFT, XrSceneObjectsMSFT, XrScenePlanesMSFT
• If componentCapacityInput is not 0, components must be a pointer to an array of componentCapacityInput XrSceneComponentMSFT structures

See Also

XrSceneComponentMSFT, GetSceneComponentsMSFT

Layout

 struct XrSceneComponentsMSFT {
     XrStructureType type();
     void * next();
     uint32_t componentCapacityInput();
     uint32_t componentCountOutput();
     XrSceneComponentMSFT * components();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrSceneComponentsMSFT	calloc()	Returns a new XrSceneComponentsMSFT instance allocated with memCalloc.
static XrSceneComponentsMSFT.Buffer	calloc(int capacity)	Returns a new XrSceneComponentsMSFT.Buffer instance allocated with memCalloc.
static XrSceneComponentsMSFT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneComponentsMSFT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSceneComponentsMSFT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneComponentsMSFT instance allocated on the specified MemoryStack and initializes all its bits to zero.
int	componentCapacityInput()	the capacity of the array, or 0 to indicate a request to retrieve the required capacity.
XrSceneComponentsMSFT	componentCapacityInput(int value)	Sets the specified value to the componentCapacityInput() field.
int	componentCountOutput()	a pointer to the count of components, or a pointer to the required capacity in the case that componentCapacityInput is insufficient.
XrSceneComponentsMSFT	componentCountOutput(int value)	Sets the specified value to the componentCountOutput() field.
@Nullable XrSceneComponentMSFT.Buffer	components()	an array of XrSceneComponentMSFT.
XrSceneComponentsMSFT	components(@Nullable XrSceneComponentMSFT.Buffer value)	Sets the address of the specified XrSceneComponentMSFT.Buffer to the components() field.
static XrSceneComponentsMSFT	create()	Returns a new XrSceneComponentsMSFT instance allocated with BufferUtils.
static XrSceneComponentsMSFT.Buffer	create(int capacity)	Returns a new XrSceneComponentsMSFT.Buffer instance allocated with BufferUtils.
static XrSceneComponentsMSFT	create(long address)	Returns a new XrSceneComponentsMSFT instance for the specified memory address.
static XrSceneComponentsMSFT.Buffer	create(long address, int capacity)	Create a XrSceneComponentsMSFT.Buffer instance at the specified memory.
static @Nullable XrSceneComponentsMSFT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSceneComponentsMSFT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrSceneComponentsMSFT	malloc()	Returns a new XrSceneComponentsMSFT instance allocated with memAlloc.
static XrSceneComponentsMSFT.Buffer	malloc(int capacity)	Returns a new XrSceneComponentsMSFT.Buffer instance allocated with memAlloc.
static XrSceneComponentsMSFT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneComponentsMSFT.Buffer instance allocated on the specified MemoryStack.
static XrSceneComponentsMSFT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneComponentsMSFT instance allocated on the specified MemoryStack.
static int	ncomponentCapacityInput(long struct)	Unsafe version of componentCapacityInput().
static void	ncomponentCapacityInput(long struct, int value)	Sets the specified value to the componentCapacityInput field of the specified struct.
static int	ncomponentCountOutput(long struct)	Unsafe version of componentCountOutput().
static void	ncomponentCountOutput(long struct, int value)	Unsafe version of componentCountOutput.
static @Nullable XrSceneComponentMSFT.Buffer	ncomponents(long struct)	Unsafe version of components().
static void	ncomponents(long struct, @Nullable XrSceneComponentMSFT.Buffer value)	Unsafe version of components.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSceneComponentsMSFT	next(long value)	Sets the specified value to the next() field.
XrSceneComponentsMSFT	next(XrSceneMarkerQRCodesMSFT value)	Prepends the specified XrSceneMarkerQRCodesMSFT value to the next chain.
XrSceneComponentsMSFT	next(XrSceneMarkersMSFT value)	Prepends the specified XrSceneMarkersMSFT value to the next chain.
XrSceneComponentsMSFT	next(XrSceneMeshesMSFT value)	Prepends the specified XrSceneMeshesMSFT value to the next chain.
XrSceneComponentsMSFT	next(XrSceneObjectsMSFT value)	Prepends the specified XrSceneObjectsMSFT value to the next chain.
XrSceneComponentsMSFT	next(XrScenePlanesMSFT value)	Prepends the specified XrScenePlanesMSFT value to the next chain.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrSceneComponentsMSFT	set(int type, long next, int componentCapacityInput, int componentCountOutput, @Nullable XrSceneComponentMSFT.Buffer components)	Initializes this struct with the specified values.
XrSceneComponentsMSFT	set(XrSceneComponentsMSFT src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrSceneComponentsMSFT	type(int value)	Sets the specified value to the type() field.
XrSceneComponentsMSFT	type$Default()	Sets the TYPE_SCENE_COMPONENTS_MSFT value to the type() field.

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.

COMPONENTCAPACITYINPUT

public static final int COMPONENTCAPACITYINPUT

The struct member offsets.

COMPONENTCOUNTOUTPUT

public static final int COMPONENTCOUNTOUTPUT

The struct member offsets.

COMPONENTS

public static final int COMPONENTS

The struct member offsets.

Constructor Details

XrSceneComponentsMSFT

public XrSceneComponentsMSFT(ByteBuffer container)

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

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.

componentCapacityInput

public int componentCapacityInput()

the capacity of the array, or 0 to indicate a request to retrieve the required capacity.

componentCountOutput

public int componentCountOutput()

a pointer to the count of components, or a pointer to the required capacity in the case that componentCapacityInput is insufficient.

components

public @Nullable XrSceneComponentMSFT.Buffer components()

an array of XrSceneComponentMSFT.

type

public XrSceneComponentsMSFT type(int value)

Sets the specified value to the type() field.

type$Default

public XrSceneComponentsMSFT type$Default()

Sets the TYPE_SCENE_COMPONENTS_MSFT value to the type() field.

next

public XrSceneComponentsMSFT next(long value)

Sets the specified value to the next() field.

next

public XrSceneComponentsMSFT next(XrSceneMarkerQRCodesMSFT value)

Prepends the specified XrSceneMarkerQRCodesMSFT value to the next chain.

next

public XrSceneComponentsMSFT next(XrSceneMarkersMSFT value)

Prepends the specified XrSceneMarkersMSFT value to the next chain.

next

public XrSceneComponentsMSFT next(XrSceneMeshesMSFT value)

Prepends the specified XrSceneMeshesMSFT value to the next chain.

next

public XrSceneComponentsMSFT next(XrSceneObjectsMSFT value)

Prepends the specified XrSceneObjectsMSFT value to the next chain.

next

public XrSceneComponentsMSFT next(XrScenePlanesMSFT value)

Prepends the specified XrScenePlanesMSFT value to the next chain.

componentCapacityInput

public XrSceneComponentsMSFT componentCapacityInput(int value)

Sets the specified value to the componentCapacityInput() field.

componentCountOutput

public XrSceneComponentsMSFT componentCountOutput(int value)

Sets the specified value to the componentCountOutput() field.

components

public XrSceneComponentsMSFT components(@Nullable XrSceneComponentMSFT.Buffer value)

Sets the address of the specified XrSceneComponentMSFT.Buffer to the components() field.

set

public XrSceneComponentsMSFT set(int type,
 long next,
 int componentCapacityInput,
 int componentCountOutput,
 @Nullable XrSceneComponentMSFT.Buffer components)

Initializes this struct with the specified values.

set

public XrSceneComponentsMSFT set(XrSceneComponentsMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSceneComponentsMSFT malloc()

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

calloc

public static XrSceneComponentsMSFT calloc()

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

create

public static XrSceneComponentsMSFT create()

Returns a new XrSceneComponentsMSFT instance allocated with BufferUtils.

create

public static XrSceneComponentsMSFT create(long address)

Returns a new XrSceneComponentsMSFT instance for the specified memory address.

createSafe

public static @Nullable XrSceneComponentsMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSceneComponentsMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSceneComponentsMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSceneComponentsMSFT.Buffer create(int capacity)

Returns a new XrSceneComponentsMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSceneComponentsMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSceneComponentsMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ncomponentCapacityInput

public static int ncomponentCapacityInput(long struct)

Unsafe version of componentCapacityInput().

ncomponentCountOutput

public static int ncomponentCountOutput(long struct)

Unsafe version of componentCountOutput().

ncomponents

public static @Nullable XrSceneComponentMSFT.Buffer ncomponents(long struct)

Unsafe version of components().

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.

ncomponentCapacityInput

public static void ncomponentCapacityInput(long struct,
 int value)

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

ncomponentCountOutput

public static void ncomponentCountOutput(long struct,
 int value)

Unsafe version of componentCountOutput.

ncomponents

public static void ncomponents(long struct,
 @Nullable XrSceneComponentMSFT.Buffer value)

Unsafe version of components.