Package org.lwjgl.openxr

Class XrSystemColocationDiscoveryPropertiesMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSystemColocationDiscoveryPropertiesMETA>

org.lwjgl.openxr.XrSystemColocationDiscoveryPropertiesMETA

All Implemented Interfaces:

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

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

Colocation discovery system properties.

Description

An application can inspect whether the system is capable of colocation advertisement and discovery by extending the XrSystemProperties with XrSystemColocationDiscoveryPropertiesMETA structure when calling GetSystemProperties.

If a runtime returns FALSE for supportsColocationDiscovery, the runtime must return ERROR_FEATURE_UNSUPPORTED for all functions in the XR_META_colocation_discovery extension.

Colocation advertisement controls whether a device is discoverable using colocation discovery, so the term "colocation discovery" on its own is used here to refer to the combined capability of colocation advertisement and colocation discovery.

Valid Usage (Implicit)

• The XR_META_colocation_discovery extension must be enabled prior to using XrSystemColocationDiscoveryPropertiesMETA
• type must be TYPE_SYSTEM_COLOCATION_DISCOVERY_PROPERTIES_META
• next must be NULL or a valid pointer to the next structure in a structure chain

Layout

 struct XrSystemColocationDiscoveryPropertiesMETA {
     XrStructureType type();
     void * next();
     XrBool32 supportsColocationDiscovery();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

SUPPORTSCOLOCATIONDISCOVERY

public static final int SUPPORTSCOLOCATIONDISCOVERY

The struct member offsets.

Constructor Details

XrSystemColocationDiscoveryPropertiesMETA

public XrSystemColocationDiscoveryPropertiesMETA(ByteBuffer container)

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

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.

supportsColocationDiscovery

public boolean supportsColocationDiscovery()

an XrBool32 specifying if colocation discovery (and relatedly, colocation advertisement) is supported.

type

public XrSystemColocationDiscoveryPropertiesMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrSystemColocationDiscoveryPropertiesMETA type$Default()

Sets the TYPE_SYSTEM_COLOCATION_DISCOVERY_PROPERTIES_META value to the type() field.

next

public XrSystemColocationDiscoveryPropertiesMETA next(long value)

Sets the specified value to the next() field.

set

public XrSystemColocationDiscoveryPropertiesMETA set(int type,
 long next)

Initializes this struct with the specified values.

set

public XrSystemColocationDiscoveryPropertiesMETA set(XrSystemColocationDiscoveryPropertiesMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSystemColocationDiscoveryPropertiesMETA malloc()

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

calloc

public static XrSystemColocationDiscoveryPropertiesMETA calloc()

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

create

public static XrSystemColocationDiscoveryPropertiesMETA create()

Returns a new XrSystemColocationDiscoveryPropertiesMETA instance allocated with BufferUtils.

create

public static XrSystemColocationDiscoveryPropertiesMETA create(long address)

Returns a new XrSystemColocationDiscoveryPropertiesMETA instance for the specified memory address.

createSafe

public static @Nullable XrSystemColocationDiscoveryPropertiesMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSystemColocationDiscoveryPropertiesMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSystemColocationDiscoveryPropertiesMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSystemColocationDiscoveryPropertiesMETA.Buffer create(int capacity)

Returns a new XrSystemColocationDiscoveryPropertiesMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSystemColocationDiscoveryPropertiesMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSystemColocationDiscoveryPropertiesMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsupportsColocationDiscovery

public static int nsupportsColocationDiscovery(long struct)

Unsafe version of supportsColocationDiscovery().

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.