Package org.lwjgl.openxr

Class XrEventDataColocationDiscoveryResultMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrEventDataColocationDiscoveryResultMETA>

org.lwjgl.openxr.XrEventDataColocationDiscoveryResultMETA

All Implemented Interfaces:

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

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

Colocation discovery result.

Description

advertisementUuid and buffer are both considered the payload of colocated advertisements. The value of advertisementUuid matches the value returned in XrEventDataStartColocationAdvertisementCompleteMETA::advertisementUuid on the advertising device.

Valid Usage (Implicit)

• The XR_META_colocation_discovery extension must be enabled prior to using XrEventDataColocationDiscoveryResultMETA
• type must be TYPE_EVENT_DATA_COLOCATION_DISCOVERY_RESULT_META
• next must be NULL or a valid pointer to the next structure in a structure chain
• Any given element of buffer must be a pointer to an array of bufferSize uint8_t values
• The bufferSize parameter must be greater than 0

See Also

XrUuid, StartColocationDiscoveryMETA

Layout

 struct XrEventDataColocationDiscoveryResultMETA {
     XrStructureType type();
     void const * next();
     XrAsyncRequestIdFB discoveryRequestId();
     XrUuid advertisementUuid();
     uint32_t bufferSize();
     uint8_t buffer()[XR_MAX_COLOCATION_DISCOVERY_BUFFER_SIZE_META];
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
XrUuid	advertisementUuid()	an XrUuid of the discovered colocated application.
XrEventDataColocationDiscoveryResultMETA	advertisementUuid(Consumer<XrUuid> consumer)	Passes the advertisementUuid() field to the specified Consumer.
XrEventDataColocationDiscoveryResultMETA	advertisementUuid(XrUuid value)	Copies the specified XrUuid to the advertisementUuid() field.
ByteBuffer	buffer()	a byte array which is the application may set when the application starts the advertisement.
byte	buffer(int index)	a byte array which is the application may set when the application starts the advertisement.
XrEventDataColocationDiscoveryResultMETA	buffer(int index, byte value)	Sets the specified value at the specified index of the buffer() field.
XrEventDataColocationDiscoveryResultMETA	buffer(ByteBuffer value)	Copies the specified ByteBuffer to the buffer() field.
int	bufferSize()	the count of bytes used in the buffer array.
static XrEventDataColocationDiscoveryResultMETA	calloc()	Returns a new XrEventDataColocationDiscoveryResultMETA instance allocated with memCalloc.
static XrEventDataColocationDiscoveryResultMETA.Buffer	calloc(int capacity)	Returns a new XrEventDataColocationDiscoveryResultMETA.Buffer instance allocated with memCalloc.
static XrEventDataColocationDiscoveryResultMETA.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataColocationDiscoveryResultMETA.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrEventDataColocationDiscoveryResultMETA	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataColocationDiscoveryResultMETA instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrEventDataColocationDiscoveryResultMETA	create()	Returns a new XrEventDataColocationDiscoveryResultMETA instance allocated with BufferUtils.
static XrEventDataColocationDiscoveryResultMETA.Buffer	create(int capacity)	Returns a new XrEventDataColocationDiscoveryResultMETA.Buffer instance allocated with BufferUtils.
static XrEventDataColocationDiscoveryResultMETA	create(long address)	Returns a new XrEventDataColocationDiscoveryResultMETA instance for the specified memory address.
static XrEventDataColocationDiscoveryResultMETA.Buffer	create(long address, int capacity)	Create a XrEventDataColocationDiscoveryResultMETA.Buffer instance at the specified memory.
static @Nullable XrEventDataColocationDiscoveryResultMETA	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrEventDataColocationDiscoveryResultMETA.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.
XrEventDataColocationDiscoveryResultMETA	discoveryRequestId(long value)	Sets the specified value to the discoveryRequestId() field.
static XrEventDataColocationDiscoveryResultMETA	malloc()	Returns a new XrEventDataColocationDiscoveryResultMETA instance allocated with memAlloc.
static XrEventDataColocationDiscoveryResultMETA.Buffer	malloc(int capacity)	Returns a new XrEventDataColocationDiscoveryResultMETA.Buffer instance allocated with memAlloc.
static XrEventDataColocationDiscoveryResultMETA.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataColocationDiscoveryResultMETA.Buffer instance allocated on the specified MemoryStack.
static XrEventDataColocationDiscoveryResultMETA	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataColocationDiscoveryResultMETA instance allocated on the specified MemoryStack.
static XrUuid	nadvertisementUuid(long struct)	Unsafe version of advertisementUuid().
static void	nadvertisementUuid(long struct, XrUuid value)	Unsafe version of advertisementUuid.
static ByteBuffer	nbuffer(long struct)	Unsafe version of buffer().
static byte	nbuffer(long struct, int index)	Unsafe version of buffer.
static void	nbuffer(long struct, int index, byte value)	Unsafe version of buffer.
static void	nbuffer(long struct, ByteBuffer value)	Unsafe version of buffer.
static int	nbufferSize(long struct)	Unsafe version of bufferSize().
static void	nbufferSize(long struct, int value)	Sets the specified value to the bufferSize field of the specified struct.
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.
XrEventDataColocationDiscoveryResultMETA	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	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrEventDataColocationDiscoveryResultMETA	set(int type, long next, long discoveryRequestId, XrUuid advertisementUuid, ByteBuffer buffer)	Initializes this struct with the specified values.
XrEventDataColocationDiscoveryResultMETA	set(XrEventDataColocationDiscoveryResultMETA src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrEventDataColocationDiscoveryResultMETA	type(int value)	Sets the specified value to the type() field.
XrEventDataColocationDiscoveryResultMETA	type$Default()	Sets the TYPE_EVENT_DATA_COLOCATION_DISCOVERY_RESULT_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.

ADVERTISEMENTUUID

public static final int ADVERTISEMENTUUID

The struct member offsets.

BUFFERSIZE

public static final int BUFFERSIZE

The struct member offsets.

BUFFER

public static final int BUFFER

The struct member offsets.

Constructor Details

XrEventDataColocationDiscoveryResultMETA

public XrEventDataColocationDiscoveryResultMETA(ByteBuffer container)

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

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.

advertisementUuid

public XrUuid advertisementUuid()

an XrUuid of the discovered colocated application.

bufferSize

public int bufferSize()

the count of bytes used in the buffer array.

buffer

public ByteBuffer buffer()

a byte array which is the application may set when the application starts the advertisement.

buffer

public byte buffer(int index)

a byte array which is the application may set when the application starts the advertisement.

type

public XrEventDataColocationDiscoveryResultMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrEventDataColocationDiscoveryResultMETA type$Default()

Sets the TYPE_EVENT_DATA_COLOCATION_DISCOVERY_RESULT_META value to the type() field.

next

public XrEventDataColocationDiscoveryResultMETA next(long value)

Sets the specified value to the next() field.

discoveryRequestId

public XrEventDataColocationDiscoveryResultMETA discoveryRequestId(long value)

Sets the specified value to the discoveryRequestId() field.

advertisementUuid

public XrEventDataColocationDiscoveryResultMETA advertisementUuid(XrUuid value)

Copies the specified XrUuid to the advertisementUuid() field.

advertisementUuid

public XrEventDataColocationDiscoveryResultMETA advertisementUuid(Consumer<XrUuid> consumer)

Passes the advertisementUuid() field to the specified Consumer.

buffer

public XrEventDataColocationDiscoveryResultMETA buffer(ByteBuffer value)

Copies the specified ByteBuffer to the buffer() field.

buffer

public XrEventDataColocationDiscoveryResultMETA buffer(int index,
 byte value)

Sets the specified value at the specified index of the buffer() field.

set

public XrEventDataColocationDiscoveryResultMETA set(int type,
 long next,
 long discoveryRequestId,
 XrUuid advertisementUuid,
 ByteBuffer buffer)

Initializes this struct with the specified values.

set

public XrEventDataColocationDiscoveryResultMETA set(XrEventDataColocationDiscoveryResultMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrEventDataColocationDiscoveryResultMETA malloc()

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

calloc

public static XrEventDataColocationDiscoveryResultMETA calloc()

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

create

public static XrEventDataColocationDiscoveryResultMETA create()

Returns a new XrEventDataColocationDiscoveryResultMETA instance allocated with BufferUtils.

create

public static XrEventDataColocationDiscoveryResultMETA create(long address)

Returns a new XrEventDataColocationDiscoveryResultMETA instance for the specified memory address.

createSafe

public static @Nullable XrEventDataColocationDiscoveryResultMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrEventDataColocationDiscoveryResultMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrEventDataColocationDiscoveryResultMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrEventDataColocationDiscoveryResultMETA.Buffer create(int capacity)

Returns a new XrEventDataColocationDiscoveryResultMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrEventDataColocationDiscoveryResultMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrEventDataColocationDiscoveryResultMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nadvertisementUuid

public static XrUuid nadvertisementUuid(long struct)

Unsafe version of advertisementUuid().

nbufferSize

public static int nbufferSize(long struct)

Unsafe version of bufferSize().

nbuffer

public static ByteBuffer nbuffer(long struct)

Unsafe version of buffer().

nbuffer

public static byte nbuffer(long struct,
 int index)

Unsafe version of buffer.

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.

nadvertisementUuid

public static void nadvertisementUuid(long struct,
 XrUuid value)

Unsafe version of advertisementUuid.

nbufferSize

public static void nbufferSize(long struct,
 int value)

Sets the specified value to the bufferSize field of the specified struct.

nbuffer

public static void nbuffer(long struct,
 ByteBuffer value)

Unsafe version of buffer.

nbuffer

public static void nbuffer(long struct,
 int index,
 byte value)

Unsafe version of buffer.