Package org.lwjgl.openxr

Class XrEventDataSpaceShareCompleteFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrEventDataSpaceShareCompleteFB>

org.lwjgl.openxr.XrEventDataSpaceShareCompleteFB

All Implemented Interfaces:

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

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

Completion of request to share one or more spatial entities.

Description

It indicates that the request to share one or more spatial entities 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_sharing extension must be enabled prior to using XrEventDataSpaceShareCompleteFB
• type must be TYPE_EVENT_DATA_SPACE_SHARE_COMPLETE_FB
• next must be NULL or a valid pointer to the next structure in a structure chain

Layout

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

Nested Class Summary

Nested Classes

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

Method Summary

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

XrEventDataSpaceShareCompleteFB

public XrEventDataSpaceShareCompleteFB(ByteBuffer container)

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

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 used to share the spatial entities.

result

public int result()

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

type

public XrEventDataSpaceShareCompleteFB type(int value)

Sets the specified value to the type() field.

type$Default

public XrEventDataSpaceShareCompleteFB type$Default()

Sets the TYPE_EVENT_DATA_SPACE_SHARE_COMPLETE_FB value to the type() field.

next

public XrEventDataSpaceShareCompleteFB next(long value)

Sets the specified value to the next() field.

set

public XrEventDataSpaceShareCompleteFB set(int type,
 long next)

Initializes this struct with the specified values.

set

public XrEventDataSpaceShareCompleteFB set(XrEventDataSpaceShareCompleteFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrEventDataSpaceShareCompleteFB malloc()

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

calloc

public static XrEventDataSpaceShareCompleteFB calloc()

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

create

public static XrEventDataSpaceShareCompleteFB create()

Returns a new XrEventDataSpaceShareCompleteFB instance allocated with BufferUtils.

create

public static XrEventDataSpaceShareCompleteFB create(long address)

Returns a new XrEventDataSpaceShareCompleteFB instance for the specified memory address.

createSafe

public static @Nullable XrEventDataSpaceShareCompleteFB createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrEventDataSpaceShareCompleteFB create(XrEventDataBaseHeader value)

Downcasts the specified XrEventDataBaseHeader instance to XrEventDataSpaceShareCompleteFB.

malloc

public static XrEventDataSpaceShareCompleteFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrEventDataSpaceShareCompleteFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrEventDataSpaceShareCompleteFB.Buffer create(int capacity)

Returns a new XrEventDataSpaceShareCompleteFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrEventDataSpaceShareCompleteFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

create

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

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

malloc

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

Returns a new XrEventDataSpaceShareCompleteFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new XrEventDataSpaceShareCompleteFB.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.