Package org.lwjgl.openxr

Class XrSceneComponentLocationsMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSceneComponentLocationsMSFT>

org.lwjgl.openxr.XrSceneComponentLocationsMSFT

All Implemented Interfaces:

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

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

Returns the scene component locations.

Valid Usage (Implicit)

• The XR_MSFT_scene_understanding extension must be enabled prior to using XrSceneComponentLocationsMSFT
• type must be TYPE_SCENE_COMPONENT_LOCATIONS_MSFT
• next must be NULL or a valid pointer to the next structure in a structure chain
• If locationCount is not 0, locations must be a pointer to an array of locationCount XrSceneComponentLocationMSFT structures

See Also

XrSceneComponentLocationMSFT, LocateSceneComponentsMSFT

Layout

 struct XrSceneComponentLocationsMSFT {
     XrStructureType type();
     void * next();
     uint32_t locationCount();
     XrSceneComponentLocationMSFT * locations();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrSceneComponentLocationsMSFT	calloc()	Returns a new XrSceneComponentLocationsMSFT instance allocated with memCalloc.
static XrSceneComponentLocationsMSFT.Buffer	calloc(int capacity)	Returns a new XrSceneComponentLocationsMSFT.Buffer instance allocated with memCalloc.
static XrSceneComponentLocationsMSFT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneComponentLocationsMSFT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSceneComponentLocationsMSFT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneComponentLocationsMSFT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSceneComponentLocationsMSFT	create()	Returns a new XrSceneComponentLocationsMSFT instance allocated with BufferUtils.
static XrSceneComponentLocationsMSFT.Buffer	create(int capacity)	Returns a new XrSceneComponentLocationsMSFT.Buffer instance allocated with BufferUtils.
static XrSceneComponentLocationsMSFT	create(long address)	Returns a new XrSceneComponentLocationsMSFT instance for the specified memory address.
static XrSceneComponentLocationsMSFT.Buffer	create(long address, int capacity)	Create a XrSceneComponentLocationsMSFT.Buffer instance at the specified memory.
static @Nullable XrSceneComponentLocationsMSFT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSceneComponentLocationsMSFT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	locationCount()	a uint32_t describing the count of elements in the locations array.
XrSceneComponentLocationsMSFT	locationCount(int value)	Sets the specified value to the locationCount() field.
@Nullable XrSceneComponentLocationMSFT.Buffer	locations()	an array of XrSceneComponentLocationMSFT scene component locations.
XrSceneComponentLocationsMSFT	locations(@Nullable XrSceneComponentLocationMSFT.Buffer value)	Sets the address of the specified XrSceneComponentLocationMSFT.Buffer to the locations() field.
static XrSceneComponentLocationsMSFT	malloc()	Returns a new XrSceneComponentLocationsMSFT instance allocated with memAlloc.
static XrSceneComponentLocationsMSFT.Buffer	malloc(int capacity)	Returns a new XrSceneComponentLocationsMSFT.Buffer instance allocated with memAlloc.
static XrSceneComponentLocationsMSFT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneComponentLocationsMSFT.Buffer instance allocated on the specified MemoryStack.
static XrSceneComponentLocationsMSFT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneComponentLocationsMSFT instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSceneComponentLocationsMSFT	next(long value)	Sets the specified value to the next() field.
static int	nlocationCount(long struct)	Unsafe version of locationCount().
static void	nlocationCount(long struct, int value)	Sets the specified value to the locationCount field of the specified struct.
static @Nullable XrSceneComponentLocationMSFT.Buffer	nlocations(long struct)	Unsafe version of locations().
static void	nlocations(long struct, @Nullable XrSceneComponentLocationMSFT.Buffer value)	Unsafe version of locations.
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.
XrSceneComponentLocationsMSFT	set(int type, long next, int locationCount, @Nullable XrSceneComponentLocationMSFT.Buffer locations)	Initializes this struct with the specified values.
XrSceneComponentLocationsMSFT	set(XrSceneComponentLocationsMSFT src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrSceneComponentLocationsMSFT	type(int value)	Sets the specified value to the type() field.
XrSceneComponentLocationsMSFT	type$Default()	Sets the TYPE_SCENE_COMPONENT_LOCATIONS_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.

LOCATIONCOUNT

public static final int LOCATIONCOUNT

The struct member offsets.

LOCATIONS

public static final int LOCATIONS

The struct member offsets.

Constructor Details

XrSceneComponentLocationsMSFT

public XrSceneComponentLocationsMSFT(ByteBuffer container)

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

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.

locationCount

public int locationCount()

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

locations

public @Nullable XrSceneComponentLocationMSFT.Buffer locations()

an array of XrSceneComponentLocationMSFT scene component locations.

type

public XrSceneComponentLocationsMSFT type(int value)

Sets the specified value to the type() field.

type$Default

public XrSceneComponentLocationsMSFT type$Default()

Sets the TYPE_SCENE_COMPONENT_LOCATIONS_MSFT value to the type() field.

next

public XrSceneComponentLocationsMSFT next(long value)

Sets the specified value to the next() field.

locationCount

public XrSceneComponentLocationsMSFT locationCount(int value)

Sets the specified value to the locationCount() field.

locations

public XrSceneComponentLocationsMSFT locations(@Nullable XrSceneComponentLocationMSFT.Buffer value)

Sets the address of the specified XrSceneComponentLocationMSFT.Buffer to the locations() field.

set

public XrSceneComponentLocationsMSFT set(int type,
 long next,
 int locationCount,
 @Nullable XrSceneComponentLocationMSFT.Buffer locations)

Initializes this struct with the specified values.

set

public XrSceneComponentLocationsMSFT set(XrSceneComponentLocationsMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSceneComponentLocationsMSFT malloc()

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

calloc

public static XrSceneComponentLocationsMSFT calloc()

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

create

public static XrSceneComponentLocationsMSFT create()

Returns a new XrSceneComponentLocationsMSFT instance allocated with BufferUtils.

create

public static XrSceneComponentLocationsMSFT create(long address)

Returns a new XrSceneComponentLocationsMSFT instance for the specified memory address.

createSafe

public static @Nullable XrSceneComponentLocationsMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSceneComponentLocationsMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSceneComponentLocationsMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSceneComponentLocationsMSFT.Buffer create(int capacity)

Returns a new XrSceneComponentLocationsMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSceneComponentLocationsMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSceneComponentLocationsMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nlocationCount

public static int nlocationCount(long struct)

Unsafe version of locationCount().

nlocations

public static @Nullable XrSceneComponentLocationMSFT.Buffer nlocations(long struct)

Unsafe version of locations().

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.

nlocationCount

public static void nlocationCount(long struct,
 int value)

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

nlocations

public static void nlocations(long struct,
 @Nullable XrSceneComponentLocationMSFT.Buffer value)

Unsafe version of locations.