Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrSpaceContainerFB

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

Represents a collection of other spaces, represented by UUIDs, contained by this space.
Description

The XrSpaceContainerFB structure can be used by an application to perform the two calls required to obtain information about which spatial entities are contained by a specified spatial entity.

Valid Usage (Implicit)
See Also

XrUuidEXT, GetSpaceContainerFB

Layout


struct XrSpaceContainerFB {
    XrStructureType type;
    void const * next;
    uint32_t uuidCapacityInput;
    uint32_t uuidCountOutput;
    XrUuidEXT * uuids;
}

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
NEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

public static final int
UUIDCAPACITYINPUT

The struct member offsets.

public static final int
UUIDCOUNTOUTPUT

The struct member offsets.

public static final int
UUIDS

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
XrSpaceContainerFB(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrSpaceContainerFB
calloc()

Returns a new XrSpaceContainerFB instance allocated with memCalloc.

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

Returns a new XrSpaceContainerFB.Buffer instance allocated with memCalloc.

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

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

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

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

protected XrSpaceContainerFB
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 XrSpaceContainerFB
create()

Returns a new XrSpaceContainerFB instance allocated with BufferUtils.

public static XrSpaceContainerFB
create(long address)

Returns a new XrSpaceContainerFB instance for the specified memory address.

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

Returns a new XrSpaceContainerFB.Buffer instance allocated with BufferUtils.

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

Create a XrSpaceContainerFB.Buffer instance at the specified memory.

public static XrSpaceContainerFB
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrSpaceContainerFB
malloc()

Returns a new XrSpaceContainerFB instance allocated with memAlloc.

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

Returns a new XrSpaceContainerFB.Buffer instance allocated with memAlloc.

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

Returns a new XrSpaceContainerFB instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrSpaceContainerFB
next(long value)

Sets the specified value to the next field.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public static int
nuuidCapacityInput(long struct)

Unsafe version of uuidCapacityInput.

public static void
nuuidCapacityInput(long struct, int value)

Sets the specified value to the uuidCapacityInput field of the specified struct.

public static int
nuuidCountOutput(long struct)

Unsafe version of uuidCountOutput.

public static void
nuuidCountOutput(long struct, int value)

Unsafe version of uuidCountOutput.

public static XrUuidEXT.Buffer
nuuids(long struct)

Unsafe version of uuids.

public static void
nuuids(long struct, XrUuidEXT.Buffer value)

Unsafe version of uuids.

public XrSpaceContainerFB
set(int type, long next, int uuidCapacityInput, int uuidCountOutput, XrUuidEXT.Buffer uuids)

Initializes this struct with the specified values.

public XrSpaceContainerFB

Returns:

this struct
set
(XrSpaceContainerFB
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 int
type()

the XrStructureType of this structure.

public XrSpaceContainerFB
type(int value)

Sets the specified value to the type field.

public XrSpaceContainerFB
type$Default()

Sets the TYPE_SPACE_CONTAINER_FB value to the type field.

public int
uuidCapacityInput()

the capacity of the uuids array, or 0 to indicate a request to retrieve the required capacity.

public XrSpaceContainerFB
uuidCapacityInput(int value)

Sets the specified value to the uuidCapacityInput field.

public int
uuidCountOutput()

an output parameter which will hold the number of UUIDs included in the output list, or the required capacity in the case that uuidCapacityInput is insufficient

public XrSpaceContainerFB
uuidCountOutput(int value)

Sets the specified value to the uuidCountOutput field.

public XrUuidEXT.Buffer
uuids()

an output parameter which will hold a list of space UUIDs contained by the space to which the component is attached.

public XrSpaceContainerFB
uuids(XrUuidEXT.Buffer value)

Sets the address of the specified XrUuidEXT.Buffer to the uuids field.

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.

NEXTback to summary
public static final int NEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPEback to summary
public static final int TYPE

The struct member offsets.

UUIDCAPACITYINPUTback to summary
public static final int UUIDCAPACITYINPUT

The struct member offsets.

UUIDCOUNTOUTPUTback to summary
public static final int UUIDCOUNTOUTPUT

The struct member offsets.

UUIDSback to summary
public static final int UUIDS

The struct member offsets.

Constructor Detail

XrSpaceContainerFBback to summary
protected XrSpaceContainerFB(long address, ByteBuffer container)
XrSpaceContainerFBback to summary
public XrSpaceContainerFB(ByteBuffer container)

Creates a XrSpaceContainerFB 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 XrSpaceContainerFB calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrSpaceContainerFB calloc(MemoryStack stack)

Returns a new XrSpaceContainerFB 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 XrSpaceContainerFB.Buffer calloc(int capacity, MemoryStack stack)

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

Returns a new XrSpaceContainerFB instance allocated with BufferUtils.

createback to summary
public static XrSpaceContainerFB create(long address)

Returns a new XrSpaceContainerFB instance for the specified memory address.

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

Returns a new XrSpaceContainerFB.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrSpaceContainerFB.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrSpaceContainerFB createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static XrSpaceContainerFB malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrSpaceContainerFB malloc(MemoryStack stack)

Returns a new XrSpaceContainerFB instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new XrSpaceContainerFB.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 XrSpaceContainerFB next(long value)

Sets the specified value to the next field.

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.

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.

nuuidCapacityInputback to summary
public static int nuuidCapacityInput(long struct)

Unsafe version of uuidCapacityInput.

nuuidCapacityInputback to summary
public static void nuuidCapacityInput(long struct, int value)

Sets the specified value to the uuidCapacityInput field of the specified struct.

nuuidCountOutputback to summary
public static int nuuidCountOutput(long struct)

Unsafe version of uuidCountOutput.

nuuidCountOutputback to summary
public static void nuuidCountOutput(long struct, int value)

Unsafe version of uuidCountOutput.

nuuidsback to summary
public static XrUuidEXT.Buffer nuuids(long struct)

Unsafe version of uuids.

Annotations
@Nullable
nuuidsback to summary
public static void nuuids(long struct, XrUuidEXT.Buffer value)

Unsafe version of uuids.

setback to summary
public XrSpaceContainerFB set(int type, long next, int uuidCapacityInput, int uuidCountOutput, XrUuidEXT.Buffer uuids)

Initializes this struct with the specified values.

setback to summary
public XrSpaceContainerFB set(XrSpaceContainerFB src)

Copies the specified struct data to this struct.

Parameters
src:XrSpaceContainerFB

the source struct

Returns:XrSpaceContainerFB

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
typeback to summary
public int type()

the XrStructureType of this structure.

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

Sets the specified value to the type field.

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

Sets the TYPE_SPACE_CONTAINER_FB value to the type field.

uuidCapacityInputback to summary
public int uuidCapacityInput()

the capacity of the uuids array, or 0 to indicate a request to retrieve the required capacity.

Annotations
@NativeType:uint32_t
uuidCapacityInputback to summary
public XrSpaceContainerFB uuidCapacityInput(int value)

Sets the specified value to the uuidCapacityInput field.

uuidCountOutputback to summary
public int uuidCountOutput()

an output parameter which will hold the number of UUIDs included in the output list, or the required capacity in the case that uuidCapacityInput is insufficient

Annotations
@NativeType:uint32_t
uuidCountOutputback to summary
public XrSpaceContainerFB uuidCountOutput(int value)

Sets the specified value to the uuidCountOutput field.

uuidsback to summary
public XrUuidEXT.Buffer uuids()

an output parameter which will hold a list of space UUIDs contained by the space to which the component is attached.

Annotations
@Nullable
@NativeType:XrUuidEXT *
uuidsback to summary
public XrSpaceContainerFB uuids(XrUuidEXT.Buffer value)

Sets the address of the specified XrUuidEXT.Buffer to the uuids field.

org.lwjgl.openxr back to summary

public Class XrSpaceContainerFB.Buffer

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

An array of XrSpaceContainerFB structs.

Field Summary

Modifier and TypeField and Description
private static final XrSpaceContainerFB

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrSpaceContainerFB.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 XrSpaceContainerFB
public long

Returns:

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

public XrSpaceContainerFB.Buffer
next(long value)

Sets the specified value to the XrSpaceContainerFB#next field.

protected XrSpaceContainerFB.Buffer
public int

Returns:

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

public XrSpaceContainerFB.Buffer
type(int value)

Sets the specified value to the XrSpaceContainerFB#type field.

public XrSpaceContainerFB.Buffer
public int

Returns:

the value of the XrSpaceContainerFB#uuidCapacityInput field.
uuidCapacityInput
()

public XrSpaceContainerFB.Buffer
uuidCapacityInput(int value)

Sets the specified value to the XrSpaceContainerFB#uuidCapacityInput field.

public int

Returns:

the value of the XrSpaceContainerFB#uuidCountOutput field.
uuidCountOutput
()

public XrSpaceContainerFB.Buffer
uuidCountOutput(int value)

Sets the specified value to the XrSpaceContainerFB#uuidCountOutput field.

public XrUuidEXT.Buffer

Returns:

a XrUuidEXT.Buffer view of the struct array pointed to by the XrSpaceContainerFB#uuids field.
uuids
()

public XrSpaceContainerFB.Buffer
uuids(XrUuidEXT.Buffer value)

Sets the address of the specified XrUuidEXT.Buffer to the XrSpaceContainerFB#uuids field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrSpaceContainerFB ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrSpaceContainerFB.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 XrSpaceContainerFB#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 XrSpaceContainerFB getElementFactory()

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

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

the value of the XrSpaceContainerFB#next field.

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

Sets the specified value to the XrSpaceContainerFB#next field.

selfback to summary
protected XrSpaceContainerFB.Buffer self()

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

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

the value of the XrSpaceContainerFB#type field.

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

Sets the specified value to the XrSpaceContainerFB#type field.

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

Sets the TYPE_SPACE_CONTAINER_FB value to the XrSpaceContainerFB#type field.

uuidCapacityInputback to summary
public int uuidCapacityInput()
Returns:int

the value of the XrSpaceContainerFB#uuidCapacityInput field.

Annotations
@NativeType:uint32_t
uuidCapacityInputback to summary
public XrSpaceContainerFB.Buffer uuidCapacityInput(int value)

Sets the specified value to the XrSpaceContainerFB#uuidCapacityInput field.

uuidCountOutputback to summary
public int uuidCountOutput()
Returns:int

the value of the XrSpaceContainerFB#uuidCountOutput field.

Annotations
@NativeType:uint32_t
uuidCountOutputback to summary
public XrSpaceContainerFB.Buffer uuidCountOutput(int value)

Sets the specified value to the XrSpaceContainerFB#uuidCountOutput field.

uuidsback to summary
public XrUuidEXT.Buffer uuids()
Returns:XrUuidEXT.Buffer

a XrUuidEXT.Buffer view of the struct array pointed to by the XrSpaceContainerFB#uuids field.

Annotations
@Nullable
@NativeType:XrUuidEXT *
uuidsback to summary
public XrSpaceContainerFB.Buffer uuids(XrUuidEXT.Buffer value)

Sets the address of the specified XrUuidEXT.Buffer to the XrSpaceContainerFB#uuids field.