Package org.lwjgl.openxr

Class XrEventDataSpaceListSaveCompleteFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrEventDataSpaceListSaveCompleteFB>

org.lwjgl.openxr.XrEventDataSpaceListSaveCompleteFB

All Implemented Interfaces:

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

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

Describes the completion of a save list operation.

Description

This completion event indicates that a request to save a list of XrSpace objects has completed. The application can use result to check if the request was successful or if an error occurred.

Result Codes

On success, the value of this parameter is

• SUCCESS

On failure, the value of this parameter is

• ERROR_RUNTIME_FAILURE
• ERROR_SPACE_MAPPING_INSUFFICIENT_FB
• ERROR_SPACE_LOCALIZATION_FAILED_FB
• ERROR_SPACE_NETWORK_TIMEOUT_FB
• ERROR_SPACE_NETWORK_REQUEST_FAILED_FB
• ERROR_SPACE_CLOUD_STORAGE_DISABLED_FB

Valid Usage (Implicit)

• The XR_FB_spatial_entity_storage_batch extension must be enabled prior to using XrEventDataSpaceListSaveCompleteFB
• type must be TYPE_EVENT_DATA_SPACE_LIST_SAVE_COMPLETE_FB
• next must be NULL or a valid pointer to the next structure in a structure chain

Layout

 struct XrEventDataSpaceListSaveCompleteFB {
     XrStructureType type();
     void const * next();
     XrAsyncRequestIdFB requestId();
     XrResult result();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrEventDataSpaceListSaveCompleteFB	calloc()	Returns a new XrEventDataSpaceListSaveCompleteFB instance allocated with memCalloc.
static XrEventDataSpaceListSaveCompleteFB.Buffer	calloc(int capacity)	Returns a new XrEventDataSpaceListSaveCompleteFB.Buffer instance allocated with memCalloc.
static XrEventDataSpaceListSaveCompleteFB.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataSpaceListSaveCompleteFB.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrEventDataSpaceListSaveCompleteFB	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataSpaceListSaveCompleteFB instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrEventDataSpaceListSaveCompleteFB	create()	Returns a new XrEventDataSpaceListSaveCompleteFB instance allocated with BufferUtils.
static XrEventDataSpaceListSaveCompleteFB.Buffer	create(int capacity)	Returns a new XrEventDataSpaceListSaveCompleteFB.Buffer instance allocated with BufferUtils.
static XrEventDataSpaceListSaveCompleteFB	create(long address)	Returns a new XrEventDataSpaceListSaveCompleteFB instance for the specified memory address.
static XrEventDataSpaceListSaveCompleteFB.Buffer	create(long address, int capacity)	Create a XrEventDataSpaceListSaveCompleteFB.Buffer instance at the specified memory.
static XrEventDataSpaceListSaveCompleteFB	create(XrEventDataBaseHeader value)	Downcasts the specified XrEventDataBaseHeader instance to XrEventDataSpaceListSaveCompleteFB.
static XrEventDataSpaceListSaveCompleteFB.Buffer	create(XrEventDataBaseHeader.Buffer value)	Downcasts the specified XrEventDataBaseHeader.Buffer instance to XrEventDataSpaceListSaveCompleteFB.Buffer.
static @Nullable XrEventDataSpaceListSaveCompleteFB	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrEventDataSpaceListSaveCompleteFB.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrEventDataSpaceListSaveCompleteFB	malloc()	Returns a new XrEventDataSpaceListSaveCompleteFB instance allocated with memAlloc.
static XrEventDataSpaceListSaveCompleteFB.Buffer	malloc(int capacity)	Returns a new XrEventDataSpaceListSaveCompleteFB.Buffer instance allocated with memAlloc.
static XrEventDataSpaceListSaveCompleteFB.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataSpaceListSaveCompleteFB.Buffer instance allocated on the specified MemoryStack.
static XrEventDataSpaceListSaveCompleteFB	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataSpaceListSaveCompleteFB instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrEventDataSpaceListSaveCompleteFB	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 long	nrequestId(long struct)	Unsafe version of requestId().
static int	nresult(long struct)	Unsafe version of result().
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
long	requestId()	the ID of the asynchronous request to save an entity.
int	result()	an XrResult that describes whether the request succeeded or if an error occurred.
XrEventDataSpaceListSaveCompleteFB	set(int type, long next)	Initializes this struct with the specified values.
XrEventDataSpaceListSaveCompleteFB	set(XrEventDataSpaceListSaveCompleteFB src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrEventDataSpaceListSaveCompleteFB	type(int value)	Sets the specified value to the type() field.
XrEventDataSpaceListSaveCompleteFB	type$Default()	Sets the TYPE_EVENT_DATA_SPACE_LIST_SAVE_COMPLETE_FB 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.

REQUESTID

public static final int REQUESTID

The struct member offsets.

RESULT

public static final int RESULT

The struct member offsets.

Constructor Details

XrEventDataSpaceListSaveCompleteFB

public XrEventDataSpaceListSaveCompleteFB(ByteBuffer container)

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

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 or this extension.

requestId

public long requestId()

the ID of the asynchronous request to save an entity.

result

public int result()

an XrResult that describes whether the request succeeded or if an error occurred.

type

public XrEventDataSpaceListSaveCompleteFB type(int value)

Sets the specified value to the type() field.

type$Default

public XrEventDataSpaceListSaveCompleteFB type$Default()

Sets the TYPE_EVENT_DATA_SPACE_LIST_SAVE_COMPLETE_FB value to the type() field.

next

public XrEventDataSpaceListSaveCompleteFB next(long value)

Sets the specified value to the next() field.

set

public XrEventDataSpaceListSaveCompleteFB set(int type,
 long next)

Initializes this struct with the specified values.

set

public XrEventDataSpaceListSaveCompleteFB set(XrEventDataSpaceListSaveCompleteFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrEventDataSpaceListSaveCompleteFB malloc()

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

calloc

public static XrEventDataSpaceListSaveCompleteFB calloc()

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

create

public static XrEventDataSpaceListSaveCompleteFB create()

Returns a new XrEventDataSpaceListSaveCompleteFB instance allocated with BufferUtils.

create

public static XrEventDataSpaceListSaveCompleteFB create(long address)

Returns a new XrEventDataSpaceListSaveCompleteFB instance for the specified memory address.

createSafe

public static @Nullable XrEventDataSpaceListSaveCompleteFB createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrEventDataSpaceListSaveCompleteFB create(XrEventDataBaseHeader value)

Downcasts the specified XrEventDataBaseHeader instance to XrEventDataSpaceListSaveCompleteFB.

malloc

public static XrEventDataSpaceListSaveCompleteFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrEventDataSpaceListSaveCompleteFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrEventDataSpaceListSaveCompleteFB.Buffer create(int capacity)

Returns a new XrEventDataSpaceListSaveCompleteFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrEventDataSpaceListSaveCompleteFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

create

public static XrEventDataSpaceListSaveCompleteFB.Buffer create(XrEventDataBaseHeader.Buffer value)

Downcasts the specified XrEventDataBaseHeader.Buffer instance to XrEventDataSpaceListSaveCompleteFB.Buffer.

malloc

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

Returns a new XrEventDataSpaceListSaveCompleteFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nrequestId

public static long nrequestId(long struct)

Unsafe version of requestId().

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.