Package org.lwjgl.openxr

Class XrFutureCompletionBaseHeaderEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrFutureCompletionBaseHeaderEXT>

org.lwjgl.openxr.XrFutureCompletionBaseHeaderEXT

All Implemented Interfaces:

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

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

Base header for the result of an a future, returned by a future completion function.

Description

XrFutureCompletionBaseHeaderEXT is a base header for the result of a future completion function.

Valid Usage (Implicit)

• The XR_EXT_future extension must be enabled prior to using XrFutureCompletionBaseHeaderEXT
• type must be one of the following XrStructureType values: TYPE_CREATE_SPATIAL_ANCHORS_COMPLETION_ML, TYPE_FUTURE_COMPLETION_EXT, TYPE_SPATIAL_ANCHORS_DELETE_COMPLETION_ML, TYPE_SPATIAL_ANCHORS_PUBLISH_COMPLETION_ML, TYPE_SPATIAL_ANCHORS_QUERY_COMPLETION_ML, TYPE_SPATIAL_ANCHORS_UPDATE_EXPIRATION_COMPLETION_ML, TYPE_WORLD_MESH_REQUEST_COMPLETION_ML, TYPE_WORLD_MESH_STATE_REQUEST_COMPLETION_ML
• next must be NULL or a valid pointer to the next structure in a structure chain
• futureResult must be a valid XrResult value

Layout

 struct XrFutureCompletionBaseHeaderEXT {
     XrStructureType type();
     void * next();
     XrResult futureResult();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrFutureCompletionBaseHeaderEXT	calloc()	Returns a new XrFutureCompletionBaseHeaderEXT instance allocated with memCalloc.
static XrFutureCompletionBaseHeaderEXT.Buffer	calloc(int capacity)	Returns a new XrFutureCompletionBaseHeaderEXT.Buffer instance allocated with memCalloc.
static XrFutureCompletionBaseHeaderEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrFutureCompletionBaseHeaderEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrFutureCompletionBaseHeaderEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrFutureCompletionBaseHeaderEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrFutureCompletionBaseHeaderEXT	create()	Returns a new XrFutureCompletionBaseHeaderEXT instance allocated with BufferUtils.
static XrFutureCompletionBaseHeaderEXT.Buffer	create(int capacity)	Returns a new XrFutureCompletionBaseHeaderEXT.Buffer instance allocated with BufferUtils.
static XrFutureCompletionBaseHeaderEXT	create(long address)	Returns a new XrFutureCompletionBaseHeaderEXT instance for the specified memory address.
static XrFutureCompletionBaseHeaderEXT.Buffer	create(long address, int capacity)	Create a XrFutureCompletionBaseHeaderEXT.Buffer instance at the specified memory.
static XrFutureCompletionBaseHeaderEXT	create(XrCreateSpatialAnchorsCompletionML value)	Upcasts the specified XrCreateSpatialAnchorsCompletionML instance to XrFutureCompletionBaseHeaderEXT.
static XrFutureCompletionBaseHeaderEXT.Buffer	create(XrCreateSpatialAnchorsCompletionML.Buffer value)	Upcasts the specified XrCreateSpatialAnchorsCompletionML.Buffer instance to XrFutureCompletionBaseHeaderEXT.Buffer.
static XrFutureCompletionBaseHeaderEXT	create(XrFutureCompletionEXT value)	Upcasts the specified XrFutureCompletionEXT instance to XrFutureCompletionBaseHeaderEXT.
static XrFutureCompletionBaseHeaderEXT.Buffer	create(XrFutureCompletionEXT.Buffer value)	Upcasts the specified XrFutureCompletionEXT.Buffer instance to XrFutureCompletionBaseHeaderEXT.Buffer.
static XrFutureCompletionBaseHeaderEXT	create(XrSpatialAnchorsDeleteCompletionML value)	Upcasts the specified XrSpatialAnchorsDeleteCompletionML instance to XrFutureCompletionBaseHeaderEXT.
static XrFutureCompletionBaseHeaderEXT.Buffer	create(XrSpatialAnchorsDeleteCompletionML.Buffer value)	Upcasts the specified XrSpatialAnchorsDeleteCompletionML.Buffer instance to XrFutureCompletionBaseHeaderEXT.Buffer.
static XrFutureCompletionBaseHeaderEXT	create(XrSpatialAnchorsPublishCompletionML value)	Upcasts the specified XrSpatialAnchorsPublishCompletionML instance to XrFutureCompletionBaseHeaderEXT.
static XrFutureCompletionBaseHeaderEXT.Buffer	create(XrSpatialAnchorsPublishCompletionML.Buffer value)	Upcasts the specified XrSpatialAnchorsPublishCompletionML.Buffer instance to XrFutureCompletionBaseHeaderEXT.Buffer.
static XrFutureCompletionBaseHeaderEXT	create(XrSpatialAnchorsQueryCompletionML value)	Upcasts the specified XrSpatialAnchorsQueryCompletionML instance to XrFutureCompletionBaseHeaderEXT.
static XrFutureCompletionBaseHeaderEXT.Buffer	create(XrSpatialAnchorsQueryCompletionML.Buffer value)	Upcasts the specified XrSpatialAnchorsQueryCompletionML.Buffer instance to XrFutureCompletionBaseHeaderEXT.Buffer.
static XrFutureCompletionBaseHeaderEXT	create(XrSpatialAnchorsUpdateExpirationCompletionML value)	Upcasts the specified XrSpatialAnchorsUpdateExpirationCompletionML instance to XrFutureCompletionBaseHeaderEXT.
static XrFutureCompletionBaseHeaderEXT.Buffer	create(XrSpatialAnchorsUpdateExpirationCompletionML.Buffer value)	Upcasts the specified XrSpatialAnchorsUpdateExpirationCompletionML.Buffer instance to XrFutureCompletionBaseHeaderEXT.Buffer.
static XrFutureCompletionBaseHeaderEXT	create(XrWorldMeshRequestCompletionML value)	Upcasts the specified XrWorldMeshRequestCompletionML instance to XrFutureCompletionBaseHeaderEXT.
static XrFutureCompletionBaseHeaderEXT.Buffer	create(XrWorldMeshRequestCompletionML.Buffer value)	Upcasts the specified XrWorldMeshRequestCompletionML.Buffer instance to XrFutureCompletionBaseHeaderEXT.Buffer.
static XrFutureCompletionBaseHeaderEXT	create(XrWorldMeshStateRequestCompletionML value)	Upcasts the specified XrWorldMeshStateRequestCompletionML instance to XrFutureCompletionBaseHeaderEXT.
static XrFutureCompletionBaseHeaderEXT.Buffer	create(XrWorldMeshStateRequestCompletionML.Buffer value)	Upcasts the specified XrWorldMeshStateRequestCompletionML.Buffer instance to XrFutureCompletionBaseHeaderEXT.Buffer.
static @Nullable XrFutureCompletionBaseHeaderEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrFutureCompletionBaseHeaderEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	futureResult()	XrResult of the async operation associated with future passed to the completion function.
XrFutureCompletionBaseHeaderEXT	futureResult(int value)	Sets the specified value to the futureResult() field.
static XrFutureCompletionBaseHeaderEXT	malloc()	Returns a new XrFutureCompletionBaseHeaderEXT instance allocated with memAlloc.
static XrFutureCompletionBaseHeaderEXT.Buffer	malloc(int capacity)	Returns a new XrFutureCompletionBaseHeaderEXT.Buffer instance allocated with memAlloc.
static XrFutureCompletionBaseHeaderEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrFutureCompletionBaseHeaderEXT.Buffer instance allocated on the specified MemoryStack.
static XrFutureCompletionBaseHeaderEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrFutureCompletionBaseHeaderEXT instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrFutureCompletionBaseHeaderEXT	next(long value)	Sets the specified value to the next() field.
static int	nfutureResult(long struct)	Unsafe version of futureResult().
static void	nfutureResult(long struct, int value)	Unsafe version of futureResult.
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.
XrFutureCompletionBaseHeaderEXT	set(int type, long next, int futureResult)	Initializes this struct with the specified values.
XrFutureCompletionBaseHeaderEXT	set(XrFutureCompletionBaseHeaderEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrFutureCompletionBaseHeaderEXT	type(int value)	Sets the specified 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.

FUTURERESULT

public static final int FUTURERESULT

The struct member offsets.

Constructor Details

XrFutureCompletionBaseHeaderEXT

public XrFutureCompletionBaseHeaderEXT(ByteBuffer container)

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

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.

futureResult

public int futureResult()

XrResult of the async operation associated with future passed to the completion function.

type

public XrFutureCompletionBaseHeaderEXT type(int value)

Sets the specified value to the type() field.

next

public XrFutureCompletionBaseHeaderEXT next(long value)

Sets the specified value to the next() field.

futureResult

public XrFutureCompletionBaseHeaderEXT futureResult(int value)

Sets the specified value to the futureResult() field.

set

public XrFutureCompletionBaseHeaderEXT set(int type,
 long next,
 int futureResult)

Initializes this struct with the specified values.

set

public XrFutureCompletionBaseHeaderEXT set(XrFutureCompletionBaseHeaderEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrFutureCompletionBaseHeaderEXT malloc()

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

calloc

public static XrFutureCompletionBaseHeaderEXT calloc()

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

create

public static XrFutureCompletionBaseHeaderEXT create()

Returns a new XrFutureCompletionBaseHeaderEXT instance allocated with BufferUtils.

create

public static XrFutureCompletionBaseHeaderEXT create(long address)

Returns a new XrFutureCompletionBaseHeaderEXT instance for the specified memory address.

createSafe

public static @Nullable XrFutureCompletionBaseHeaderEXT createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrFutureCompletionBaseHeaderEXT create(XrCreateSpatialAnchorsCompletionML value)

Upcasts the specified XrCreateSpatialAnchorsCompletionML instance to XrFutureCompletionBaseHeaderEXT.

create

public static XrFutureCompletionBaseHeaderEXT create(XrSpatialAnchorsQueryCompletionML value)

Upcasts the specified XrSpatialAnchorsQueryCompletionML instance to XrFutureCompletionBaseHeaderEXT.

create

public static XrFutureCompletionBaseHeaderEXT create(XrSpatialAnchorsPublishCompletionML value)

Upcasts the specified XrSpatialAnchorsPublishCompletionML instance to XrFutureCompletionBaseHeaderEXT.

create

public static XrFutureCompletionBaseHeaderEXT create(XrSpatialAnchorsDeleteCompletionML value)

Upcasts the specified XrSpatialAnchorsDeleteCompletionML instance to XrFutureCompletionBaseHeaderEXT.

create

public static XrFutureCompletionBaseHeaderEXT create(XrSpatialAnchorsUpdateExpirationCompletionML value)

Upcasts the specified XrSpatialAnchorsUpdateExpirationCompletionML instance to XrFutureCompletionBaseHeaderEXT.

create

public static XrFutureCompletionBaseHeaderEXT create(XrFutureCompletionEXT value)

Upcasts the specified XrFutureCompletionEXT instance to XrFutureCompletionBaseHeaderEXT.

create

public static XrFutureCompletionBaseHeaderEXT create(XrWorldMeshStateRequestCompletionML value)

Upcasts the specified XrWorldMeshStateRequestCompletionML instance to XrFutureCompletionBaseHeaderEXT.

create

public static XrFutureCompletionBaseHeaderEXT create(XrWorldMeshRequestCompletionML value)

Upcasts the specified XrWorldMeshRequestCompletionML instance to XrFutureCompletionBaseHeaderEXT.

malloc

public static XrFutureCompletionBaseHeaderEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrFutureCompletionBaseHeaderEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrFutureCompletionBaseHeaderEXT.Buffer create(int capacity)

Returns a new XrFutureCompletionBaseHeaderEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrFutureCompletionBaseHeaderEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

create

public static XrFutureCompletionBaseHeaderEXT.Buffer create(XrCreateSpatialAnchorsCompletionML.Buffer value)

Upcasts the specified XrCreateSpatialAnchorsCompletionML.Buffer instance to XrFutureCompletionBaseHeaderEXT.Buffer.

create

public static XrFutureCompletionBaseHeaderEXT.Buffer create(XrSpatialAnchorsQueryCompletionML.Buffer value)

Upcasts the specified XrSpatialAnchorsQueryCompletionML.Buffer instance to XrFutureCompletionBaseHeaderEXT.Buffer.

create

public static XrFutureCompletionBaseHeaderEXT.Buffer create(XrSpatialAnchorsPublishCompletionML.Buffer value)

Upcasts the specified XrSpatialAnchorsPublishCompletionML.Buffer instance to XrFutureCompletionBaseHeaderEXT.Buffer.

create

public static XrFutureCompletionBaseHeaderEXT.Buffer create(XrSpatialAnchorsDeleteCompletionML.Buffer value)

Upcasts the specified XrSpatialAnchorsDeleteCompletionML.Buffer instance to XrFutureCompletionBaseHeaderEXT.Buffer.

create

public static XrFutureCompletionBaseHeaderEXT.Buffer create(XrSpatialAnchorsUpdateExpirationCompletionML.Buffer value)

Upcasts the specified XrSpatialAnchorsUpdateExpirationCompletionML.Buffer instance to XrFutureCompletionBaseHeaderEXT.Buffer.

create

public static XrFutureCompletionBaseHeaderEXT.Buffer create(XrFutureCompletionEXT.Buffer value)

Upcasts the specified XrFutureCompletionEXT.Buffer instance to XrFutureCompletionBaseHeaderEXT.Buffer.

create

public static XrFutureCompletionBaseHeaderEXT.Buffer create(XrWorldMeshStateRequestCompletionML.Buffer value)

Upcasts the specified XrWorldMeshStateRequestCompletionML.Buffer instance to XrFutureCompletionBaseHeaderEXT.Buffer.

create

public static XrFutureCompletionBaseHeaderEXT.Buffer create(XrWorldMeshRequestCompletionML.Buffer value)

Upcasts the specified XrWorldMeshRequestCompletionML.Buffer instance to XrFutureCompletionBaseHeaderEXT.Buffer.

malloc

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

Returns a new XrFutureCompletionBaseHeaderEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nfutureResult

public static int nfutureResult(long struct)

Unsafe version of futureResult().

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.

nfutureResult

public static void nfutureResult(long struct,
 int value)

Unsafe version of futureResult.