Package org.lwjgl.openxr

Class XrEventDataColocationDiscoveryCompleteMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrEventDataColocationDiscoveryCompleteMETA>

org.lwjgl.openxr.XrEventDataColocationDiscoveryCompleteMETA

All Implemented Interfaces:

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

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

discovery complete event.

Description

The runtime must queue exactly one XrEventDataColocationDiscoveryCompleteMETA event whenever an active colocation discovery is stopped. This includes if the colocation discovery is stopped due to an application calling StopColocationDiscoveryMETA, or the runtime needs to stop the colocation discovery for any reason. When the XrSession is destroyed, the runtime must stop all active advertisements started from the same XrSession.

Valid Usage (Implicit)

• The XR_META_colocation_discovery extension must be enabled prior to using XrEventDataColocationDiscoveryCompleteMETA
• type must be TYPE_EVENT_DATA_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, StopColocationDiscoveryMETA

Layout

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrEventDataColocationDiscoveryCompleteMETA	calloc()	Returns a new XrEventDataColocationDiscoveryCompleteMETA instance allocated with memCalloc.
static XrEventDataColocationDiscoveryCompleteMETA.Buffer	calloc(int capacity)	Returns a new XrEventDataColocationDiscoveryCompleteMETA.Buffer instance allocated with memCalloc.
static XrEventDataColocationDiscoveryCompleteMETA.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataColocationDiscoveryCompleteMETA.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrEventDataColocationDiscoveryCompleteMETA	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataColocationDiscoveryCompleteMETA instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrEventDataColocationDiscoveryCompleteMETA	create()	Returns a new XrEventDataColocationDiscoveryCompleteMETA instance allocated with BufferUtils.
static XrEventDataColocationDiscoveryCompleteMETA.Buffer	create(int capacity)	Returns a new XrEventDataColocationDiscoveryCompleteMETA.Buffer instance allocated with BufferUtils.
static XrEventDataColocationDiscoveryCompleteMETA	create(long address)	Returns a new XrEventDataColocationDiscoveryCompleteMETA instance for the specified memory address.
static XrEventDataColocationDiscoveryCompleteMETA.Buffer	create(long address, int capacity)	Create a XrEventDataColocationDiscoveryCompleteMETA.Buffer instance at the specified memory.
static @Nullable XrEventDataColocationDiscoveryCompleteMETA	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrEventDataColocationDiscoveryCompleteMETA.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.
XrEventDataColocationDiscoveryCompleteMETA	discoveryRequestId(long value)	Sets the specified value to the discoveryRequestId() field.
static XrEventDataColocationDiscoveryCompleteMETA	malloc()	Returns a new XrEventDataColocationDiscoveryCompleteMETA instance allocated with memAlloc.
static XrEventDataColocationDiscoveryCompleteMETA.Buffer	malloc(int capacity)	Returns a new XrEventDataColocationDiscoveryCompleteMETA.Buffer instance allocated with memAlloc.
static XrEventDataColocationDiscoveryCompleteMETA.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataColocationDiscoveryCompleteMETA.Buffer instance allocated on the specified MemoryStack.
static XrEventDataColocationDiscoveryCompleteMETA	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataColocationDiscoveryCompleteMETA 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.
XrEventDataColocationDiscoveryCompleteMETA	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.
XrEventDataColocationDiscoveryCompleteMETA	result(int value)	Sets the specified value to the result() field.
XrEventDataColocationDiscoveryCompleteMETA	set(int type, long next, long discoveryRequestId, int result)	Initializes this struct with the specified values.
XrEventDataColocationDiscoveryCompleteMETA	set(XrEventDataColocationDiscoveryCompleteMETA src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrEventDataColocationDiscoveryCompleteMETA	type(int value)	Sets the specified value to the type() field.
XrEventDataColocationDiscoveryCompleteMETA	type$Default()	Sets the TYPE_EVENT_DATA_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

XrEventDataColocationDiscoveryCompleteMETA

public XrEventDataColocationDiscoveryCompleteMETA(ByteBuffer container)

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

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, and ERROR_COLOCATION_DISCOVERY_NO_DISCOVERY_METHOD_META.

type

public XrEventDataColocationDiscoveryCompleteMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrEventDataColocationDiscoveryCompleteMETA type$Default()

Sets the TYPE_EVENT_DATA_COLOCATION_DISCOVERY_COMPLETE_META value to the type() field.

next

public XrEventDataColocationDiscoveryCompleteMETA next(long value)

Sets the specified value to the next() field.

discoveryRequestId

public XrEventDataColocationDiscoveryCompleteMETA discoveryRequestId(long value)

Sets the specified value to the discoveryRequestId() field.

result

public XrEventDataColocationDiscoveryCompleteMETA result(int value)

Sets the specified value to the result() field.

set

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

Initializes this struct with the specified values.

set

public XrEventDataColocationDiscoveryCompleteMETA set(XrEventDataColocationDiscoveryCompleteMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrEventDataColocationDiscoveryCompleteMETA malloc()

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

calloc

public static XrEventDataColocationDiscoveryCompleteMETA calloc()

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

create

public static XrEventDataColocationDiscoveryCompleteMETA create()

Returns a new XrEventDataColocationDiscoveryCompleteMETA instance allocated with BufferUtils.

create

public static XrEventDataColocationDiscoveryCompleteMETA create(long address)

Returns a new XrEventDataColocationDiscoveryCompleteMETA instance for the specified memory address.

createSafe

public static @Nullable XrEventDataColocationDiscoveryCompleteMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrEventDataColocationDiscoveryCompleteMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrEventDataColocationDiscoveryCompleteMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrEventDataColocationDiscoveryCompleteMETA.Buffer create(int capacity)

Returns a new XrEventDataColocationDiscoveryCompleteMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrEventDataColocationDiscoveryCompleteMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrEventDataColocationDiscoveryCompleteMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new XrEventDataColocationDiscoveryCompleteMETA.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.