Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrSpaceLocation

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

Contains info about a space.
Valid Usage (Implicit)
See Also

XrPosef, XrSpaceVelocity, LocateSpace

Layout


struct XrSpaceLocation {
    XrStructureType type;
    void * next;
    XrSpaceLocationFlags locationFlags;
    XrPosef pose;
}

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
LOCATIONFLAGS

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
POSE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
XrSpaceLocation(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrSpaceLocation
calloc()

Returns a new XrSpaceLocation instance allocated with memCalloc.

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

Returns a new XrSpaceLocation.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrSpaceLocation instance allocated with BufferUtils.

public static XrSpaceLocation
create(long address)

Returns a new XrSpaceLocation instance for the specified memory address.

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

Returns a new XrSpaceLocation.Buffer instance allocated with BufferUtils.

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

Create a XrSpaceLocation.Buffer instance at the specified memory.

public static XrSpaceLocation
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
locationFlags()

a bitfield, with bit masks defined in XrSpaceLocationFlagBits, to indicate which members contain valid data.

public XrSpaceLocation
locationFlags(long value)

Sets the specified value to the locationFlags field.

public static XrSpaceLocation
malloc()

Returns a new XrSpaceLocation instance allocated with memAlloc.

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

Returns a new XrSpaceLocation.Buffer instance allocated with memAlloc.

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

Returns a new XrSpaceLocation instance allocated on the specified MemoryStack.

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

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

public long
next()

NULL or a pointer to the next structure in a structure chain, such as XrSpaceVelocity.

public XrSpaceLocation
next(long value)

Sets the specified value to the next field.

public XrSpaceLocation
next(XrEyeGazeSampleTimeEXT value)

Prepends the specified XrEyeGazeSampleTimeEXT value to the next chain.

public XrSpaceLocation
next(XrSpaceVelocity value)

Prepends the specified XrSpaceVelocity value to the next chain.

public static long
nlocationFlags(long struct)

Unsafe version of locationFlags.

public static void
nlocationFlags(long struct, long value)

Unsafe version of locationFlags.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static XrPosef
npose(long struct)

Unsafe version of pose.

public static void
npose(long struct, XrPosef value)

Unsafe version of pose.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public XrPosef
pose()

an XrPosef defining the position and orientation of the origin of LocateSpace::space within the reference frame of LocateSpace::baseSpace.

public XrSpaceLocation
pose(XrPosef value)

Copies the specified XrPosef to the pose field.

public XrSpaceLocation
pose(Consumer<XrPosef> consumer)

Passes the pose field to the specified Consumer.

public XrSpaceLocation
set(int type, long next, long locationFlags, XrPosef pose)

Initializes this struct with the specified values.

public XrSpaceLocation

Returns:

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

Sets the specified value to the type field.

public XrSpaceLocation
type$Default()

Sets the TYPE_SPACE_LOCATION value to the type 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.

LOCATIONFLAGSback to summary
public static final int LOCATIONFLAGS

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

POSEback to summary
public static final int POSE

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.

Constructor Detail

XrSpaceLocationback to summary
protected XrSpaceLocation(long address, ByteBuffer container)
XrSpaceLocationback to summary
public XrSpaceLocation(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrSpaceLocation calloc(MemoryStack stack)

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

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

Returns a new XrSpaceLocation instance allocated with BufferUtils.

createback to summary
public static XrSpaceLocation create(long address)

Returns a new XrSpaceLocation instance for the specified memory address.

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

Returns a new XrSpaceLocation.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrSpaceLocation.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrSpaceLocation createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
locationFlagsback to summary
public long locationFlags()

a bitfield, with bit masks defined in XrSpaceLocationFlagBits, to indicate which members contain valid data. If none of the bits are set, no other fields in this structure should be considered to be valid or meaningful.

Annotations
@NativeType:XrSpaceLocationFlags
locationFlagsback to summary
public XrSpaceLocation locationFlags(long value)

Sets the specified value to the locationFlags field.

mallocback to summary
public static XrSpaceLocation malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrSpaceLocation malloc(MemoryStack stack)

Returns a new XrSpaceLocation instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new XrSpaceLocation.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, such as XrSpaceVelocity.

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

Sets the specified value to the next field.

nextback to summary
public XrSpaceLocation next(XrEyeGazeSampleTimeEXT value)

Prepends the specified XrEyeGazeSampleTimeEXT value to the next chain.

nextback to summary
public XrSpaceLocation next(XrSpaceVelocity value)

Prepends the specified XrSpaceVelocity value to the next chain.

nlocationFlagsback to summary
public static long nlocationFlags(long struct)

Unsafe version of locationFlags.

nlocationFlagsback to summary
public static void nlocationFlags(long struct, long value)

Unsafe version of locationFlags.

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.

nposeback to summary
public static XrPosef npose(long struct)

Unsafe version of pose.

nposeback to summary
public static void npose(long struct, XrPosef value)

Unsafe version of pose.

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.

poseback to summary
public XrPosef pose()

an XrPosef defining the position and orientation of the origin of LocateSpace::space within the reference frame of LocateSpace::baseSpace.

poseback to summary
public XrSpaceLocation pose(XrPosef value)

Copies the specified XrPosef to the pose field.

poseback to summary
public XrSpaceLocation pose(Consumer<XrPosef> consumer)

Passes the pose field to the specified Consumer.

setback to summary
public XrSpaceLocation set(int type, long next, long locationFlags, XrPosef pose)

Initializes this struct with the specified values.

setback to summary
public XrSpaceLocation set(XrSpaceLocation src)

Copies the specified struct data to this struct.

Parameters
src:XrSpaceLocation

the source struct

Returns:XrSpaceLocation

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 XrSpaceLocation type(int value)

Sets the specified value to the type field.

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

Sets the TYPE_SPACE_LOCATION value to the type field.

org.lwjgl.openxr back to summary

public Class XrSpaceLocation.Buffer

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

An array of XrSpaceLocation structs.

Field Summary

Modifier and TypeField and Description
private static final XrSpaceLocation

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

the value of the XrSpaceLocation#locationFlags field.
locationFlags
()

public XrSpaceLocation.Buffer
locationFlags(long value)

Sets the specified value to the XrSpaceLocation#locationFlags field.

public long

Returns:

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

public XrSpaceLocation.Buffer
next(long value)

Sets the specified value to the XrSpaceLocation#next field.

public XrSpaceLocation.Buffer
next(XrEyeGazeSampleTimeEXT value)

Prepends the specified XrEyeGazeSampleTimeEXT value to the next chain.

public XrSpaceLocation.Buffer
next(XrSpaceVelocity value)

Prepends the specified XrSpaceVelocity value to the next chain.

public XrPosef

Returns:

a XrPosef view of the XrSpaceLocation#pose field.
pose
()

public XrSpaceLocation.Buffer
pose(XrPosef value)

Copies the specified XrPosef to the XrSpaceLocation#pose field.

public XrSpaceLocation.Buffer
pose(Consumer<XrPosef> consumer)

Passes the XrSpaceLocation#pose field to the specified Consumer.

protected XrSpaceLocation.Buffer
public int

Returns:

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

public XrSpaceLocation.Buffer
type(int value)

Sets the specified value to the XrSpaceLocation#type field.

public XrSpaceLocation.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrSpaceLocation ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
locationFlagsback to summary
public long locationFlags()
Returns:long

the value of the XrSpaceLocation#locationFlags field.

Annotations
@NativeType:XrSpaceLocationFlags
locationFlagsback to summary
public XrSpaceLocation.Buffer locationFlags(long value)

Sets the specified value to the XrSpaceLocation#locationFlags field.

nextback to summary
public long next()
Returns:long

the value of the XrSpaceLocation#next field.

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

Sets the specified value to the XrSpaceLocation#next field.

nextback to summary
public XrSpaceLocation.Buffer next(XrEyeGazeSampleTimeEXT value)

Prepends the specified XrEyeGazeSampleTimeEXT value to the next chain.

nextback to summary
public XrSpaceLocation.Buffer next(XrSpaceVelocity value)

Prepends the specified XrSpaceVelocity value to the next chain.

poseback to summary
public XrPosef pose()
Returns:XrPosef

a XrPosef view of the XrSpaceLocation#pose field.

poseback to summary
public XrSpaceLocation.Buffer pose(XrPosef value)

Copies the specified XrPosef to the XrSpaceLocation#pose field.

poseback to summary
public XrSpaceLocation.Buffer pose(Consumer<XrPosef> consumer)

Passes the XrSpaceLocation#pose field to the specified Consumer.

selfback to summary
protected XrSpaceLocation.Buffer self()

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

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

the value of the XrSpaceLocation#type field.

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

Sets the specified value to the XrSpaceLocation#type field.

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

Sets the TYPE_SPACE_LOCATION value to the XrSpaceLocation#type field.