Package org.lwjgl.openxr

Class XrSystemAnchorPropertiesHTC

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSystemAnchorPropertiesHTC>

org.lwjgl.openxr.XrSystemAnchorPropertiesHTC

All Implemented Interfaces:

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

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

System property for anchor.

Description

An application can inspect whether the system is capable of anchor functionality by chaining an XrSystemAnchorPropertiesHTC structure to the XrSystemProperties when calling GetSystemProperties. The runtime must return ERROR_FEATURE_UNSUPPORTED if XrSystemAnchorPropertiesHTC::supportsAnchor was FALSE.

Valid Usage (Implicit)

• The XR_HTC_anchor extension must be enabled prior to using XrSystemAnchorPropertiesHTC
• type must be TYPE_SYSTEM_ANCHOR_PROPERTIES_HTC
• next must be NULL or a valid pointer to the next structure in a structure chain

See Also

XrSystemProperties, GetSystemProperties

Layout

 struct XrSystemAnchorPropertiesHTC {
     XrStructureType type();
     void * next();
     XrBool32 supportsAnchor();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

SUPPORTSANCHOR

public static final int SUPPORTSANCHOR

The struct member offsets.

Constructor Details

XrSystemAnchorPropertiesHTC

public XrSystemAnchorPropertiesHTC(ByteBuffer container)

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

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.

supportsAnchor

public boolean supportsAnchor()

indicates if current system is capable of anchor functionality.

type

public XrSystemAnchorPropertiesHTC type(int value)

Sets the specified value to the type() field.

type$Default

public XrSystemAnchorPropertiesHTC type$Default()

Sets the TYPE_SYSTEM_ANCHOR_PROPERTIES_HTC value to the type() field.

next

public XrSystemAnchorPropertiesHTC next(long value)

Sets the specified value to the next() field.

set

public XrSystemAnchorPropertiesHTC set(int type,
 long next)

Initializes this struct with the specified values.

set

public XrSystemAnchorPropertiesHTC set(XrSystemAnchorPropertiesHTC src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSystemAnchorPropertiesHTC malloc()

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

calloc

public static XrSystemAnchorPropertiesHTC calloc()

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

create

public static XrSystemAnchorPropertiesHTC create()

Returns a new XrSystemAnchorPropertiesHTC instance allocated with BufferUtils.

create

public static XrSystemAnchorPropertiesHTC create(long address)

Returns a new XrSystemAnchorPropertiesHTC instance for the specified memory address.

createSafe

public static @Nullable XrSystemAnchorPropertiesHTC createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSystemAnchorPropertiesHTC.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSystemAnchorPropertiesHTC.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSystemAnchorPropertiesHTC.Buffer create(int capacity)

Returns a new XrSystemAnchorPropertiesHTC.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSystemAnchorPropertiesHTC.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSystemAnchorPropertiesHTC instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsupportsAnchor

public static int nsupportsAnchor(long struct)

Unsafe version of supportsAnchor().

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.