Package org.lwjgl.openxr

Class XrColocationAdvertisementStartInfoMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrColocationAdvertisementStartInfoMETA>

org.lwjgl.openxr.XrColocationAdvertisementStartInfoMETA

All Implemented Interfaces:

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

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

Information about start colocation visibility request.

Description

XrColocationAdvertisementStartInfoMETA is the input data for StartColocationAdvertisementMETA. Implicitly, while the application has an active advertisement, the runtime will retain a copy of the XrColocationAdvertisementStartInfoMETA submitted with StartColocationAdvertisementMETA.

Valid Usage (Implicit)

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

See Also

StartColocationAdvertisementMETA

Layout

 struct XrColocationAdvertisementStartInfoMETA {
     XrStructureType type();
     void const * next();
     uint32_t bufferSize();
     uint8_t * buffer();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
ByteBuffer	buffer()	a byte array which allows the application to define app buffer.
XrColocationAdvertisementStartInfoMETA	buffer(ByteBuffer value)	Sets the address of the specified ByteBuffer to the buffer() field.
int	bufferSize()	the count of bytes used in the buffer array.
static XrColocationAdvertisementStartInfoMETA	calloc()	Returns a new XrColocationAdvertisementStartInfoMETA instance allocated with memCalloc.
static XrColocationAdvertisementStartInfoMETA.Buffer	calloc(int capacity)	Returns a new XrColocationAdvertisementStartInfoMETA.Buffer instance allocated with memCalloc.
static XrColocationAdvertisementStartInfoMETA.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrColocationAdvertisementStartInfoMETA.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrColocationAdvertisementStartInfoMETA	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrColocationAdvertisementStartInfoMETA instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrColocationAdvertisementStartInfoMETA	create()	Returns a new XrColocationAdvertisementStartInfoMETA instance allocated with BufferUtils.
static XrColocationAdvertisementStartInfoMETA.Buffer	create(int capacity)	Returns a new XrColocationAdvertisementStartInfoMETA.Buffer instance allocated with BufferUtils.
static XrColocationAdvertisementStartInfoMETA	create(long address)	Returns a new XrColocationAdvertisementStartInfoMETA instance for the specified memory address.
static XrColocationAdvertisementStartInfoMETA.Buffer	create(long address, int capacity)	Create a XrColocationAdvertisementStartInfoMETA.Buffer instance at the specified memory.
static @Nullable XrColocationAdvertisementStartInfoMETA	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrColocationAdvertisementStartInfoMETA.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrColocationAdvertisementStartInfoMETA	malloc()	Returns a new XrColocationAdvertisementStartInfoMETA instance allocated with memAlloc.
static XrColocationAdvertisementStartInfoMETA.Buffer	malloc(int capacity)	Returns a new XrColocationAdvertisementStartInfoMETA.Buffer instance allocated with memAlloc.
static XrColocationAdvertisementStartInfoMETA.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrColocationAdvertisementStartInfoMETA.Buffer instance allocated on the specified MemoryStack.
static XrColocationAdvertisementStartInfoMETA	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrColocationAdvertisementStartInfoMETA instance allocated on the specified MemoryStack.
static ByteBuffer	nbuffer(long struct)	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.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrColocationAdvertisementStartInfoMETA	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.
XrColocationAdvertisementStartInfoMETA	set(int type, long next, ByteBuffer buffer)	Initializes this struct with the specified values.
XrColocationAdvertisementStartInfoMETA	set(XrColocationAdvertisementStartInfoMETA src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrColocationAdvertisementStartInfoMETA	type(int value)	Sets the specified value to the type() field.
XrColocationAdvertisementStartInfoMETA	type$Default()	Sets the TYPE_COLOCATION_ADVERTISEMENT_START_INFO_META value to the type() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

BUFFERSIZE

public static final int BUFFERSIZE

The struct member offsets.

BUFFER

public static final int BUFFER

The struct member offsets.

Constructor Details

XrColocationAdvertisementStartInfoMETA

public XrColocationAdvertisementStartInfoMETA(ByteBuffer container)

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

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.

bufferSize

public int bufferSize()

the count of bytes used in the buffer array. If bufferSize is greater than MAX_COLOCATION_DISCOVERY_BUFFER_SIZE_META, then the runtime must return ERROR_VALIDATION_FAILURE. The maximum supported count is MAX_COLOCATION_DISCOVERY_BUFFER_SIZE_META.

buffer

public ByteBuffer buffer()

a byte array which allows the application to define app buffer. It is the advertisement payload.

type

public XrColocationAdvertisementStartInfoMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrColocationAdvertisementStartInfoMETA type$Default()

Sets the TYPE_COLOCATION_ADVERTISEMENT_START_INFO_META value to the type() field.

next

public XrColocationAdvertisementStartInfoMETA next(long value)

Sets the specified value to the next() field.

buffer

public XrColocationAdvertisementStartInfoMETA buffer(ByteBuffer value)

Sets the address of the specified ByteBuffer to the buffer() field.

set

public XrColocationAdvertisementStartInfoMETA set(int type,
 long next,
 ByteBuffer buffer)

Initializes this struct with the specified values.

set

public XrColocationAdvertisementStartInfoMETA set(XrColocationAdvertisementStartInfoMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrColocationAdvertisementStartInfoMETA malloc()

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

calloc

public static XrColocationAdvertisementStartInfoMETA calloc()

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

create

public static XrColocationAdvertisementStartInfoMETA create()

Returns a new XrColocationAdvertisementStartInfoMETA instance allocated with BufferUtils.

create

public static XrColocationAdvertisementStartInfoMETA create(long address)

Returns a new XrColocationAdvertisementStartInfoMETA instance for the specified memory address.

createSafe

public static @Nullable XrColocationAdvertisementStartInfoMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrColocationAdvertisementStartInfoMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrColocationAdvertisementStartInfoMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrColocationAdvertisementStartInfoMETA.Buffer create(int capacity)

Returns a new XrColocationAdvertisementStartInfoMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrColocationAdvertisementStartInfoMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrColocationAdvertisementStartInfoMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nbufferSize

public static int nbufferSize(long struct)

Unsafe version of bufferSize().

nbuffer

public static ByteBuffer nbuffer(long struct)

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.

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.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate