org.lwjgl.ovr.OVREyeRenderDesc 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.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* rendering information for each eye. Computed by either {@link OVR#ovr_GetRenderDesc GetRenderDesc} based on the specified FOV. Note that the rendering viewport is not
* included here as it can be specified separately and modified per frame by passing different viewport values in the layer structure.
*
* Layout
*
*
* struct ovrEyeRenderDesc {
* ovrEyeType {@link #Eye};
* {@link OVRFovPort ovrFovPort} {@link #Fov};
* {@link OVRRecti ovrRecti} {@link #DistortedViewport};
* {@link OVRVector2f ovrVector2f} {@link #PixelsPerTanAngleAtCenter};
* {@link OVRPosef ovrPosef} {@link #HmdToEyePose};
* }
*/
@NativeType("struct ovrEyeRenderDesc")
public class OVREyeRenderDesc 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
EYE,
FOV,
DISTORTEDVIEWPORT,
PIXELSPERTANANGLEATCENTER,
HMDTOEYEPOSE;
static {
Layout layout = __struct(
__member(4),
__member(OVRFovPort.SIZEOF, OVRFovPort.ALIGNOF),
__member(OVRRecti.SIZEOF, OVRRecti.ALIGNOF),
__member(OVRVector2f.SIZEOF, OVRVector2f.ALIGNOF),
__member(OVRPosef.SIZEOF, OVRPosef.ALIGNOF)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
EYE = layout.offsetof(0);
FOV = layout.offsetof(1);
DISTORTEDVIEWPORT = layout.offsetof(2);
PIXELSPERTANANGLEATCENTER = layout.offsetof(3);
HMDTOEYEPOSE = layout.offsetof(4);
}
protected OVREyeRenderDesc(long address, @Nullable ByteBuffer container) {
super(address, container);
}
@Override
protected OVREyeRenderDesc create(long address, @Nullable ByteBuffer container) {
return new OVREyeRenderDesc(address, container);
}
/**
* Creates a {@code OVREyeRenderDesc} 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 OVREyeRenderDesc(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** the eye index this instance corresponds to. One of:
{@link OVR#ovrEye_Left Eye_Left} {@link OVR#ovrEye_Right Eye_Right}
*/
@NativeType("ovrEyeType")
public int Eye() { return nEye(address()); }
/** the field of view */
@NativeType("ovrFovPort")
public OVRFovPort Fov() { return nFov(address()); }
/** distortion viewport */
@NativeType("ovrRecti")
public OVRRecti DistortedViewport() { return nDistortedViewport(address()); }
/** wow many display pixels will fit in tan(angle) = 1 */
@NativeType("ovrVector2f")
public OVRVector2f PixelsPerTanAngleAtCenter() { return nPixelsPerTanAngleAtCenter(address()); }
/** transform of eye from the HMD center, in meters */
@NativeType("ovrPosef")
public OVRPosef HmdToEyePose() { return nHmdToEyePose(address()); }
// -----------------------------------
/** Returns a new {@code OVREyeRenderDesc} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static OVREyeRenderDesc malloc() {
return new OVREyeRenderDesc(nmemAllocChecked(SIZEOF), null);
}
/** Returns a new {@code OVREyeRenderDesc} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static OVREyeRenderDesc calloc() {
return new OVREyeRenderDesc(nmemCallocChecked(1, SIZEOF), null);
}
/** Returns a new {@code OVREyeRenderDesc} instance allocated with {@link BufferUtils}. */
public static OVREyeRenderDesc create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return new OVREyeRenderDesc(memAddress(container), container);
}
/** Returns a new {@code OVREyeRenderDesc} instance for the specified memory address. */
public static OVREyeRenderDesc create(long address) {
return new OVREyeRenderDesc(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static OVREyeRenderDesc createSafe(long address) {
return address == NULL ? null : new OVREyeRenderDesc(address, null);
}
/**
* Returns a new {@link OVREyeRenderDesc.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static OVREyeRenderDesc.Buffer malloc(int capacity) {
return new Buffer(nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link OVREyeRenderDesc.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static OVREyeRenderDesc.Buffer calloc(int capacity) {
return new Buffer(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link OVREyeRenderDesc.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static OVREyeRenderDesc.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return new Buffer(memAddress(container), container, -1, 0, capacity, capacity);
}
/**
* Create a {@link OVREyeRenderDesc.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static OVREyeRenderDesc.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 OVREyeRenderDesc.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 OVREyeRenderDesc mallocStack() { return malloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static OVREyeRenderDesc callocStack() { return calloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(MemoryStack)} instead. */
@Deprecated public static OVREyeRenderDesc mallocStack(MemoryStack stack) { return malloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static OVREyeRenderDesc callocStack(MemoryStack stack) { return calloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static OVREyeRenderDesc.Buffer mallocStack(int capacity) { return malloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(int, MemoryStack)} instead. */
@Deprecated public static OVREyeRenderDesc.Buffer callocStack(int capacity) { return calloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static OVREyeRenderDesc.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 OVREyeRenderDesc.Buffer callocStack(int capacity, MemoryStack stack) { return calloc(capacity, stack); }
/**
* Returns a new {@code OVREyeRenderDesc} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static OVREyeRenderDesc malloc(MemoryStack stack) {
return new OVREyeRenderDesc(stack.nmalloc(ALIGNOF, SIZEOF), null);
}
/**
* Returns a new {@code OVREyeRenderDesc} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static OVREyeRenderDesc calloc(MemoryStack stack) {
return new OVREyeRenderDesc(stack.ncalloc(ALIGNOF, 1, SIZEOF), null);
}
/**
* Returns a new {@link OVREyeRenderDesc.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static OVREyeRenderDesc.Buffer malloc(int capacity, MemoryStack stack) {
return new Buffer(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link OVREyeRenderDesc.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 OVREyeRenderDesc.Buffer calloc(int capacity, MemoryStack stack) {
return new Buffer(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #Eye}. */
public static int nEye(long struct) { return UNSAFE.getInt(null, struct + OVREyeRenderDesc.EYE); }
/** Unsafe version of {@link #Fov}. */
public static OVRFovPort nFov(long struct) { return OVRFovPort.create(struct + OVREyeRenderDesc.FOV); }
/** Unsafe version of {@link #DistortedViewport}. */
public static OVRRecti nDistortedViewport(long struct) { return OVRRecti.create(struct + OVREyeRenderDesc.DISTORTEDVIEWPORT); }
/** Unsafe version of {@link #PixelsPerTanAngleAtCenter}. */
public static OVRVector2f nPixelsPerTanAngleAtCenter(long struct) { return OVRVector2f.create(struct + OVREyeRenderDesc.PIXELSPERTANANGLEATCENTER); }
/** Unsafe version of {@link #HmdToEyePose}. */
public static OVRPosef nHmdToEyePose(long struct) { return OVRPosef.create(struct + OVREyeRenderDesc.HMDTOEYEPOSE); }
// -----------------------------------
/** An array of {@link OVREyeRenderDesc} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final OVREyeRenderDesc ELEMENT_FACTORY = OVREyeRenderDesc.create(-1L);
/**
* Creates a new {@code OVREyeRenderDesc.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 OVREyeRenderDesc#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 OVREyeRenderDesc getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link OVREyeRenderDesc#Eye} field. */
@NativeType("ovrEyeType")
public int Eye() { return OVREyeRenderDesc.nEye(address()); }
/** @return a {@link OVRFovPort} view of the {@link OVREyeRenderDesc#Fov} field. */
@NativeType("ovrFovPort")
public OVRFovPort Fov() { return OVREyeRenderDesc.nFov(address()); }
/** @return a {@link OVRRecti} view of the {@link OVREyeRenderDesc#DistortedViewport} field. */
@NativeType("ovrRecti")
public OVRRecti DistortedViewport() { return OVREyeRenderDesc.nDistortedViewport(address()); }
/** @return a {@link OVRVector2f} view of the {@link OVREyeRenderDesc#PixelsPerTanAngleAtCenter} field. */
@NativeType("ovrVector2f")
public OVRVector2f PixelsPerTanAngleAtCenter() { return OVREyeRenderDesc.nPixelsPerTanAngleAtCenter(address()); }
/** @return a {@link OVRPosef} view of the {@link OVREyeRenderDesc#HmdToEyePose} field. */
@NativeType("ovrPosef")
public OVRPosef HmdToEyePose() { return OVREyeRenderDesc.nHmdToEyePose(address()); }
}
}