Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrPosef

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

Location and orientation in a space.
Description

A runtime must return ERROR_POSE_INVALID if the orientation norm deviates by more than 1% from unit length.

See Also

XrActionSpaceCreateInfo, XrBodyJointLocationFB, XrBodySkeletonJointFB, XrCompositionLayerCylinderKHR, XrCompositionLayerEquirect2KHR, XrCompositionLayerEquirectKHR, XrCompositionLayerProjectionView, XrCompositionLayerQuad, XrCompositionLayerSpaceWarpInfoFB, XrControllerModelNodeStateMSFT, XrCoordinateSpaceCreateInfoML, XrEventDataReferenceSpaceChangePending, XrExternalCameraExtrinsicsOCULUS, XrEyeGazeFB, XrGeometryInstanceCreateInfoFB, XrGeometryInstanceTransformFB, XrHandJointLocationEXT, XrHandMeshSpaceCreateInfoMSFT, XrHandTrackingAimStateFB, XrHandTrackingMeshFB, XrMarkerSpaceCreateInfoVARJO, XrPassthroughMeshTransformInfoHTC, XrPlaneDetectorBeginInfoEXT, XrPlaneDetectorLocationEXT, XrQuaternionf, XrReferenceSpaceCreateInfo, XrSceneComponentLocationMSFT, XrSceneFrustumBoundMSFT, XrSceneOrientedBoxBoundMSFT, XrSpaceLocation, XrSpatialAnchorCreateInfoFB, XrSpatialAnchorCreateInfoMSFT, XrSpatialAnchorSpaceCreateInfoMSFT, XrSpatialGraphNodeBindingPropertiesMSFT, XrSpatialGraphNodeSpaceCreateInfoMSFT, XrSpatialGraphStaticNodeBindingCreateInfoMSFT, XrVector2f, XrVector3f, XrVector4f, XrView, XrVirtualKeyboardInputInfoMETA, XrVirtualKeyboardLocationInfoMETA, XrVirtualKeyboardSpaceCreateInfoMETA, SendVirtualKeyboardInputMETA, SetInputDeviceLocationEXT

Layout


struct XrPosef {
    XrQuaternionf orientation;
    XrVector3f position;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
XrPosef.Buffer

An array of XrPosef structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
ORIENTATION

The struct member offsets.

public static final int
POSITION

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
XrPosef(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrPosef
calloc()

Returns a new XrPosef instance allocated with memCalloc.

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

Returns a new XrPosef.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrPosef instance allocated with BufferUtils.

public static XrPosef
create(long address)

Returns a new XrPosef instance for the specified memory address.

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

Returns a new XrPosef.Buffer instance allocated with BufferUtils.

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

Create a XrPosef.Buffer instance at the specified memory.

public static XrPosef
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrPosef
malloc()

Returns a new XrPosef instance allocated with memAlloc.

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

Returns a new XrPosef.Buffer instance allocated with memAlloc.

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

Returns a new XrPosef instance allocated on the specified MemoryStack.

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

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

public static XrQuaternionf
norientation(long struct)

Unsafe version of orientation.

public static void
norientation(long struct, XrQuaternionf value)

Unsafe version of orientation.

public static XrVector3f
nposition$(long struct)

Unsafe version of position$.

public static void
nposition$(long struct, XrVector3f value)

Unsafe version of position$.

public XrQuaternionf
orientation()

an XrQuaternionf representing the orientation within a space.

public XrPosef
orientation(XrQuaternionf value)

Copies the specified XrQuaternionf to the orientation field.

public XrPosef
orientation(Consumer<XrQuaternionf> consumer)

Passes the orientation field to the specified Consumer.

public XrVector3f
position$()

an XrVector3f representing position within a space.

public XrPosef
position$(XrVector3f value)

Copies the specified XrVector3f to the position$ field.

public XrPosef
position$(Consumer<XrVector3f> consumer)

Passes the position$ field to the specified Consumer.

public XrPosef
set(XrQuaternionf orientation, XrVector3f position$)

Initializes this struct with the specified values.

public XrPosef

Returns:

this struct
set
(XrPosef
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).
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.

ORIENTATIONback to summary
public static final int ORIENTATION

The struct member offsets.

POSITIONback to summary
public static final int POSITION

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

XrPosefback to summary
protected XrPosef(long address, ByteBuffer container)
XrPosefback to summary
public XrPosef(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrPosef calloc(MemoryStack stack)

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

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

Returns a new XrPosef instance allocated with BufferUtils.

createback to summary
public static XrPosef create(long address)

Returns a new XrPosef instance for the specified memory address.

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

Returns a new XrPosef.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrPosef.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrPosef createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrPosef malloc(MemoryStack stack)

Returns a new XrPosef instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

norientationback to summary
public static XrQuaternionf norientation(long struct)

Unsafe version of orientation.

norientationback to summary
public static void norientation(long struct, XrQuaternionf value)

Unsafe version of orientation.

nposition$back to summary
public static XrVector3f nposition$(long struct)

Unsafe version of position$.

nposition$back to summary
public static void nposition$(long struct, XrVector3f value)

Unsafe version of position$.

orientationback to summary
public XrQuaternionf orientation()

an XrQuaternionf representing the orientation within a space.

orientationback to summary
public XrPosef orientation(XrQuaternionf value)

Copies the specified XrQuaternionf to the orientation field.

orientationback to summary
public XrPosef orientation(Consumer<XrQuaternionf> consumer)

Passes the orientation field to the specified Consumer.

position$back to summary
public XrVector3f position$()

an XrVector3f representing position within a space.

position$back to summary
public XrPosef position$(XrVector3f value)

Copies the specified XrVector3f to the position$ field.

position$back to summary
public XrPosef position$(Consumer<XrVector3f> consumer)

Passes the position$ field to the specified Consumer.

setback to summary
public XrPosef set(XrQuaternionf orientation, XrVector3f position$)

Initializes this struct with the specified values.

setback to summary
public XrPosef set(XrPosef src)

Copies the specified struct data to this struct.

Parameters
src:XrPosef

the source struct

Returns:XrPosef

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
org.lwjgl.openxr back to summary

public Class XrPosef.Buffer

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

An array of XrPosef structs.

Field Summary

Modifier and TypeField and Description
private static final XrPosef

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrPosef.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 XrPosef
public XrQuaternionf

Returns:

a XrQuaternionf view of the XrPosef#orientation field.
orientation
()

public XrPosef.Buffer
orientation(XrQuaternionf value)

Copies the specified XrQuaternionf to the XrPosef#orientation field.

public XrPosef.Buffer
orientation(Consumer<XrQuaternionf> consumer)

Passes the XrPosef#orientation field to the specified Consumer.

public XrVector3f

Returns:

a XrVector3f view of the XrPosef#position$ field.
position$
()

public XrPosef.Buffer
position$(XrVector3f value)

Copies the specified XrVector3f to the XrPosef#position$ field.

public XrPosef.Buffer
position$(Consumer<XrVector3f> consumer)

Passes the XrPosef#position$ field to the specified Consumer.

protected XrPosef.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrPosef ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
orientationback to summary
public XrQuaternionf orientation()
Returns:XrQuaternionf

a XrQuaternionf view of the XrPosef#orientation field.

orientationback to summary
public XrPosef.Buffer orientation(XrQuaternionf value)

Copies the specified XrQuaternionf to the XrPosef#orientation field.

orientationback to summary
public XrPosef.Buffer orientation(Consumer<XrQuaternionf> consumer)

Passes the XrPosef#orientation field to the specified Consumer.

position$back to summary
public XrVector3f position$()
Returns:XrVector3f

a XrVector3f view of the XrPosef#position$ field.

position$back to summary
public XrPosef.Buffer position$(XrVector3f value)

Copies the specified XrVector3f to the XrPosef#position$ field.

position$back to summary
public XrPosef.Buffer position$(Consumer<XrVector3f> consumer)

Passes the XrPosef#position$ field to the specified Consumer.

selfback to summary
protected XrPosef.Buffer self()

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

Annotations
@Override