Top Description Inners Fields Constructors Methods
org.lwjgl.ovr

public Class OVREyeRenderDesc

extends Struct<OVREyeRenderDesc>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct ovrEyeRenderDesc
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

rendering information for each eye. Computed by either 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 Eye;
    ovrFovPort Fov;
    ovrRecti DistortedViewport;
    ovrVector2f PixelsPerTanAngleAtCenter;
    ovrPosef HmdToEyePose;
}

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
DISTORTEDVIEWPORT

The struct member offsets.

public static final int
EYE

The struct member offsets.

public static final int
FOV

The struct member offsets.

public static final int
HMDTOEYEPOSE

The struct member offsets.

public static final int
PIXELSPERTANANGLEATCENTER

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
OVREyeRenderDesc(long address, ByteBuffer container)

public
OVREyeRenderDesc(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static OVREyeRenderDesc
calloc()

Returns a new OVREyeRenderDesc instance allocated with memCalloc.

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

Returns a new OVREyeRenderDesc.Buffer instance allocated with memCalloc.

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

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

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

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

public static OVREyeRenderDesc
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static OVREyeRenderDesc
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static OVREyeRenderDesc.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static OVREyeRenderDesc.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected OVREyeRenderDesc
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 OVREyeRenderDesc
create()

Returns a new OVREyeRenderDesc instance allocated with BufferUtils.

public static OVREyeRenderDesc
create(long address)

Returns a new OVREyeRenderDesc instance for the specified memory address.

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

Returns a new OVREyeRenderDesc.Buffer instance allocated with BufferUtils.

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

Create a OVREyeRenderDesc.Buffer instance at the specified memory.

public static OVREyeRenderDesc
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public OVRRecti
DistortedViewport()

distortion viewport

public int
Eye()

the eye index this instance corresponds to.

public OVRFovPort
Fov()

the field of view

public OVRPosef
HmdToEyePose()

transform of eye from the HMD center, in meters

public static OVREyeRenderDesc
malloc()

Returns a new OVREyeRenderDesc instance allocated with memAlloc.

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

Returns a new OVREyeRenderDesc.Buffer instance allocated with memAlloc.

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

Returns a new OVREyeRenderDesc instance allocated on the specified MemoryStack.

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

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

public static OVREyeRenderDesc
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static OVREyeRenderDesc
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static OVREyeRenderDesc.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static OVREyeRenderDesc.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static OVRRecti
nDistortedViewport(long struct)

Unsafe version of DistortedViewport.

public static int
nEye(long struct)

Unsafe version of Eye.

public static OVRFovPort
nFov(long struct)

Unsafe version of Fov.

public static OVRPosef
nHmdToEyePose(long struct)

Unsafe version of HmdToEyePose.

public static OVRVector2f
public OVRVector2f
PixelsPerTanAngleAtCenter()

wow many display pixels will fit in tan(angle) = 1

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.

DISTORTEDVIEWPORTback to summary
public static final int DISTORTEDVIEWPORT

The struct member offsets.

EYEback to summary
public static final int EYE

The struct member offsets.

FOVback to summary
public static final int FOV

The struct member offsets.

HMDTOEYEPOSEback to summary
public static final int HMDTOEYEPOSE

The struct member offsets.

PIXELSPERTANANGLEATCENTERback to summary
public static final int PIXELSPERTANANGLEATCENTER

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

OVREyeRenderDescback to summary
protected OVREyeRenderDesc(long address, ByteBuffer container)
OVREyeRenderDescback to summary
public OVREyeRenderDesc(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static OVREyeRenderDesc calloc(MemoryStack stack)

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

Returns a new OVREyeRenderDesc.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

callocStackback to summary
public static OVREyeRenderDesc callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static OVREyeRenderDesc callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static OVREyeRenderDesc.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static OVREyeRenderDesc.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected OVREyeRenderDesc 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 OVREyeRenderDesc create()

Returns a new OVREyeRenderDesc instance allocated with BufferUtils.

createback to summary
public static OVREyeRenderDesc create(long address)

Returns a new OVREyeRenderDesc instance for the specified memory address.

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

Returns a new OVREyeRenderDesc.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a OVREyeRenderDesc.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static OVREyeRenderDesc createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
DistortedViewportback to summary
public OVRRecti DistortedViewport()

distortion viewport

Annotations
@NativeType:ovrRecti
Eyeback to summary
public int Eye()

the eye index this instance corresponds to. One of:

Eye_LeftEye_Right
Annotations
@NativeType:ovrEyeType
Fovback to summary
public OVRFovPort Fov()

the field of view

Annotations
@NativeType:ovrFovPort
HmdToEyePoseback to summary
public OVRPosef HmdToEyePose()

transform of eye from the HMD center, in meters

Annotations
@NativeType:ovrPosef
mallocback to summary
public static OVREyeRenderDesc malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static OVREyeRenderDesc malloc(MemoryStack stack)

Returns a new OVREyeRenderDesc instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static OVREyeRenderDesc mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static OVREyeRenderDesc mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static OVREyeRenderDesc.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static OVREyeRenderDesc.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nDistortedViewportback to summary
public static OVRRecti nDistortedViewport(long struct)

Unsafe version of DistortedViewport.

nEyeback to summary
public static int nEye(long struct)

Unsafe version of Eye.

nFovback to summary
public static OVRFovPort nFov(long struct)

Unsafe version of Fov.

nHmdToEyePoseback to summary
public static OVRPosef nHmdToEyePose(long struct)

Unsafe version of HmdToEyePose.

nPixelsPerTanAngleAtCenterback to summary
public static OVRVector2f nPixelsPerTanAngleAtCenter(long struct)

Unsafe version of PixelsPerTanAngleAtCenter.

PixelsPerTanAngleAtCenterback to summary
public OVRVector2f PixelsPerTanAngleAtCenter()

wow many display pixels will fit in tan(angle) = 1

Annotations
@NativeType:ovrVector2f
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.ovr back to summary

public Class OVREyeRenderDesc.Buffer

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

An array of OVREyeRenderDesc structs.

Field Summary

Modifier and TypeField and Description
private static final OVREyeRenderDesc

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new OVREyeRenderDesc.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
public OVRRecti
public int

Returns:

the value of the OVREyeRenderDesc#Eye field.
Eye
()

public OVRFovPort

Returns:

a OVRFovPort view of the OVREyeRenderDesc#Fov field.
Fov
()

protected OVREyeRenderDesc
public OVRPosef

Returns:

a OVRPosef view of the OVREyeRenderDesc#HmdToEyePose field.
HmdToEyePose
()

public OVRVector2f
protected OVREyeRenderDesc.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final OVREyeRenderDesc ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new 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 OVREyeRenderDesc#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

DistortedViewportback to summary
public OVRRecti DistortedViewport()
Returns:OVRRecti

a OVRRecti view of the OVREyeRenderDesc#DistortedViewport field.

Annotations
@NativeType:ovrRecti
Eyeback to summary
public int Eye()
Returns:int

the value of the OVREyeRenderDesc#Eye field.

Annotations
@NativeType:ovrEyeType
Fovback to summary
public OVRFovPort Fov()
Returns:OVRFovPort

a OVRFovPort view of the OVREyeRenderDesc#Fov field.

Annotations
@NativeType:ovrFovPort
getElementFactoryback to summary
protected OVREyeRenderDesc getElementFactory()

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

Annotations
@Override
HmdToEyePoseback to summary
public OVRPosef HmdToEyePose()
Returns:OVRPosef

a OVRPosef view of the OVREyeRenderDesc#HmdToEyePose field.

Annotations
@NativeType:ovrPosef
PixelsPerTanAngleAtCenterback to summary
public OVRVector2f PixelsPerTanAngleAtCenter()
Returns:OVRVector2f

a OVRVector2f view of the OVREyeRenderDesc#PixelsPerTanAngleAtCenter field.

Annotations
@NativeType:ovrVector2f
selfback to summary
protected OVREyeRenderDesc.Buffer self()

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

Annotations
@Override