Package org.lwjgl.openxr

Class XrEventDataStopColocationAdvertisementCompleteMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrEventDataStopColocationAdvertisementCompleteMETA>

org.lwjgl.openxr.XrEventDataStopColocationAdvertisementCompleteMETA

All Implemented Interfaces:

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

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

Stop colocation advertisement complete event.

Description

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

Valid Usage (Implicit)

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

XrColocationAdvertisementStopInfoMETA

Layout

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

Nested Class Summary

Nested Classes

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

Method Summary

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

XrEventDataStopColocationAdvertisementCompleteMETA

public XrEventDataStopColocationAdvertisementCompleteMETA(ByteBuffer container)

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

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 StopColocationAdvertisementMETA call.

result

public int result()

an XrResult that specifies the request result. The valid result values are: SUCCESS, ERROR_RUNTIME_FAILURE, and ERROR_COLOCATION_DISCOVERY_NETWORK_FAILED_META. If the application does not already have an active colocation advertisement, the runtime must return SUCCESS.

type

public XrEventDataStopColocationAdvertisementCompleteMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrEventDataStopColocationAdvertisementCompleteMETA type$Default()

Sets the TYPE_EVENT_DATA_STOP_COLOCATION_ADVERTISEMENT_COMPLETE_META value to the type() field.

next

public XrEventDataStopColocationAdvertisementCompleteMETA next(long value)

Sets the specified value to the next() field.

requestId

public XrEventDataStopColocationAdvertisementCompleteMETA requestId(long value)

Sets the specified value to the requestId() field.

result

public XrEventDataStopColocationAdvertisementCompleteMETA result(int value)

Sets the specified value to the result() field.

set

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

Initializes this struct with the specified values.

set

public XrEventDataStopColocationAdvertisementCompleteMETA set(XrEventDataStopColocationAdvertisementCompleteMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrEventDataStopColocationAdvertisementCompleteMETA malloc()

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

calloc

public static XrEventDataStopColocationAdvertisementCompleteMETA calloc()

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

create

public static XrEventDataStopColocationAdvertisementCompleteMETA create()

Returns a new XrEventDataStopColocationAdvertisementCompleteMETA instance allocated with BufferUtils.

create

public static XrEventDataStopColocationAdvertisementCompleteMETA create(long address)

Returns a new XrEventDataStopColocationAdvertisementCompleteMETA instance for the specified memory address.

createSafe

public static @Nullable XrEventDataStopColocationAdvertisementCompleteMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrEventDataStopColocationAdvertisementCompleteMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrEventDataStopColocationAdvertisementCompleteMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrEventDataStopColocationAdvertisementCompleteMETA.Buffer create(int capacity)

Returns a new XrEventDataStopColocationAdvertisementCompleteMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrEventDataStopColocationAdvertisementCompleteMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrEventDataStopColocationAdvertisementCompleteMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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