Package org.lwjgl.openxr

Class XrEventDataLocalizationChangedML

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrEventDataLocalizationChangedML>

org.lwjgl.openxr.XrEventDataLocalizationChangedML

All Implemented Interfaces:

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

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

Event containing the current localization map state.

Description

By default the runtime does not send these events but calling EnableLocalizationEventsML function enables the events. When this function is called the XrEventDataLocalizationChangedML event will always be posted to the event queue, regardless of whether the map localization state has changed. This allows the application to synchronize with the current state.

Note

The arrival of the event is asynchronous to this call.

Valid Usage (Implicit)

• The XR_ML_localization_map extension must be enabled prior to using XrEventDataLocalizationChangedML
• type must be TYPE_EVENT_DATA_LOCALIZATION_CHANGED_ML
• next must be NULL or a valid pointer to the next structure in a structure chain

See Also

XrLocalizationMapML, EnableLocalizationEventsML

Layout

 struct XrEventDataLocalizationChangedML {
     XrStructureType type();
     void const * next();
     XrSession session();
     XrLocalizationMapStateML state();
     XrLocalizationMapML map();
     XrLocalizationMapConfidenceML confidence();
     XrLocalizationMapErrorFlagsML errorFlags();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrEventDataLocalizationChangedML	calloc()	Returns a new XrEventDataLocalizationChangedML instance allocated with memCalloc.
static XrEventDataLocalizationChangedML.Buffer	calloc(int capacity)	Returns a new XrEventDataLocalizationChangedML.Buffer instance allocated with memCalloc.
static XrEventDataLocalizationChangedML.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataLocalizationChangedML.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrEventDataLocalizationChangedML	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataLocalizationChangedML instance allocated on the specified MemoryStack and initializes all its bits to zero.
int	confidence()	the XrLocalizationMapConfidenceML of the current map.
static XrEventDataLocalizationChangedML	create()	Returns a new XrEventDataLocalizationChangedML instance allocated with BufferUtils.
static XrEventDataLocalizationChangedML.Buffer	create(int capacity)	Returns a new XrEventDataLocalizationChangedML.Buffer instance allocated with BufferUtils.
static XrEventDataLocalizationChangedML	create(long address)	Returns a new XrEventDataLocalizationChangedML instance for the specified memory address.
static XrEventDataLocalizationChangedML.Buffer	create(long address, int capacity)	Create a XrEventDataLocalizationChangedML.Buffer instance at the specified memory.
static XrEventDataLocalizationChangedML	create(XrEventDataBaseHeader value)	Downcasts the specified XrEventDataBaseHeader instance to XrEventDataLocalizationChangedML.
static XrEventDataLocalizationChangedML.Buffer	create(XrEventDataBaseHeader.Buffer value)	Downcasts the specified XrEventDataBaseHeader.Buffer instance to XrEventDataLocalizationChangedML.Buffer.
static @Nullable XrEventDataLocalizationChangedML	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrEventDataLocalizationChangedML.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	errorFlags()	a a bitwise-OR of zero or more of the bits defined in XrLocalizationMapErrorFlagBitsML in the case that the localization map has low confidence.
static XrEventDataLocalizationChangedML	malloc()	Returns a new XrEventDataLocalizationChangedML instance allocated with memAlloc.
static XrEventDataLocalizationChangedML.Buffer	malloc(int capacity)	Returns a new XrEventDataLocalizationChangedML.Buffer instance allocated with memAlloc.
static XrEventDataLocalizationChangedML.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataLocalizationChangedML.Buffer instance allocated on the specified MemoryStack.
static XrEventDataLocalizationChangedML	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataLocalizationChangedML instance allocated on the specified MemoryStack.
XrLocalizationMapML	map()	the XrLocalizationMapML of the current map.
static int	nconfidence(long struct)	Unsafe version of confidence().
static long	nerrorFlags(long struct)	Unsafe version of errorFlags().
long	next()	NULL or a pointer to the next structure in a structure chain.
XrEventDataLocalizationChangedML	next(long value)	Sets the specified value to the next() field.
static XrLocalizationMapML	nmap(long struct)	Unsafe version of map().
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static long	nsession(long struct)	Unsafe version of session().
static int	nstate(long struct)	Unsafe version of state().
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
long	session()	the session to which this change event applies.
XrEventDataLocalizationChangedML	set(int type, long next)	Initializes this struct with the specified values.
XrEventDataLocalizationChangedML	set(XrEventDataLocalizationChangedML src)	Copies the specified struct data to this struct.
int	sizeof()
int	state()	the current XrLocalizationMapStateML of the map.
int	type()	the XrStructureType of this structure.
XrEventDataLocalizationChangedML	type(int value)	Sets the specified value to the type() field.
XrEventDataLocalizationChangedML	type$Default()	Sets the TYPE_EVENT_DATA_LOCALIZATION_CHANGED_ML 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.

SESSION

public static final int SESSION

The struct member offsets.

STATE

public static final int STATE

The struct member offsets.

MAP

public static final int MAP

The struct member offsets.

CONFIDENCE

public static final int CONFIDENCE

The struct member offsets.

ERRORFLAGS

public static final int ERRORFLAGS

The struct member offsets.

Constructor Details

XrEventDataLocalizationChangedML

public XrEventDataLocalizationChangedML(ByteBuffer container)

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

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.

session

public long session()

the session to which this change event applies.

state

public int state()

the current XrLocalizationMapStateML of the map.

map

public XrLocalizationMapML map()

the XrLocalizationMapML of the current map.

confidence

public int confidence()

the XrLocalizationMapConfidenceML of the current map.

errorFlags

public long errorFlags()

a a bitwise-OR of zero or more of the bits defined in XrLocalizationMapErrorFlagBitsML in the case that the localization map has low confidence.

type

public XrEventDataLocalizationChangedML type(int value)

Sets the specified value to the type() field.

type$Default

public XrEventDataLocalizationChangedML type$Default()

Sets the TYPE_EVENT_DATA_LOCALIZATION_CHANGED_ML value to the type() field.

next

public XrEventDataLocalizationChangedML next(long value)

Sets the specified value to the next() field.

set

public XrEventDataLocalizationChangedML set(int type,
 long next)

Initializes this struct with the specified values.

set

public XrEventDataLocalizationChangedML set(XrEventDataLocalizationChangedML src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrEventDataLocalizationChangedML malloc()

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

calloc

public static XrEventDataLocalizationChangedML calloc()

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

create

public static XrEventDataLocalizationChangedML create()

Returns a new XrEventDataLocalizationChangedML instance allocated with BufferUtils.

create

public static XrEventDataLocalizationChangedML create(long address)

Returns a new XrEventDataLocalizationChangedML instance for the specified memory address.

createSafe

public static @Nullable XrEventDataLocalizationChangedML createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrEventDataLocalizationChangedML create(XrEventDataBaseHeader value)

Downcasts the specified XrEventDataBaseHeader instance to XrEventDataLocalizationChangedML.

malloc

public static XrEventDataLocalizationChangedML.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrEventDataLocalizationChangedML.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrEventDataLocalizationChangedML.Buffer create(int capacity)

Returns a new XrEventDataLocalizationChangedML.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrEventDataLocalizationChangedML.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

create

public static XrEventDataLocalizationChangedML.Buffer create(XrEventDataBaseHeader.Buffer value)

Downcasts the specified XrEventDataBaseHeader.Buffer instance to XrEventDataLocalizationChangedML.Buffer.

malloc

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

Returns a new XrEventDataLocalizationChangedML instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsession

public static long nsession(long struct)

Unsafe version of session().

nstate

public static int nstate(long struct)

Unsafe version of state().

nmap

public static XrLocalizationMapML nmap(long struct)

Unsafe version of map().

nconfidence

public static int nconfidence(long struct)

Unsafe version of confidence().

nerrorFlags

public static long nerrorFlags(long struct)

Unsafe version of errorFlags().

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.