Package org.lwjgl.openxr

Class XrSystemHeadsetIdPropertiesMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSystemHeadsetIdPropertiesMETA>

org.lwjgl.openxr.XrSystemHeadsetIdPropertiesMETA

All Implemented Interfaces:

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

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

get headset model id from xrGetSystemProperties.

Description

An application can get a corresponding headset UUID of the headset model by chaining an XrSystemHeadsetIdPropertiesMETA structure to the XrSystemProperties when calling GetSystemProperties.

The UUID returned in the XrSystemHeadsetIdPropertiesMETA structure is an opaque UUID that identifies a runtime / headset model combo.

The runtime should always return the same UUID for a given headset model for the entire lifetime of that product.

The runtime may report a different UUID to some applications for compatibility purposes.

This is in contrast to the XrSystemProperties::systemName field which is not required to be consistent across product renames.

This is intended to be a temporary feature that will be deprecated along with its extension as soon as motivating use cases are resolved in a better way. See the disclaimer at the start of the XR_META_headset_id extension documentation for more details.

Valid Usage (Implicit)

• The XR_META_headset_id extension must be enabled prior to using XrSystemHeadsetIdPropertiesMETA
• type must be TYPE_SYSTEM_HEADSET_ID_PROPERTIES_META
• next must be NULL or a valid pointer to the next structure in a structure chain

See Also

XrUuidEXT, GetSystemProperties

Layout

 struct XrSystemHeadsetIdPropertiesMETA {
     XrStructureType type();
     void * next();
     XrUuidEXT id();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrSystemHeadsetIdPropertiesMETA.Buffer	An array of XrSystemHeadsetIdPropertiesMETA 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	ID	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
XrSystemHeadsetIdPropertiesMETA(ByteBuffer container)	Creates a XrSystemHeadsetIdPropertiesMETA instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrSystemHeadsetIdPropertiesMETA	calloc()	Returns a new XrSystemHeadsetIdPropertiesMETA instance allocated with memCalloc.
static XrSystemHeadsetIdPropertiesMETA.Buffer	calloc(int capacity)	Returns a new XrSystemHeadsetIdPropertiesMETA.Buffer instance allocated with memCalloc.
static XrSystemHeadsetIdPropertiesMETA.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSystemHeadsetIdPropertiesMETA.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSystemHeadsetIdPropertiesMETA	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSystemHeadsetIdPropertiesMETA instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSystemHeadsetIdPropertiesMETA	create()	Returns a new XrSystemHeadsetIdPropertiesMETA instance allocated with BufferUtils.
static XrSystemHeadsetIdPropertiesMETA.Buffer	create(int capacity)	Returns a new XrSystemHeadsetIdPropertiesMETA.Buffer instance allocated with BufferUtils.
static XrSystemHeadsetIdPropertiesMETA	create(long address)	Returns a new XrSystemHeadsetIdPropertiesMETA instance for the specified memory address.
static XrSystemHeadsetIdPropertiesMETA.Buffer	create(long address, int capacity)	Create a XrSystemHeadsetIdPropertiesMETA.Buffer instance at the specified memory.
static @Nullable XrSystemHeadsetIdPropertiesMETA	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSystemHeadsetIdPropertiesMETA.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
XrUuidEXT	id()	the XrUuidEXT corresponding to the headset model.
static XrSystemHeadsetIdPropertiesMETA	malloc()	Returns a new XrSystemHeadsetIdPropertiesMETA instance allocated with memAlloc.
static XrSystemHeadsetIdPropertiesMETA.Buffer	malloc(int capacity)	Returns a new XrSystemHeadsetIdPropertiesMETA.Buffer instance allocated with memAlloc.
static XrSystemHeadsetIdPropertiesMETA.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSystemHeadsetIdPropertiesMETA.Buffer instance allocated on the specified MemoryStack.
static XrSystemHeadsetIdPropertiesMETA	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSystemHeadsetIdPropertiesMETA instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSystemHeadsetIdPropertiesMETA	next(long value)	Sets the specified value to the next() field.
static XrUuidEXT	nid(long struct)	Unsafe version of id().
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.
XrSystemHeadsetIdPropertiesMETA	set(int type, long next)	Initializes this struct with the specified values.
XrSystemHeadsetIdPropertiesMETA	set(XrSystemHeadsetIdPropertiesMETA src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrSystemHeadsetIdPropertiesMETA	type(int value)	Sets the specified value to the type() field.
XrSystemHeadsetIdPropertiesMETA	type$Default()	Sets the TYPE_SYSTEM_HEADSET_ID_PROPERTIES_META 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.

ID

public static final int ID

The struct member offsets.

Constructor Details

XrSystemHeadsetIdPropertiesMETA

public XrSystemHeadsetIdPropertiesMETA(ByteBuffer container)

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

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.

id

public XrUuidEXT id()

the XrUuidEXT corresponding to the headset model.

type

public XrSystemHeadsetIdPropertiesMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrSystemHeadsetIdPropertiesMETA type$Default()

Sets the TYPE_SYSTEM_HEADSET_ID_PROPERTIES_META value to the type() field.

next

public XrSystemHeadsetIdPropertiesMETA next(long value)

Sets the specified value to the next() field.

set

public XrSystemHeadsetIdPropertiesMETA set(int type,
 long next)

Initializes this struct with the specified values.

set

public XrSystemHeadsetIdPropertiesMETA set(XrSystemHeadsetIdPropertiesMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSystemHeadsetIdPropertiesMETA malloc()

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

calloc

public static XrSystemHeadsetIdPropertiesMETA calloc()

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

create

public static XrSystemHeadsetIdPropertiesMETA create()

Returns a new XrSystemHeadsetIdPropertiesMETA instance allocated with BufferUtils.

create

public static XrSystemHeadsetIdPropertiesMETA create(long address)

Returns a new XrSystemHeadsetIdPropertiesMETA instance for the specified memory address.

createSafe

public static @Nullable XrSystemHeadsetIdPropertiesMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSystemHeadsetIdPropertiesMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSystemHeadsetIdPropertiesMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSystemHeadsetIdPropertiesMETA.Buffer create(int capacity)

Returns a new XrSystemHeadsetIdPropertiesMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSystemHeadsetIdPropertiesMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSystemHeadsetIdPropertiesMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nid

public static XrUuidEXT nid(long struct)

Unsafe version of id().

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.