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 systemName field in XrSystemProperties 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

Layout


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

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	XrSystemHeadsetIdPropertiesMETA.Buffer An array of `XrSystemHeadsetIdPropertiesMETA` structs.

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	ID The struct member offsets.
public static final int	NEXT The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	TYPE The struct member offsets.

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	XrSystemHeadsetIdPropertiesMETA(long address, ByteBuffer container)
public	XrSystemHeadsetIdPropertiesMETA(ByteBuffer container) Creates a `XrSystemHeadsetIdPropertiesMETA` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static XrSystemHeadsetIdPropertiesMETA	calloc() Returns a new `XrSystemHeadsetIdPropertiesMETA` instance allocated with `memCalloc`.
public static XrSystemHeadsetIdPropertiesMETA.Buffer	calloc(int the buffer capacity capacity) Returns a new `XrSystemHeadsetIdPropertiesMETA.Buffer` instance allocated with `memCalloc`.
public static XrSystemHeadsetIdPropertiesMETA	calloc(MemoryStack the stack from which to allocate stack) Returns a new `XrSystemHeadsetIdPropertiesMETA` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static XrSystemHeadsetIdPropertiesMETA.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrSystemHeadsetIdPropertiesMETA.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected XrSystemHeadsetIdPropertiesMETA	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static XrSystemHeadsetIdPropertiesMETA	create() Returns a new `XrSystemHeadsetIdPropertiesMETA` instance allocated with `BufferUtils`.
public static XrSystemHeadsetIdPropertiesMETA	create(long address) Returns a new `XrSystemHeadsetIdPropertiesMETA` instance for the specified memory address.
public static XrSystemHeadsetIdPropertiesMETA.Buffer	create(int the buffer capacity capacity) Returns a new `XrSystemHeadsetIdPropertiesMETA.Buffer` instance allocated with `BufferUtils`.
public static XrSystemHeadsetIdPropertiesMETA.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `XrSystemHeadsetIdPropertiesMETA.Buffer` instance at the specified memory.
public static XrSystemHeadsetIdPropertiesMETA	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static XrSystemHeadsetIdPropertiesMETA.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public XrUuidEXT	id() the `XrUuidEXT` corresponding to the headset model.
public static XrSystemHeadsetIdPropertiesMETA	malloc() Returns a new `XrSystemHeadsetIdPropertiesMETA` instance allocated with `memAlloc`.
public static XrSystemHeadsetIdPropertiesMETA.Buffer	malloc(int the buffer capacity capacity) Returns a new `XrSystemHeadsetIdPropertiesMETA.Buffer` instance allocated with `memAlloc`.
public static XrSystemHeadsetIdPropertiesMETA	malloc(MemoryStack the stack from which to allocate stack) Returns a new `XrSystemHeadsetIdPropertiesMETA` instance allocated on the specified `MemoryStack`.
public static XrSystemHeadsetIdPropertiesMETA.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrSystemHeadsetIdPropertiesMETA.Buffer` instance allocated on the specified `MemoryStack`.
public long	next() `NULL` or a pointer to the next structure in a structure chain.
public XrSystemHeadsetIdPropertiesMETA	next(long value) Sets the specified value to the `next` field.
public static XrUuidEXT	nid(long struct) Unsafe version of `id`.
public static long	nnext(long struct) Unsafe version of `next`.
public static void	nnext(long struct, long value) Unsafe version of `next`.
public static int	ntype(long struct) Unsafe version of `type`.
public static void	ntype(long struct, int value) Unsafe version of `type`.
public XrSystemHeadsetIdPropertiesMETA	set(int type, long next) Initializes this struct with the specified values.
public XrSystemHeadsetIdPropertiesMETA	Returns: this struct set(XrSystemHeadsetIdPropertiesMETA the source struct src) Copies the specified struct data to this struct.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public int	type() the `XrStructureType` of this structure.
public XrSystemHeadsetIdPropertiesMETA	type(int value) Sets the specified value to the `type` field.
public XrSystemHeadsetIdPropertiesMETA	type$Default() Sets the `TYPE_SYSTEM_HEADSET_ID_PROPERTIES_META` value to the `type` field.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

ID	back to summary
public static final int ID The struct member offsets.

NEXT	back to summary
public static final int NEXT The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

TYPE	back to summary
public static final int TYPE The struct member offsets.

Constructor Detail

XrSystemHeadsetIdPropertiesMETA	back to summary
protected XrSystemHeadsetIdPropertiesMETA(long address, ByteBuffer container)

XrSystemHeadsetIdPropertiesMETA back to summary

XrSystemHeadsetIdPropertiesMETA	back to summary
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.

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 Detail

calloc	back to summary
public static XrSystemHeadsetIdPropertiesMETA calloc() Returns a new `XrSystemHeadsetIdPropertiesMETA` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static XrSystemHeadsetIdPropertiesMETA.Buffer calloc(int capacity) Returns a new `XrSystemHeadsetIdPropertiesMETA.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrSystemHeadsetIdPropertiesMETA.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static XrSystemHeadsetIdPropertiesMETA calloc(MemoryStack stack) Returns a new `XrSystemHeadsetIdPropertiesMETA` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static XrSystemHeadsetIdPropertiesMETA calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static XrSystemHeadsetIdPropertiesMETA.Buffer calloc(int capacity, MemoryStack stack) Returns a new `XrSystemHeadsetIdPropertiesMETA.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

create back to summary

create	back to summary
protected XrSystemHeadsetIdPropertiesMETA create(long address, ByteBuffer container) Implements abstract org.lwjgl.system.Struct.create. Doc from org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass. Effectively, every `Struct` instance is a factory for more instances of the same type. This is used by `StructBuffer`. Parameters address:long the struct memory address container:ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. Annotations @Override

protected XrSystemHeadsetIdPropertiesMETA create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters

address:long: the struct memory address
container:ByteBuffer: an optional container buffer, to be referenced strongly by the struct instance.

Annotations

@Override

create	back to summary
public static XrSystemHeadsetIdPropertiesMETA create() Returns a new `XrSystemHeadsetIdPropertiesMETA` instance allocated with `BufferUtils`.

create	back to summary
public static XrSystemHeadsetIdPropertiesMETA create(long address) Returns a new `XrSystemHeadsetIdPropertiesMETA` instance for the specified memory address.

create back to summary

create	back to summary
public static XrSystemHeadsetIdPropertiesMETA.Buffer create(int capacity) Returns a new `XrSystemHeadsetIdPropertiesMETA.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static XrSystemHeadsetIdPropertiesMETA.Buffer create(int capacity)

Returns a new XrSystemHeadsetIdPropertiesMETA.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static XrSystemHeadsetIdPropertiesMETA.Buffer create(long address, int capacity) Create a `XrSystemHeadsetIdPropertiesMETA.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a XrSystemHeadsetIdPropertiesMETA.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static XrSystemHeadsetIdPropertiesMETA createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static XrSystemHeadsetIdPropertiesMETA createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static XrSystemHeadsetIdPropertiesMETA.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

id	back to summary
public XrUuidEXT id() the `XrUuidEXT` corresponding to the headset model.

malloc	back to summary
public static XrSystemHeadsetIdPropertiesMETA malloc() Returns a new `XrSystemHeadsetIdPropertiesMETA` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static XrSystemHeadsetIdPropertiesMETA.Buffer malloc(int capacity) Returns a new `XrSystemHeadsetIdPropertiesMETA.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrSystemHeadsetIdPropertiesMETA.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static XrSystemHeadsetIdPropertiesMETA malloc(MemoryStack stack) Returns a new `XrSystemHeadsetIdPropertiesMETA` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static XrSystemHeadsetIdPropertiesMETA malloc(MemoryStack stack)

Returns a new XrSystemHeadsetIdPropertiesMETA instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static XrSystemHeadsetIdPropertiesMETA.Buffer malloc(int capacity, MemoryStack stack) Returns a new `XrSystemHeadsetIdPropertiesMETA.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

next back to summary

next	back to summary
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. Annotations @NativeType:void *

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.

Annotations

@NativeType:void *

next	back to summary
public XrSystemHeadsetIdPropertiesMETA next(long value) Sets the specified value to the `next` field.

nid	back to summary
public static XrUuidEXT nid(long struct) Unsafe version of `id`.

nnext	back to summary
public static long nnext(long struct) Unsafe version of `next`.

nnext	back to summary
public static void nnext(long struct, long value) Unsafe version of `next`.

ntype	back to summary
public static int ntype(long struct) Unsafe version of `type`.

ntype	back to summary
public static void ntype(long struct, int value) Unsafe version of `type`.

set	back to summary
public XrSystemHeadsetIdPropertiesMETA set(int type, long next) Initializes this struct with the specified values.

set	back to summary
public XrSystemHeadsetIdPropertiesMETA set(XrSystemHeadsetIdPropertiesMETA src) Copies the specified struct data to this struct. Parameters src:XrSystemHeadsetIdPropertiesMETA the source struct Returns:XrSystemHeadsetIdPropertiesMETA this struct

set

back to summary

public XrSystemHeadsetIdPropertiesMETA set(XrSystemHeadsetIdPropertiesMETA src)

Copies the specified struct data to this struct.

Parameters

src:XrSystemHeadsetIdPropertiesMETA: the source struct

Returns:XrSystemHeadsetIdPropertiesMETA

this struct

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

type back to summary

type	back to summary
public int type() the `XrStructureType` of this structure. Annotations @NativeType:XrStructureType

public int type()

the XrStructureType of this structure.

Annotations

@NativeType:XrStructureType

type	back to summary
public XrSystemHeadsetIdPropertiesMETA type(int value) Sets the specified value to the `type` field.

type$Default	back to summary
public XrSystemHeadsetIdPropertiesMETA type$Default() Sets the `TYPE_SYSTEM_HEADSET_ID_PROPERTIES_META` value to the `type` field.

org.lwjgl.openxr back to summary

public Class XrSystemHeadsetIdPropertiesMETA.Buffer

Class Inheritance

extends StructBuffer<XrSystemHeadsetIdPropertiesMETA, XrSystemHeadsetIdPropertiesMETA.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.openxr.XrSystemHeadsetIdPropertiesMETA.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrSystemHeadsetIdPropertiesMETA structs.

Field Summary

Modifier and Type	Field and Description
private static final XrSystemHeadsetIdPropertiesMETA	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `XrSystemHeadsetIdPropertiesMETA.Buffer` instance backed by the specified container.
public	Buffer(long address, int cap)
pack-priv	Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and Type	Method and Description
protected XrSystemHeadsetIdPropertiesMETA	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public XrUuidEXT	Returns: a `XrUuidEXT` view of the `XrSystemHeadsetIdPropertiesMETA#id` field. id()
public long	Returns: the value of the `XrSystemHeadsetIdPropertiesMETA#next` field. next()
public XrSystemHeadsetIdPropertiesMETA.Buffer	next(long value) Sets the specified value to the `XrSystemHeadsetIdPropertiesMETA#next` field.
protected XrSystemHeadsetIdPropertiesMETA.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `XrSystemHeadsetIdPropertiesMETA#type` field. type()
public XrSystemHeadsetIdPropertiesMETA.Buffer	type(int value) Sets the specified value to the `XrSystemHeadsetIdPropertiesMETA#type` field.
public XrSystemHeadsetIdPropertiesMETA.Buffer	type$Default() Sets the `TYPE_SYSTEM_HEADSET_ID_PROPERTIES_META` value to the `XrSystemHeadsetIdPropertiesMETA#type` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final XrSystemHeadsetIdPropertiesMETA ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `XrSystemHeadsetIdPropertiesMETA.Buffer` instance backed by the specified container. Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by `XrSystemHeadsetIdPropertiesMETA#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

Creates a new XrSystemHeadsetIdPropertiesMETA.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by XrSystemHeadsetIdPropertiesMETA#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactory	back to summary
protected XrSystemHeadsetIdPropertiesMETA getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory. Annotations @Override

getElementFactory

back to summary

protected XrSystemHeadsetIdPropertiesMETA getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations

@Override

id	back to summary
public XrUuidEXT id() Returns:XrUuidEXT a `XrUuidEXT` view of the `XrSystemHeadsetIdPropertiesMETA#id` field.

next	back to summary
public long next() Returns:long the value of the `XrSystemHeadsetIdPropertiesMETA#next` field. Annotations @NativeType:void *

next	back to summary
public XrSystemHeadsetIdPropertiesMETA.Buffer next(long value) Sets the specified value to the `XrSystemHeadsetIdPropertiesMETA#next` field.

self

back to summary

protected XrSystemHeadsetIdPropertiesMETA.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations

@Override

type	back to summary
public int type() Returns:int the value of the `XrSystemHeadsetIdPropertiesMETA#type` field. Annotations @NativeType:XrStructureType

type	back to summary
public XrSystemHeadsetIdPropertiesMETA.Buffer type(int value) Sets the specified value to the `XrSystemHeadsetIdPropertiesMETA#type` field.

type$Default	back to summary
public XrSystemHeadsetIdPropertiesMETA.Buffer type$Default() Sets the `TYPE_SYSTEM_HEADSET_ID_PROPERTIES_META` value to the `XrSystemHeadsetIdPropertiesMETA#type` field.

public Class XrSystemHeadsetIdPropertiesMETA

Description

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class XrSystemHeadsetIdPropertiesMETA.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail