Package org.lwjgl.openxr

Class XrEventDataStartColocationAdvertisementCompleteMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrEventDataStartColocationAdvertisementCompleteMETA>

org.lwjgl.openxr.XrEventDataStartColocationAdvertisementCompleteMETA

All Implemented Interfaces:

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

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

Start colocation visibility 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 XrEventDataStartColocationAdvertisementCompleteMETA
• type must be TYPE_EVENT_DATA_START_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

XrColocationAdvertisementStartInfoMETA, XrUuid, StartColocationAdvertisementMETA

Layout

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
long	advertisementRequestId()	an XrAsyncRequestIdFB that identifies which request this event is in response to.
XrEventDataStartColocationAdvertisementCompleteMETA	advertisementRequestId(long value)	Sets the specified value to the advertisementRequestId() field.
XrUuid	advertisementUuid()	an XrUuid which is discoverable by other physically colocated devices running the same application.
XrEventDataStartColocationAdvertisementCompleteMETA	advertisementUuid(Consumer<XrUuid> consumer)	Passes the advertisementUuid() field to the specified Consumer.
XrEventDataStartColocationAdvertisementCompleteMETA	advertisementUuid(XrUuid value)	Copies the specified XrUuid to the advertisementUuid() field.
static XrEventDataStartColocationAdvertisementCompleteMETA	calloc()	Returns a new XrEventDataStartColocationAdvertisementCompleteMETA instance allocated with memCalloc.
static XrEventDataStartColocationAdvertisementCompleteMETA.Buffer	calloc(int capacity)	Returns a new XrEventDataStartColocationAdvertisementCompleteMETA.Buffer instance allocated with memCalloc.
static XrEventDataStartColocationAdvertisementCompleteMETA.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataStartColocationAdvertisementCompleteMETA.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrEventDataStartColocationAdvertisementCompleteMETA	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataStartColocationAdvertisementCompleteMETA instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrEventDataStartColocationAdvertisementCompleteMETA	create()	Returns a new XrEventDataStartColocationAdvertisementCompleteMETA instance allocated with BufferUtils.
static XrEventDataStartColocationAdvertisementCompleteMETA.Buffer	create(int capacity)	Returns a new XrEventDataStartColocationAdvertisementCompleteMETA.Buffer instance allocated with BufferUtils.
static XrEventDataStartColocationAdvertisementCompleteMETA	create(long address)	Returns a new XrEventDataStartColocationAdvertisementCompleteMETA instance for the specified memory address.
static XrEventDataStartColocationAdvertisementCompleteMETA.Buffer	create(long address, int capacity)	Create a XrEventDataStartColocationAdvertisementCompleteMETA.Buffer instance at the specified memory.
static @Nullable XrEventDataStartColocationAdvertisementCompleteMETA	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrEventDataStartColocationAdvertisementCompleteMETA.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrEventDataStartColocationAdvertisementCompleteMETA	malloc()	Returns a new XrEventDataStartColocationAdvertisementCompleteMETA instance allocated with memAlloc.
static XrEventDataStartColocationAdvertisementCompleteMETA.Buffer	malloc(int capacity)	Returns a new XrEventDataStartColocationAdvertisementCompleteMETA.Buffer instance allocated with memAlloc.
static XrEventDataStartColocationAdvertisementCompleteMETA.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataStartColocationAdvertisementCompleteMETA.Buffer instance allocated on the specified MemoryStack.
static XrEventDataStartColocationAdvertisementCompleteMETA	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataStartColocationAdvertisementCompleteMETA 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.
static XrUuid	nadvertisementUuid(long struct)	Unsafe version of advertisementUuid().
static void	nadvertisementUuid(long struct, XrUuid value)	Unsafe version of advertisementUuid.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrEventDataStartColocationAdvertisementCompleteMETA	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 that specifies the request result.
XrEventDataStartColocationAdvertisementCompleteMETA	result(int value)	Sets the specified value to the result() field.
XrEventDataStartColocationAdvertisementCompleteMETA	set(int type, long next, long advertisementRequestId, int result, XrUuid advertisementUuid)	Initializes this struct with the specified values.
XrEventDataStartColocationAdvertisementCompleteMETA	set(XrEventDataStartColocationAdvertisementCompleteMETA src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrEventDataStartColocationAdvertisementCompleteMETA	type(int value)	Sets the specified value to the type() field.
XrEventDataStartColocationAdvertisementCompleteMETA	type$Default()	Sets the TYPE_EVENT_DATA_START_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.

ADVERTISEMENTUUID

public static final int ADVERTISEMENTUUID

The struct member offsets.

Constructor Details

XrEventDataStartColocationAdvertisementCompleteMETA

public XrEventDataStartColocationAdvertisementCompleteMETA(ByteBuffer container)

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

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 that identifies which request this event is in response to. The runtime must ensure this value matches a advertisementRequestId returned during an StartColocationAdvertisementMETA call.

result

public int result()

an XrResult that specifies the request result. The valid result values are: SUCCESS, ERROR_RUNTIME_FAILURE, COLOCATION_DISCOVERY_ALREADY_ADVERTISING_META, ERROR_COLOCATION_DISCOVERY_NO_DISCOVERY_METHOD_META, and ERROR_COLOCATION_DISCOVERY_NETWORK_FAILED_META. If the application already has an active colocation advertisement, the runtime must return COLOCATION_DISCOVERY_ALREADY_ADVERTISING_META in this field.

advertisementUuid

public XrUuid advertisementUuid()

an XrUuid which is discoverable by other physically colocated devices running the same application. The runtime must return a unique XrUuid which has not been returned in a previous XrEventDataStartColocationAdvertisementCompleteMETA event, if result is SUCCESS.

type

public XrEventDataStartColocationAdvertisementCompleteMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrEventDataStartColocationAdvertisementCompleteMETA type$Default()

Sets the TYPE_EVENT_DATA_START_COLOCATION_ADVERTISEMENT_COMPLETE_META value to the type() field.

next

public XrEventDataStartColocationAdvertisementCompleteMETA next(long value)

Sets the specified value to the next() field.

advertisementRequestId

public XrEventDataStartColocationAdvertisementCompleteMETA advertisementRequestId(long value)

Sets the specified value to the advertisementRequestId() field.

result

public XrEventDataStartColocationAdvertisementCompleteMETA result(int value)

Sets the specified value to the result() field.

advertisementUuid

public XrEventDataStartColocationAdvertisementCompleteMETA advertisementUuid(XrUuid value)

Copies the specified XrUuid to the advertisementUuid() field.

advertisementUuid

public XrEventDataStartColocationAdvertisementCompleteMETA advertisementUuid(Consumer<XrUuid> consumer)

Passes the advertisementUuid() field to the specified Consumer.

set

public XrEventDataStartColocationAdvertisementCompleteMETA set(int type,
 long next,
 long advertisementRequestId,
 int result,
 XrUuid advertisementUuid)

Initializes this struct with the specified values.

set

public XrEventDataStartColocationAdvertisementCompleteMETA set(XrEventDataStartColocationAdvertisementCompleteMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrEventDataStartColocationAdvertisementCompleteMETA malloc()

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

calloc

public static XrEventDataStartColocationAdvertisementCompleteMETA calloc()

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

create

public static XrEventDataStartColocationAdvertisementCompleteMETA create()

Returns a new XrEventDataStartColocationAdvertisementCompleteMETA instance allocated with BufferUtils.

create

public static XrEventDataStartColocationAdvertisementCompleteMETA create(long address)

Returns a new XrEventDataStartColocationAdvertisementCompleteMETA instance for the specified memory address.

createSafe

public static @Nullable XrEventDataStartColocationAdvertisementCompleteMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrEventDataStartColocationAdvertisementCompleteMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrEventDataStartColocationAdvertisementCompleteMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrEventDataStartColocationAdvertisementCompleteMETA.Buffer create(int capacity)

Returns a new XrEventDataStartColocationAdvertisementCompleteMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrEventDataStartColocationAdvertisementCompleteMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrEventDataStartColocationAdvertisementCompleteMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nadvertisementUuid

public static XrUuid nadvertisementUuid(long struct)

Unsafe version of advertisementUuid().

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.

nadvertisementUuid

public static void nadvertisementUuid(long struct,
 XrUuid value)

Unsafe version of advertisementUuid.