Package org.lwjgl.openxr

Class XrEventDataStartColocationDiscoveryCompleteMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrEventDataStartColocationDiscoveryCompleteMETA>

org.lwjgl.openxr.XrEventDataStartColocationDiscoveryCompleteMETA

All Implemented Interfaces:

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

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

Colocation discovery start complete event.

Description

This event conveys the results of the asynchronous operation started by StartColocationDiscoveryMETA.

Valid Usage (Implicit)

• The XR_META_colocation_discovery extension must be enabled prior to using XrEventDataStartColocationDiscoveryCompleteMETA
• type must be TYPE_EVENT_DATA_START_COLOCATION_DISCOVERY_COMPLETE_META
• next must be NULL or a valid pointer to the next structure in a structure chain
• result must be a valid XrResult value

See Also

StartColocationDiscoveryMETA

Layout

 struct XrEventDataStartColocationDiscoveryCompleteMETA {
     XrStructureType type();
     void const * next();
     XrAsyncRequestIdFB discoveryRequestId();
     XrResult result();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrEventDataStartColocationDiscoveryCompleteMETA	calloc()	Returns a new XrEventDataStartColocationDiscoveryCompleteMETA instance allocated with memCalloc.
static XrEventDataStartColocationDiscoveryCompleteMETA.Buffer	calloc(int capacity)	Returns a new XrEventDataStartColocationDiscoveryCompleteMETA.Buffer instance allocated with memCalloc.
static XrEventDataStartColocationDiscoveryCompleteMETA.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataStartColocationDiscoveryCompleteMETA.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrEventDataStartColocationDiscoveryCompleteMETA	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataStartColocationDiscoveryCompleteMETA instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrEventDataStartColocationDiscoveryCompleteMETA	create()	Returns a new XrEventDataStartColocationDiscoveryCompleteMETA instance allocated with BufferUtils.
static XrEventDataStartColocationDiscoveryCompleteMETA.Buffer	create(int capacity)	Returns a new XrEventDataStartColocationDiscoveryCompleteMETA.Buffer instance allocated with BufferUtils.
static XrEventDataStartColocationDiscoveryCompleteMETA	create(long address)	Returns a new XrEventDataStartColocationDiscoveryCompleteMETA instance for the specified memory address.
static XrEventDataStartColocationDiscoveryCompleteMETA.Buffer	create(long address, int capacity)	Create a XrEventDataStartColocationDiscoveryCompleteMETA.Buffer instance at the specified memory.
static @Nullable XrEventDataStartColocationDiscoveryCompleteMETA	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrEventDataStartColocationDiscoveryCompleteMETA.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	discoveryRequestId()	an XrAsyncRequestIdFB specifying the original start discovery async request id.
XrEventDataStartColocationDiscoveryCompleteMETA	discoveryRequestId(long value)	Sets the specified value to the discoveryRequestId() field.
static XrEventDataStartColocationDiscoveryCompleteMETA	malloc()	Returns a new XrEventDataStartColocationDiscoveryCompleteMETA instance allocated with memAlloc.
static XrEventDataStartColocationDiscoveryCompleteMETA.Buffer	malloc(int capacity)	Returns a new XrEventDataStartColocationDiscoveryCompleteMETA.Buffer instance allocated with memAlloc.
static XrEventDataStartColocationDiscoveryCompleteMETA.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataStartColocationDiscoveryCompleteMETA.Buffer instance allocated on the specified MemoryStack.
static XrEventDataStartColocationDiscoveryCompleteMETA	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataStartColocationDiscoveryCompleteMETA instance allocated on the specified MemoryStack.
static long	ndiscoveryRequestId(long struct)	Unsafe version of discoveryRequestId().
static void	ndiscoveryRequestId(long struct, long value)	Unsafe version of discoveryRequestId.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrEventDataStartColocationDiscoveryCompleteMETA	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	nresult(long struct)	Unsafe version of result().
static void	nresult(long struct, int value)	Unsafe version of result.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
int	result()	an XrResult representing the discovery process result.
XrEventDataStartColocationDiscoveryCompleteMETA	result(int value)	Sets the specified value to the result() field.
XrEventDataStartColocationDiscoveryCompleteMETA	set(int type, long next, long discoveryRequestId, int result)	Initializes this struct with the specified values.
XrEventDataStartColocationDiscoveryCompleteMETA	set(XrEventDataStartColocationDiscoveryCompleteMETA src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrEventDataStartColocationDiscoveryCompleteMETA	type(int value)	Sets the specified value to the type() field.
XrEventDataStartColocationDiscoveryCompleteMETA	type$Default()	Sets the TYPE_EVENT_DATA_START_COLOCATION_DISCOVERY_COMPLETE_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.

DISCOVERYREQUESTID

public static final int DISCOVERYREQUESTID

The struct member offsets.

RESULT

public static final int RESULT

The struct member offsets.

Constructor Details

XrEventDataStartColocationDiscoveryCompleteMETA

public XrEventDataStartColocationDiscoveryCompleteMETA(ByteBuffer container)

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

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.

discoveryRequestId

public long discoveryRequestId()

an XrAsyncRequestIdFB specifying the original start discovery async request id. The runtime must return a value which matches a previously returned discoveryRequestId value from an StartColocationDiscoveryMETA request.

result

public int result()

an XrResult representing the discovery process result. The valid result values are: SUCCESS, ERROR_RUNTIME_FAILURE, ERROR_COLOCATION_DISCOVERY_NETWORK_FAILED_META, ERROR_COLOCATION_DISCOVERY_NO_DISCOVERY_METHOD_META, and COLOCATION_DISCOVERY_ALREADY_DISCOVERING_META. If the application already has an active colocation discovery, the runtime must return COLOCATION_DISCOVERY_ALREADY_DISCOVERING_META in XrEventDataStartColocationDiscoveryCompleteMETA::result.

type

public XrEventDataStartColocationDiscoveryCompleteMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrEventDataStartColocationDiscoveryCompleteMETA type$Default()

Sets the TYPE_EVENT_DATA_START_COLOCATION_DISCOVERY_COMPLETE_META value to the type() field.

next

public XrEventDataStartColocationDiscoveryCompleteMETA next(long value)

Sets the specified value to the next() field.

discoveryRequestId

public XrEventDataStartColocationDiscoveryCompleteMETA discoveryRequestId(long value)

Sets the specified value to the discoveryRequestId() field.

result

public XrEventDataStartColocationDiscoveryCompleteMETA result(int value)

Sets the specified value to the result() field.

set

public XrEventDataStartColocationDiscoveryCompleteMETA set(int type,
 long next,
 long discoveryRequestId,
 int result)

Initializes this struct with the specified values.

set

public XrEventDataStartColocationDiscoveryCompleteMETA set(XrEventDataStartColocationDiscoveryCompleteMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrEventDataStartColocationDiscoveryCompleteMETA malloc()

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

calloc

public static XrEventDataStartColocationDiscoveryCompleteMETA calloc()

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

create

public static XrEventDataStartColocationDiscoveryCompleteMETA create()

Returns a new XrEventDataStartColocationDiscoveryCompleteMETA instance allocated with BufferUtils.

create

public static XrEventDataStartColocationDiscoveryCompleteMETA create(long address)

Returns a new XrEventDataStartColocationDiscoveryCompleteMETA instance for the specified memory address.

createSafe

public static @Nullable XrEventDataStartColocationDiscoveryCompleteMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrEventDataStartColocationDiscoveryCompleteMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrEventDataStartColocationDiscoveryCompleteMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrEventDataStartColocationDiscoveryCompleteMETA.Buffer create(int capacity)

Returns a new XrEventDataStartColocationDiscoveryCompleteMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrEventDataStartColocationDiscoveryCompleteMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrEventDataStartColocationDiscoveryCompleteMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ndiscoveryRequestId

public static long ndiscoveryRequestId(long struct)

Unsafe version of discoveryRequestId().

nresult

public static int nresult(long struct)

Unsafe version of result().

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.

ndiscoveryRequestId

public static void ndiscoveryRequestId(long struct,
 long value)

Unsafe version of discoveryRequestId.

nresult

public static void nresult(long struct,
 int value)

Unsafe version of result.