Package org.lwjgl.openxr

Class XrEventDataStopColocationDiscoveryCompleteMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrEventDataStopColocationDiscoveryCompleteMETA>

org.lwjgl.openxr.XrEventDataStopColocationDiscoveryCompleteMETA

All Implemented Interfaces:

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

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

Colocation discovery stop complete event.

Description

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

Valid Usage (Implicit)

• The XR_META_colocation_discovery extension must be enabled prior to using XrEventDataStopColocationDiscoveryCompleteMETA
• type must be TYPE_EVENT_DATA_STOP_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

StopColocationDiscoveryMETA

Layout

 struct XrEventDataStopColocationDiscoveryCompleteMETA {
     XrStructureType type();
     void const * next();
     XrAsyncRequestIdFB requestId();
     XrResult result();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

REQUESTID

public static final int REQUESTID

The struct member offsets.

RESULT

public static final int RESULT

The struct member offsets.

Constructor Details

XrEventDataStopColocationDiscoveryCompleteMETA

public XrEventDataStopColocationDiscoveryCompleteMETA(ByteBuffer container)

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

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.

requestId

public long requestId()

an XrAsyncRequestIdFB that identifies which request this event is in response to. The runtime must ensure this value matches a requestId returned during an StopColocationDiscoveryMETA call.

result

public int result()

an XrResult representing the discovery process result. The valid result values are: SUCCESS and ERROR_RUNTIME_FAILURE. If the application does not already have an active colocation discovery, the runtime must return SUCCESS.

type

public XrEventDataStopColocationDiscoveryCompleteMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrEventDataStopColocationDiscoveryCompleteMETA type$Default()

Sets the TYPE_EVENT_DATA_STOP_COLOCATION_DISCOVERY_COMPLETE_META value to the type() field.

next

public XrEventDataStopColocationDiscoveryCompleteMETA next(long value)

Sets the specified value to the next() field.

requestId

public XrEventDataStopColocationDiscoveryCompleteMETA requestId(long value)

Sets the specified value to the requestId() field.

result

public XrEventDataStopColocationDiscoveryCompleteMETA result(int value)

Sets the specified value to the result() field.

set

public XrEventDataStopColocationDiscoveryCompleteMETA set(int type,
 long next,
 long requestId,
 int result)

Initializes this struct with the specified values.

set

public XrEventDataStopColocationDiscoveryCompleteMETA set(XrEventDataStopColocationDiscoveryCompleteMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrEventDataStopColocationDiscoveryCompleteMETA malloc()

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

calloc

public static XrEventDataStopColocationDiscoveryCompleteMETA calloc()

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

create

public static XrEventDataStopColocationDiscoveryCompleteMETA create()

Returns a new XrEventDataStopColocationDiscoveryCompleteMETA instance allocated with BufferUtils.

create

public static XrEventDataStopColocationDiscoveryCompleteMETA create(long address)

Returns a new XrEventDataStopColocationDiscoveryCompleteMETA instance for the specified memory address.

createSafe

public static @Nullable XrEventDataStopColocationDiscoveryCompleteMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrEventDataStopColocationDiscoveryCompleteMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrEventDataStopColocationDiscoveryCompleteMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrEventDataStopColocationDiscoveryCompleteMETA.Buffer create(int capacity)

Returns a new XrEventDataStopColocationDiscoveryCompleteMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrEventDataStopColocationDiscoveryCompleteMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrEventDataStopColocationDiscoveryCompleteMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nrequestId

public static long nrequestId(long struct)

Unsafe version of requestId().

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.

nrequestId

public static void nrequestId(long struct,
 long value)

Unsafe version of requestId.

nresult

public static void nresult(long struct,
 int value)

Unsafe version of result.