org.lwjgl.ovr.OVRTrackingState Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-ovr Show documentation
Show all versions of lwjgl-ovr Show documentation
The API of the Oculus SDK.
The newest version!
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.ovr;
import javax.annotation.*;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.Checks.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Tracking state at a given absolute time (describes predicted HMD pose etc). Returned by {@link OVR#ovr_GetTrackingState GetTrackingState}.
*
* Layout
*
*
* struct ovrTrackingState {
* {@link OVRPoseStatef ovrPoseStatef} {@link #HeadPose};
* unsigned int {@link #StatusFlags};
* {@link OVRPoseStatef ovrPoseStatef} {@link #HandPoses}[2];
* unsigned int {@link #HandStatusFlags}[2];
* {@link OVRPosef ovrPosef} {@link #CalibratedOrigin};
* }
*/
@NativeType("struct ovrTrackingState")
public class OVRTrackingState extends Struct implements NativeResource {
/** The struct size in bytes. */
public static final int SIZEOF;
/** The struct alignment in bytes. */
public static final int ALIGNOF;
/** The struct member offsets. */
public static final int
HEADPOSE,
STATUSFLAGS,
HANDPOSES,
HANDSTATUSFLAGS,
CALIBRATEDORIGIN;
static {
Layout layout = __struct(
__member(OVRPoseStatef.SIZEOF, OVRPoseStatef.ALIGNOF),
__member(4),
__array(OVRPoseStatef.SIZEOF, OVRPoseStatef.ALIGNOF, 2),
__array(4, 2),
__member(OVRPosef.SIZEOF, OVRPosef.ALIGNOF)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
HEADPOSE = layout.offsetof(0);
STATUSFLAGS = layout.offsetof(1);
HANDPOSES = layout.offsetof(2);
HANDSTATUSFLAGS = layout.offsetof(3);
CALIBRATEDORIGIN = layout.offsetof(4);
}
protected OVRTrackingState(long address, @Nullable ByteBuffer container) {
super(address, container);
}
@Override
protected OVRTrackingState create(long address, @Nullable ByteBuffer container) {
return new OVRTrackingState(address, container);
}
/**
* Creates a {@code OVRTrackingState} instance at the current position of the specified {@link 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.
*/
public OVRTrackingState(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/**
* Predicted head pose (and derivatives) at the requested absolute time. The look-ahead interval is equal to
* {@code (HeadPose.TimeInSeconds - RawSensorData.TimeInSeconds)}.
*/
@NativeType("ovrPoseStatef")
public OVRPoseStatef HeadPose() { return nHeadPose(address()); }
/** {@code HeadPose} tracking status described by {@code ovrStatusBits}. */
@NativeType("unsigned int")
public int StatusFlags() { return nStatusFlags(address()); }
/**
* The most recent calculated pose for each hand when hand controller tracking is present. {@code HandPoses[ovrHand_Left]} refers to the left hand and
* {@code HandPoses[ovrHand_Right]} to the right hand. These values can be combined with {@code ovrInputState} for complete hand controller information.
*/
@NativeType("ovrPoseStatef[2]")
public OVRPoseStatef.Buffer HandPoses() { return nHandPoses(address()); }
/**
* The most recent calculated pose for each hand when hand controller tracking is present. {@code HandPoses[ovrHand_Left]} refers to the left hand and
* {@code HandPoses[ovrHand_Right]} to the right hand. These values can be combined with {@code ovrInputState} for complete hand controller information.
*/
@NativeType("ovrPoseStatef")
public OVRPoseStatef HandPoses(int index) { return nHandPoses(address(), index); }
/** {@code HandPoses} status flags described by {@code ovrStatusBits}. */
@NativeType("unsigned int[2]")
public IntBuffer HandStatusFlags() { return nHandStatusFlags(address()); }
/** {@code HandPoses} status flags described by {@code ovrStatusBits}. */
@NativeType("unsigned int")
public int HandStatusFlags(int index) { return nHandStatusFlags(address(), index); }
/**
* the pose of the origin captured during calibration.
*
* Like all other poses here, this is expressed in the space set by {@link OVR#ovr_RecenterTrackingOrigin RecenterTrackingOrigin}, or {@link OVR#ovr_SpecifyTrackingOrigin SpecifyTrackingOrigin} and so will change every time
* either of those functions are called. This pose can be used to calculate where the calibrated origin lands in the new recentered space. If an
* application never calls {@link OVR#ovr_RecenterTrackingOrigin RecenterTrackingOrigin} or {@link OVR#ovr_SpecifyTrackingOrigin SpecifyTrackingOrigin}, expect this value to be the identity pose and as such will point
* respective origin based on {@code ovrTrackingOrigin} requested when calling {@link OVR#ovr_GetTrackingState GetTrackingState}.
*/
@NativeType("ovrPosef")
public OVRPosef CalibratedOrigin() { return nCalibratedOrigin(address()); }
// -----------------------------------
/** Returns a new {@code OVRTrackingState} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static OVRTrackingState malloc() {
return new OVRTrackingState(nmemAllocChecked(SIZEOF), null);
}
/** Returns a new {@code OVRTrackingState} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static OVRTrackingState calloc() {
return new OVRTrackingState(nmemCallocChecked(1, SIZEOF), null);
}
/** Returns a new {@code OVRTrackingState} instance allocated with {@link BufferUtils}. */
public static OVRTrackingState create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return new OVRTrackingState(memAddress(container), container);
}
/** Returns a new {@code OVRTrackingState} instance for the specified memory address. */
public static OVRTrackingState create(long address) {
return new OVRTrackingState(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static OVRTrackingState createSafe(long address) {
return address == NULL ? null : new OVRTrackingState(address, null);
}
/**
* Returns a new {@link OVRTrackingState.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static OVRTrackingState.Buffer malloc(int capacity) {
return new Buffer(nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link OVRTrackingState.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static OVRTrackingState.Buffer calloc(int capacity) {
return new Buffer(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link OVRTrackingState.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static OVRTrackingState.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return new Buffer(memAddress(container), container, -1, 0, capacity, capacity);
}
/**
* Create a {@link OVRTrackingState.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static OVRTrackingState.Buffer create(long address, int capacity) {
return new Buffer(address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static OVRTrackingState.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : new Buffer(address, capacity);
}
// -----------------------------------
/** Deprecated for removal in 3.4.0. Use {@link #malloc(MemoryStack)} instead. */
@Deprecated public static OVRTrackingState mallocStack() { return malloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static OVRTrackingState callocStack() { return calloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(MemoryStack)} instead. */
@Deprecated public static OVRTrackingState mallocStack(MemoryStack stack) { return malloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static OVRTrackingState callocStack(MemoryStack stack) { return calloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static OVRTrackingState.Buffer mallocStack(int capacity) { return malloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(int, MemoryStack)} instead. */
@Deprecated public static OVRTrackingState.Buffer callocStack(int capacity) { return calloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static OVRTrackingState.Buffer mallocStack(int capacity, MemoryStack stack) { return malloc(capacity, stack); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(int, MemoryStack)} instead. */
@Deprecated public static OVRTrackingState.Buffer callocStack(int capacity, MemoryStack stack) { return calloc(capacity, stack); }
/**
* Returns a new {@code OVRTrackingState} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static OVRTrackingState malloc(MemoryStack stack) {
return new OVRTrackingState(stack.nmalloc(ALIGNOF, SIZEOF), null);
}
/**
* Returns a new {@code OVRTrackingState} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static OVRTrackingState calloc(MemoryStack stack) {
return new OVRTrackingState(stack.ncalloc(ALIGNOF, 1, SIZEOF), null);
}
/**
* Returns a new {@link OVRTrackingState.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static OVRTrackingState.Buffer malloc(int capacity, MemoryStack stack) {
return new Buffer(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link OVRTrackingState.Buffer} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static OVRTrackingState.Buffer calloc(int capacity, MemoryStack stack) {
return new Buffer(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #HeadPose}. */
public static OVRPoseStatef nHeadPose(long struct) { return OVRPoseStatef.create(struct + OVRTrackingState.HEADPOSE); }
/** Unsafe version of {@link #StatusFlags}. */
public static int nStatusFlags(long struct) { return UNSAFE.getInt(null, struct + OVRTrackingState.STATUSFLAGS); }
/** Unsafe version of {@link #HandPoses}. */
public static OVRPoseStatef.Buffer nHandPoses(long struct) { return OVRPoseStatef.create(struct + OVRTrackingState.HANDPOSES, 2); }
/** Unsafe version of {@link #HandPoses(int) HandPoses}. */
public static OVRPoseStatef nHandPoses(long struct, int index) {
return OVRPoseStatef.create(struct + OVRTrackingState.HANDPOSES + check(index, 2) * OVRPoseStatef.SIZEOF);
}
/** Unsafe version of {@link #HandStatusFlags}. */
public static IntBuffer nHandStatusFlags(long struct) { return memIntBuffer(struct + OVRTrackingState.HANDSTATUSFLAGS, 2); }
/** Unsafe version of {@link #HandStatusFlags(int) HandStatusFlags}. */
public static int nHandStatusFlags(long struct, int index) {
return UNSAFE.getInt(null, struct + OVRTrackingState.HANDSTATUSFLAGS + check(index, 2) * 4);
}
/** Unsafe version of {@link #CalibratedOrigin}. */
public static OVRPosef nCalibratedOrigin(long struct) { return OVRPosef.create(struct + OVRTrackingState.CALIBRATEDORIGIN); }
// -----------------------------------
/** An array of {@link OVRTrackingState} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final OVRTrackingState ELEMENT_FACTORY = OVRTrackingState.create(-1L);
/**
* Creates a new {@code OVRTrackingState.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 {@link OVRTrackingState#SIZEOF}, and its mark will be undefined.
*
* The created buffer instance holds a strong reference to the container object.
*/
public Buffer(ByteBuffer container) {
super(container, container.remaining() / SIZEOF);
}
public Buffer(long address, int cap) {
super(address, null, -1, 0, cap, cap);
}
Buffer(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
super(address, container, mark, pos, lim, cap);
}
@Override
protected Buffer self() {
return this;
}
@Override
protected OVRTrackingState getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return a {@link OVRPoseStatef} view of the {@link OVRTrackingState#HeadPose} field. */
@NativeType("ovrPoseStatef")
public OVRPoseStatef HeadPose() { return OVRTrackingState.nHeadPose(address()); }
/** @return the value of the {@link OVRTrackingState#StatusFlags} field. */
@NativeType("unsigned int")
public int StatusFlags() { return OVRTrackingState.nStatusFlags(address()); }
/** @return a {@link OVRPoseStatef}.Buffer view of the {@link OVRTrackingState#HandPoses} field. */
@NativeType("ovrPoseStatef[2]")
public OVRPoseStatef.Buffer HandPoses() { return OVRTrackingState.nHandPoses(address()); }
/** @return a {@link OVRPoseStatef} view of the struct at the specified index of the {@link OVRTrackingState#HandPoses} field. */
@NativeType("ovrPoseStatef")
public OVRPoseStatef HandPoses(int index) { return OVRTrackingState.nHandPoses(address(), index); }
/** @return a {@link IntBuffer} view of the {@link OVRTrackingState#HandStatusFlags} field. */
@NativeType("unsigned int[2]")
public IntBuffer HandStatusFlags() { return OVRTrackingState.nHandStatusFlags(address()); }
/** @return the value at the specified index of the {@link OVRTrackingState#HandStatusFlags} field. */
@NativeType("unsigned int")
public int HandStatusFlags(int index) { return OVRTrackingState.nHandStatusFlags(address(), index); }
/** @return a {@link OVRPosef} view of the {@link OVRTrackingState#CalibratedOrigin} field. */
@NativeType("ovrPosef")
public OVRPosef CalibratedOrigin() { return OVRTrackingState.nCalibratedOrigin(address()); }
}
}