Package org.lwjgl.openxr

Class XrEventDataColocationAdvertisementCompleteMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrEventDataColocationAdvertisementCompleteMETA>

org.lwjgl.openxr.XrEventDataColocationAdvertisementCompleteMETA

All Implemented Interfaces:

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

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

advertisement complete event.

Description

The runtime must queue exactly one XrEventDataColocationAdvertisementCompleteMETA event whenever an active colocation advertisement is stopped. This includes if the colocation advertisement is stopped due to an application calling StopColocationAdvertisementMETA, or the runtime needs to stop the colocation advertisement for any reason. If the colocation advertisement is stopped due to an application calling StopColocationAdvertisementMETA, the runtime must queue the XrEventDataColocationAdvertisementCompleteMETA event before queuing the corresponding XrEventDataStopColocationAdvertisementCompleteMETA event. 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 XrEventDataColocationAdvertisementCompleteMETA
• type must be TYPE_EVENT_DATA_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

StartColocationAdvertisementMETA, StopColocationAdvertisementMETA

Layout

 struct XrEventDataColocationAdvertisementCompleteMETA {
     XrStructureType type();
     void const * next();
     XrAsyncRequestIdFB advertisementRequestId();
     XrResult result();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrEventDataColocationAdvertisementCompleteMETA.Buffer	An array of XrEventDataColocationAdvertisementCompleteMETA 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	ADVERTISEMENTREQUESTID	The struct member offsets.
static final int	ALIGNOF	The struct alignment in bytes.
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
XrEventDataColocationAdvertisementCompleteMETA(ByteBuffer container)	Creates a XrEventDataColocationAdvertisementCompleteMETA instance at the current position of the specified ByteBuffer container.

Method Summary

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

ADVERTISEMENTREQUESTID

public static final int ADVERTISEMENTREQUESTID

The struct member offsets.

RESULT

public static final int RESULT

The struct member offsets.

Constructor Details

XrEventDataColocationAdvertisementCompleteMETA

public XrEventDataColocationAdvertisementCompleteMETA(ByteBuffer container)

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

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.

advertisementRequestId

public long advertisementRequestId()

an XrAsyncRequestIdFB specifying the original start advertisement async request id. The runtime must return a value which matches a previously returned advertisementRequestId value from an StartColocationAdvertisementMETA request.

result

public int result()

an XrResult representing the advertisement process result. The valid result values are: SUCCESS, ERROR_RUNTIME_FAILURE, and ERROR_COLOCATION_DISCOVERY_NO_DISCOVERY_METHOD_META.

type

public XrEventDataColocationAdvertisementCompleteMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrEventDataColocationAdvertisementCompleteMETA type$Default()

Sets the TYPE_EVENT_DATA_COLOCATION_ADVERTISEMENT_COMPLETE_META value to the type() field.

next

public XrEventDataColocationAdvertisementCompleteMETA next(long value)

Sets the specified value to the next() field.

advertisementRequestId

public XrEventDataColocationAdvertisementCompleteMETA advertisementRequestId(long value)

Sets the specified value to the advertisementRequestId() field.

result

public XrEventDataColocationAdvertisementCompleteMETA result(int value)

Sets the specified value to the result() field.

set

public XrEventDataColocationAdvertisementCompleteMETA set(int type,
 long next,
 long advertisementRequestId,
 int result)

Initializes this struct with the specified values.

set

public XrEventDataColocationAdvertisementCompleteMETA set(XrEventDataColocationAdvertisementCompleteMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrEventDataColocationAdvertisementCompleteMETA malloc()

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

calloc

public static XrEventDataColocationAdvertisementCompleteMETA calloc()

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

create

public static XrEventDataColocationAdvertisementCompleteMETA create()

Returns a new XrEventDataColocationAdvertisementCompleteMETA instance allocated with BufferUtils.

create

public static XrEventDataColocationAdvertisementCompleteMETA create(long address)

Returns a new XrEventDataColocationAdvertisementCompleteMETA instance for the specified memory address.

createSafe

public static @Nullable XrEventDataColocationAdvertisementCompleteMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrEventDataColocationAdvertisementCompleteMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrEventDataColocationAdvertisementCompleteMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrEventDataColocationAdvertisementCompleteMETA.Buffer create(int capacity)

Returns a new XrEventDataColocationAdvertisementCompleteMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrEventDataColocationAdvertisementCompleteMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrEventDataColocationAdvertisementCompleteMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nadvertisementRequestId

public static long nadvertisementRequestId(long struct)

Unsafe version of advertisementRequestId().

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.

nadvertisementRequestId

public static void nadvertisementRequestId(long struct,
 long value)

Unsafe version of advertisementRequestId.

nresult

public static void nresult(long struct,
 int value)

Unsafe version of result.