Package org.lwjgl.openxr

Class XrEventDataSpaceEraseCompleteFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrEventDataSpaceEraseCompleteFB>

org.lwjgl.openxr.XrEventDataSpaceEraseCompleteFB

All Implemented Interfaces:

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

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

Describes the result of a save operation.

Description

The erase result event contains the success of the erase operation from the specified storage location. It also provides the UUID of the entity and the async request ID from the initial calling function.

Valid Usage (Implicit)

• The XR_FB_spatial_entity_storage extension must be enabled prior to using XrEventDataSpaceEraseCompleteFB
• type must be TYPE_EVENT_DATA_SPACE_ERASE_COMPLETE_FB
• next must be NULL or a valid pointer to the next structure in a structure chain

See Also

XrUuidEXT

Layout

 struct XrEventDataSpaceEraseCompleteFB {
     XrStructureType type();
     void const * next();
     XrAsyncRequestIdFB requestId();
     XrResult result();
     XrSpace space();
     XrUuidEXT uuid();
     XrSpaceStorageLocationFB location();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

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.

SPACE

public static final int SPACE

The struct member offsets.

UUID

public static final int UUID

The struct member offsets.

LOCATION

public static final int LOCATION

The struct member offsets.

Constructor Details

XrEventDataSpaceEraseCompleteFB

public XrEventDataSpaceEraseCompleteFB(ByteBuffer container)

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

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 erase an entity.

result

public int result()

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

space

public long space()

the spatial entity being erased.

uuid

public XrUuidEXT uuid()

the UUID for the spatial entity being erased.

location

public int location()

the location of the spatial entity being erased.

type

public XrEventDataSpaceEraseCompleteFB type(int value)

Sets the specified value to the type() field.

type$Default

public XrEventDataSpaceEraseCompleteFB type$Default()

Sets the TYPE_EVENT_DATA_SPACE_ERASE_COMPLETE_FB value to the type() field.

next

public XrEventDataSpaceEraseCompleteFB next(long value)

Sets the specified value to the next() field.

set

public XrEventDataSpaceEraseCompleteFB set(int type,
 long next)

Initializes this struct with the specified values.

set

public XrEventDataSpaceEraseCompleteFB set(XrEventDataSpaceEraseCompleteFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrEventDataSpaceEraseCompleteFB malloc()

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

calloc

public static XrEventDataSpaceEraseCompleteFB calloc()

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

create

public static XrEventDataSpaceEraseCompleteFB create()

Returns a new XrEventDataSpaceEraseCompleteFB instance allocated with BufferUtils.

create

public static XrEventDataSpaceEraseCompleteFB create(long address)

Returns a new XrEventDataSpaceEraseCompleteFB instance for the specified memory address.

createSafe

public static @Nullable XrEventDataSpaceEraseCompleteFB createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrEventDataSpaceEraseCompleteFB create(XrEventDataBaseHeader value)

Downcasts the specified XrEventDataBaseHeader instance to XrEventDataSpaceEraseCompleteFB.

malloc

public static XrEventDataSpaceEraseCompleteFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrEventDataSpaceEraseCompleteFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrEventDataSpaceEraseCompleteFB.Buffer create(int capacity)

Returns a new XrEventDataSpaceEraseCompleteFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrEventDataSpaceEraseCompleteFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

create

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

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

malloc

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

Returns a new XrEventDataSpaceEraseCompleteFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nspace

public static long nspace(long struct)

Unsafe version of space().

nuuid

public static XrUuidEXT nuuid(long struct)

Unsafe version of uuid().

nlocation

public static int nlocation(long struct)

Unsafe version of location().

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.