Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrEventDataSpaceSaveCompleteFB

extends Struct<XrEventDataSpaceSaveCompleteFB>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Describes the result of a save operation.
Description

The save result event contains the success of the save/write operation to the specified location, as well as the XrSpace handle on which the save operation was attempted on, the unique UUID, and the triggered async request ID from the initial calling function.

Valid Usage (Implicit)
See Also

XrUuidEXT

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
LOCATION

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
REQUESTID

The struct member offsets.

public static final int
RESULT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SPACE

The struct member offsets.

public static final int
TYPE

The struct member offsets.

public static final int
UUID

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
XrEventDataSpaceSaveCompleteFB(long address, ByteBuffer container)

public
XrEventDataSpaceSaveCompleteFB(ByteBuffer container)

Creates a XrEventDataSpaceSaveCompleteFB instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static XrEventDataSpaceSaveCompleteFB
calloc()

Returns a new XrEventDataSpaceSaveCompleteFB instance allocated with memCalloc.

public static XrEventDataSpaceSaveCompleteFB.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new XrEventDataSpaceSaveCompleteFB.Buffer instance allocated with memCalloc.

public static XrEventDataSpaceSaveCompleteFB
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static XrEventDataSpaceSaveCompleteFB.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected XrEventDataSpaceSaveCompleteFB
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static XrEventDataSpaceSaveCompleteFB
create()

Returns a new XrEventDataSpaceSaveCompleteFB instance allocated with BufferUtils.

public static XrEventDataSpaceSaveCompleteFB
create(long address)

Returns a new XrEventDataSpaceSaveCompleteFB instance for the specified memory address.

public static XrEventDataSpaceSaveCompleteFB
create(XrEventDataBaseHeader value)

Downcasts the specified XrEventDataBaseHeader instance to XrEventDataSpaceSaveCompleteFB.

public static XrEventDataSpaceSaveCompleteFB.Buffer
create(int
the buffer capacity
capacity
)

Returns a new XrEventDataSpaceSaveCompleteFB.Buffer instance allocated with BufferUtils.

public static XrEventDataSpaceSaveCompleteFB.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a XrEventDataSpaceSaveCompleteFB.Buffer instance at the specified memory.

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

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

public static XrEventDataSpaceSaveCompleteFB
createSafe(long address)

Like create, but returns null if address is NULL.

public static XrEventDataSpaceSaveCompleteFB.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public int
location()

the location of the spatial entity being saved.

public static XrEventDataSpaceSaveCompleteFB
malloc()

Returns a new XrEventDataSpaceSaveCompleteFB instance allocated with memAlloc.

public static XrEventDataSpaceSaveCompleteFB.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new XrEventDataSpaceSaveCompleteFB.Buffer instance allocated with memAlloc.

public static XrEventDataSpaceSaveCompleteFB
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new XrEventDataSpaceSaveCompleteFB instance allocated on the specified MemoryStack.

public static XrEventDataSpaceSaveCompleteFB.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public long
next()

NULL or a pointer to the next structure in a structure chain.

public XrEventDataSpaceSaveCompleteFB
next(long value)

Sets the specified value to the next field.

public static int
nlocation(long struct)

Unsafe version of location.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static long
nrequestId(long struct)

Unsafe version of requestId.

public static int
nresult(long struct)

Unsafe version of result.

public static long
nspace(long struct)

Unsafe version of space.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public static XrUuidEXT
nuuid(long struct)

Unsafe version of uuid.

public long
requestId()

the ID of the asynchronous request to save an entity.

public int
result()

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

public XrEventDataSpaceSaveCompleteFB
set(int type, long next)

Initializes this struct with the specified values.

public XrEventDataSpaceSaveCompleteFB

Returns:

this struct
set
(XrEventDataSpaceSaveCompleteFB
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public long
space()

the spatial entity being saved.

public int
type()

the XrStructureType of this structure.

public XrEventDataSpaceSaveCompleteFB
type(int value)

Sets the specified value to the type field.

public XrEventDataSpaceSaveCompleteFB
public XrUuidEXT
uuid()

the UUID for the spatial entity being saved.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

LOCATIONback to summary
public static final int LOCATION

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

REQUESTIDback to summary
public static final int REQUESTID

The struct member offsets.

RESULTback to summary
public static final int RESULT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SPACEback to summary
public static final int SPACE

The struct member offsets.

TYPEback to summary
public static final int TYPE

The struct member offsets.

UUIDback to summary
public static final int UUID

The struct member offsets.

Constructor Detail

XrEventDataSpaceSaveCompleteFBback to summary
protected XrEventDataSpaceSaveCompleteFB(long address, ByteBuffer container)
XrEventDataSpaceSaveCompleteFBback to summary
public XrEventDataSpaceSaveCompleteFB(ByteBuffer container)

Creates a XrEventDataSpaceSaveCompleteFB 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 Detail

callocback to summary
public static XrEventDataSpaceSaveCompleteFB calloc()

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

callocback to summary
public static XrEventDataSpaceSaveCompleteFB.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrEventDataSpaceSaveCompleteFB calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static XrEventDataSpaceSaveCompleteFB.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected XrEventDataSpaceSaveCompleteFB create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static XrEventDataSpaceSaveCompleteFB create()

Returns a new XrEventDataSpaceSaveCompleteFB instance allocated with BufferUtils.

createback to summary
public static XrEventDataSpaceSaveCompleteFB create(long address)

Returns a new XrEventDataSpaceSaveCompleteFB instance for the specified memory address.

createback to summary
public static XrEventDataSpaceSaveCompleteFB create(XrEventDataBaseHeader value)

Downcasts the specified XrEventDataBaseHeader instance to XrEventDataSpaceSaveCompleteFB.

createback to summary
public static XrEventDataSpaceSaveCompleteFB.Buffer create(int capacity)

Returns a new XrEventDataSpaceSaveCompleteFB.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static XrEventDataSpaceSaveCompleteFB.Buffer create(long address, int capacity)

Create a XrEventDataSpaceSaveCompleteFB.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createback to summary
public static XrEventDataSpaceSaveCompleteFB.Buffer create(XrEventDataBaseHeader.Buffer value)

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

createSafeback to summary
public static XrEventDataSpaceSaveCompleteFB createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static XrEventDataSpaceSaveCompleteFB.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
locationback to summary
public int location()

the location of the spatial entity being saved.

Annotations
@NativeType:XrSpaceStorageLocationFB
mallocback to summary
public static XrEventDataSpaceSaveCompleteFB malloc()

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

mallocback to summary
public static XrEventDataSpaceSaveCompleteFB.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrEventDataSpaceSaveCompleteFB malloc(MemoryStack stack)

Returns a new XrEventDataSpaceSaveCompleteFB instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static XrEventDataSpaceSaveCompleteFB.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nextback to summary
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.

Annotations
@NativeType:void const *
nextback to summary
public XrEventDataSpaceSaveCompleteFB next(long value)

Sets the specified value to the next field.

nlocationback to summary
public static int nlocation(long struct)

Unsafe version of location.

nnextback to summary
public static long nnext(long struct)

Unsafe version of next.

nnextback to summary
public static void nnext(long struct, long value)

Unsafe version of next.

nrequestIdback to summary
public static long nrequestId(long struct)

Unsafe version of requestId.

nresultback to summary
public static int nresult(long struct)

Unsafe version of result.

nspaceback to summary
public static long nspace(long struct)

Unsafe version of space.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

ntypeback to summary
public static void ntype(long struct, int value)

Unsafe version of type.

nuuidback to summary
public static XrUuidEXT nuuid(long struct)

Unsafe version of uuid.

requestIdback to summary
public long requestId()

the ID of the asynchronous request to save an entity.

Annotations
@NativeType:XrAsyncRequestIdFB
resultback to summary
public int result()

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

Annotations
@NativeType:XrResult
setback to summary
public XrEventDataSpaceSaveCompleteFB set(int type, long next)

Initializes this struct with the specified values.

setback to summary
public XrEventDataSpaceSaveCompleteFB set(XrEventDataSpaceSaveCompleteFB src)

Copies the specified struct data to this struct.

Parameters
src:XrEventDataSpaceSaveCompleteFB

the source struct

Returns:XrEventDataSpaceSaveCompleteFB

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
spaceback to summary
public long space()

the spatial entity being saved.

Annotations
@NativeType:XrSpace
typeback to summary
public int type()

the XrStructureType of this structure.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrEventDataSpaceSaveCompleteFB type(int value)

Sets the specified value to the type field.

type$Defaultback to summary
public XrEventDataSpaceSaveCompleteFB type$Default()

Sets the TYPE_EVENT_DATA_SPACE_SAVE_COMPLETE_FB value to the type field.

uuidback to summary
public XrUuidEXT uuid()

the UUID for the spatial entity being saved.

org.lwjgl.openxr back to summary

public Class XrEventDataSpaceSaveCompleteFB.Buffer

extends StructBuffer<XrEventDataSpaceSaveCompleteFB, XrEventDataSpaceSaveCompleteFB.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrEventDataSpaceSaveCompleteFB structs.

Field Summary

Modifier and TypeField and Description
private static final XrEventDataSpaceSaveCompleteFB

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrEventDataSpaceSaveCompleteFB.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected XrEventDataSpaceSaveCompleteFB
public int

Returns:

the value of the XrEventDataSpaceSaveCompleteFB#location field.
location
()

public long

Returns:

the value of the XrEventDataSpaceSaveCompleteFB#next field.
next
()

public XrEventDataSpaceSaveCompleteFB.Buffer
next(long value)

Sets the specified value to the XrEventDataSpaceSaveCompleteFB#next field.

public long

Returns:

the value of the XrEventDataSpaceSaveCompleteFB#requestId field.
requestId
()

public int

Returns:

the value of the XrEventDataSpaceSaveCompleteFB#result field.
result
()

protected XrEventDataSpaceSaveCompleteFB.Buffer
public long

Returns:

the value of the XrEventDataSpaceSaveCompleteFB#space field.
space
()

public int

Returns:

the value of the XrEventDataSpaceSaveCompleteFB#type field.
type
()

public XrEventDataSpaceSaveCompleteFB.Buffer
type(int value)

Sets the specified value to the XrEventDataSpaceSaveCompleteFB#type field.

public XrEventDataSpaceSaveCompleteFB.Buffer
public XrUuidEXT

Returns:

a XrUuidEXT view of the XrEventDataSpaceSaveCompleteFB#uuid field.
uuid
()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrEventDataSpaceSaveCompleteFB ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrEventDataSpaceSaveCompleteFB.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by XrEventDataSpaceSaveCompleteFB#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected XrEventDataSpaceSaveCompleteFB getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
locationback to summary
public int location()
Returns:int

the value of the XrEventDataSpaceSaveCompleteFB#location field.

Annotations
@NativeType:XrSpaceStorageLocationFB
nextback to summary
public long next()
Returns:long

the value of the XrEventDataSpaceSaveCompleteFB#next field.

Annotations
@NativeType:void const *
nextback to summary
public XrEventDataSpaceSaveCompleteFB.Buffer next(long value)

Sets the specified value to the XrEventDataSpaceSaveCompleteFB#next field.

requestIdback to summary
public long requestId()
Returns:long

the value of the XrEventDataSpaceSaveCompleteFB#requestId field.

Annotations
@NativeType:XrAsyncRequestIdFB
resultback to summary
public int result()
Returns:int

the value of the XrEventDataSpaceSaveCompleteFB#result field.

Annotations
@NativeType:XrResult
selfback to summary
protected XrEventDataSpaceSaveCompleteFB.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
spaceback to summary
public long space()
Returns:long

the value of the XrEventDataSpaceSaveCompleteFB#space field.

Annotations
@NativeType:XrSpace
typeback to summary
public int type()
Returns:int

the value of the XrEventDataSpaceSaveCompleteFB#type field.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrEventDataSpaceSaveCompleteFB.Buffer type(int value)

Sets the specified value to the XrEventDataSpaceSaveCompleteFB#type field.

type$Defaultback to summary
public XrEventDataSpaceSaveCompleteFB.Buffer type$Default()

Sets the TYPE_EVENT_DATA_SPACE_SAVE_COMPLETE_FB value to the XrEventDataSpaceSaveCompleteFB#type field.

uuidback to summary
public XrUuidEXT uuid()
Returns:XrUuidEXT

a XrUuidEXT view of the XrEventDataSpaceSaveCompleteFB#uuid field.