Package org.lwjgl.openxr

Class XrSystemUserPresencePropertiesEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSystemUserPresencePropertiesEXT>

org.lwjgl.openxr.XrSystemUserPresencePropertiesEXT

All Implemented Interfaces:

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

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

Returns the system capability whether it supports user presence.

Description

The application can use the XrSystemUserPresencePropertiesEXT event in GetSystemProperties to detect if the given system supports the sensing of user presence.

If the system does not support user presence sensing, the runtime must return FALSE for supportsUserPresence and must not queue the XrEventDataUserPresenceChangedEXT event for any session on this system.

In this case, an application typically assumes that the user is always present, as the runtime is unable to detect changes in user presence.

Valid Usage (Implicit)

• The XR_EXT_user_presence extension must be enabled prior to using XrSystemUserPresencePropertiesEXT
• type must be TYPE_SYSTEM_USER_PRESENCE_PROPERTIES_EXT
• next must be NULL or a valid pointer to the next structure in a structure chain

See Also

GetSystemProperties

Layout

 struct XrSystemUserPresencePropertiesEXT {
     XrStructureType type();
     void * next();
     XrBool32 supportsUserPresence();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrSystemUserPresencePropertiesEXT	calloc()	Returns a new XrSystemUserPresencePropertiesEXT instance allocated with memCalloc.
static XrSystemUserPresencePropertiesEXT.Buffer	calloc(int capacity)	Returns a new XrSystemUserPresencePropertiesEXT.Buffer instance allocated with memCalloc.
static XrSystemUserPresencePropertiesEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSystemUserPresencePropertiesEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSystemUserPresencePropertiesEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSystemUserPresencePropertiesEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSystemUserPresencePropertiesEXT	create()	Returns a new XrSystemUserPresencePropertiesEXT instance allocated with BufferUtils.
static XrSystemUserPresencePropertiesEXT.Buffer	create(int capacity)	Returns a new XrSystemUserPresencePropertiesEXT.Buffer instance allocated with BufferUtils.
static XrSystemUserPresencePropertiesEXT	create(long address)	Returns a new XrSystemUserPresencePropertiesEXT instance for the specified memory address.
static XrSystemUserPresencePropertiesEXT.Buffer	create(long address, int capacity)	Create a XrSystemUserPresencePropertiesEXT.Buffer instance at the specified memory.
static @Nullable XrSystemUserPresencePropertiesEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSystemUserPresencePropertiesEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrSystemUserPresencePropertiesEXT	malloc()	Returns a new XrSystemUserPresencePropertiesEXT instance allocated with memAlloc.
static XrSystemUserPresencePropertiesEXT.Buffer	malloc(int capacity)	Returns a new XrSystemUserPresencePropertiesEXT.Buffer instance allocated with memAlloc.
static XrSystemUserPresencePropertiesEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSystemUserPresencePropertiesEXT.Buffer instance allocated on the specified MemoryStack.
static XrSystemUserPresencePropertiesEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSystemUserPresencePropertiesEXT instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSystemUserPresencePropertiesEXT	next(long value)	Sets the specified value to the next() field.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	nsupportsUserPresence(long struct)	Unsafe version of supportsUserPresence().
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrSystemUserPresencePropertiesEXT	set(int type, long next)	Initializes this struct with the specified values.
XrSystemUserPresencePropertiesEXT	set(XrSystemUserPresencePropertiesEXT src)	Copies the specified struct data to this struct.
int	sizeof()
boolean	supportsUserPresence()	an XrBool32 value that indicates whether the system supports user presence sensing.
int	type()	the XrStructureType of this structure.
XrSystemUserPresencePropertiesEXT	type(int value)	Sets the specified value to the type() field.
XrSystemUserPresencePropertiesEXT	type$Default()	Sets the TYPE_SYSTEM_USER_PRESENCE_PROPERTIES_EXT 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.

SUPPORTSUSERPRESENCE

public static final int SUPPORTSUSERPRESENCE

The struct member offsets.

Constructor Details

XrSystemUserPresencePropertiesEXT

public XrSystemUserPresencePropertiesEXT(ByteBuffer container)

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

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.

supportsUserPresence

public boolean supportsUserPresence()

an XrBool32 value that indicates whether the system supports user presence sensing.

type

public XrSystemUserPresencePropertiesEXT type(int value)

Sets the specified value to the type() field.

type$Default

public XrSystemUserPresencePropertiesEXT type$Default()

Sets the TYPE_SYSTEM_USER_PRESENCE_PROPERTIES_EXT value to the type() field.

next

public XrSystemUserPresencePropertiesEXT next(long value)

Sets the specified value to the next() field.

set

public XrSystemUserPresencePropertiesEXT set(int type,
 long next)

Initializes this struct with the specified values.

set

public XrSystemUserPresencePropertiesEXT set(XrSystemUserPresencePropertiesEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSystemUserPresencePropertiesEXT malloc()

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

calloc

public static XrSystemUserPresencePropertiesEXT calloc()

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

create

public static XrSystemUserPresencePropertiesEXT create()

Returns a new XrSystemUserPresencePropertiesEXT instance allocated with BufferUtils.

create

public static XrSystemUserPresencePropertiesEXT create(long address)

Returns a new XrSystemUserPresencePropertiesEXT instance for the specified memory address.

createSafe

public static @Nullable XrSystemUserPresencePropertiesEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSystemUserPresencePropertiesEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSystemUserPresencePropertiesEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSystemUserPresencePropertiesEXT.Buffer create(int capacity)

Returns a new XrSystemUserPresencePropertiesEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSystemUserPresencePropertiesEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSystemUserPresencePropertiesEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsupportsUserPresence

public static int nsupportsUserPresence(long struct)

Unsafe version of supportsUserPresence().

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.