Package org.lwjgl.ovr

Class OVRLayerEyeMatrix

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

    public class OVRLayerEyeMatrix
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Describes a layer that specifies a monoscopic or stereoscopic view.

    This uses a direct 3x4 matrix to map from view space to the UV coordinates. It is essentially the same thing as OVRLayerEyeFov but using a much lower level. This is mainly to provide compatibility with specific apps. Unless the application really requires this flexibility, it is usually better to use ovrLayerEyeFov.

    Three options exist with respect to mono/stereo texture usage:

    • ColorTexture[0] and ColorTexture[1] contain the left and right stereo renderings, respectively. Viewport[0] and Viewport[1] refer to ColorTexture[0] and ColorTexture[1], respectively.
    • ColorTexture[0] contains both the left and right renderings, ColorTexture[1] is NULL, and Viewport[0] and Viewport[1] refer to sub-rects with ColorTexture[0].
    • ColorTexture[0] contains a single monoscopic rendering, and Viewport[0] and Viewport[1] both refer to that rendering.

    Member documentation

    • HeaderHeader.Type must be LayerType_EyeMatrix
    • ColorTexture[ovrEye_Count]ovrTextureSwapChains for the left and right eye respectively. The second one of which can be NULL for cases described above.
    • Viewport[ovrEye_Count] – specifies the ColorTexture sub-rect UV coordinates. Both Viewport[0] and Viewport[1] must be valid.
    • RenderPose[ovrEye_Count] – specifies the position and orientation of each eye view, with the position specified in meters. RenderPose will typically be the value returned from _CalcEyePoses, but can be different in special cases if a different head pose is used for rendering.
    • Matrix[ovrEye_Count] – specifies the mapping from a view-space vector to a UV coordinate on the textures given above.
      
       P = (x,y,z,1)*Matrix
       TexU  = P.x/P.z
       TexV  = P.y/P.z
    • SensorSampleTime – specifies the timestamp when the source ovrPosef (used in calculating RenderPose) was sampled from the SDK. Typically retrieved by calling GetTimeInSeconds around the instant the application calls GetTrackingState The main purpose for this is to accurately track app tracking latency.

    Layout

    
     struct ovrLayerEyeMatrix {
         ovrLayerHeader Header;
         ovrTextureSwapChain ColorTexture[ovrEye_Count];
         ovrRecti Viewport[ovrEye_Count];
         ovrPosef RenderPose[ovrEye_Count];
         ovrMatrix4f Matrix[ovrEye_Count];
         double SensorSampleTime;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • HEADER, COLORTEXTURE, VIEWPORT, RENDERPOSE, MATRIX, SENSORSAMPLETIME

        The struct member offsets.
    • Constructor Detail

      • OVRLayerEyeMatrix

        public OVRLayerEyeMatrix​(java.nio.ByteBuffer container)
        Creates a OVRLayerEyeMatrix 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

      • sizeof

        public int sizeof()
        Specified by:
        sizeof in class org.lwjgl.system.Struct
      • ColorTexture

        public org.lwjgl.PointerBuffer ColorTexture()
        Returns a PointerBuffer view of the ColorTexture field.
      • ColorTexture

        public long ColorTexture​(int index)
        Returns the value at the specified index of the ColorTexture field.
      • Viewport

        public OVRRecti Viewport​(int index)
        Returns a OVRRecti view of the struct at the specified index of the Viewport field.
      • RenderPose

        public OVRPosef RenderPose​(int index)
        Returns a OVRPosef view of the struct at the specified index of the RenderPose field.
      • Matrix

        public OVRMatrix4f Matrix​(int index)
        Returns a OVRMatrix4f view of the struct at the specified index of the Matrix field.
      • SensorSampleTime

        public double SensorSampleTime()
        Returns the value of the SensorSampleTime field.
      • ColorTexture

        public OVRLayerEyeMatrix ColorTexture​(org.lwjgl.PointerBuffer value)
        Copies the specified PointerBuffer to the ColorTexture field.
      • ColorTexture

        public OVRLayerEyeMatrix ColorTexture​(int index,
                                              long value)
        Sets the specified value at the specified index of the ColorTexture field.
      • Viewport

        public OVRLayerEyeMatrix Viewport​(int index,
                                          java.util.function.Consumer<OVRRecti> consumer)
        Passes the element at index of the Viewport field to the specified Consumer.
      • RenderPose

        public OVRLayerEyeMatrix RenderPose​(java.util.function.Consumer<OVRPosef.Buffer> consumer)
        Passes the RenderPose field to the specified Consumer.
      • RenderPose

        public OVRLayerEyeMatrix RenderPose​(int index,
                                            java.util.function.Consumer<OVRPosef> consumer)
        Passes the element at index of the RenderPose field to the specified Consumer.
      • Matrix

        public OVRLayerEyeMatrix Matrix​(int index,
                                        java.util.function.Consumer<OVRMatrix4f> consumer)
        Passes the element at index of the Matrix field to the specified Consumer.
      • SensorSampleTime

        public OVRLayerEyeMatrix SensorSampleTime​(double value)
        Sets the specified value to the SensorSampleTime field.
      • malloc

        public static OVRLayerEyeMatrix malloc()
        Returns a new OVRLayerEyeMatrix instance allocated with memAlloc. The instance must be explicitly freed.
      • calloc

        public static OVRLayerEyeMatrix calloc()
        Returns a new OVRLayerEyeMatrix instance allocated with memCalloc. The instance must be explicitly freed.
      • create

        public static OVRLayerEyeMatrix create()
        Returns a new OVRLayerEyeMatrix instance allocated with BufferUtils.
      • create

        public static OVRLayerEyeMatrix create​(long address)
        Returns a new OVRLayerEyeMatrix instance for the specified memory address.
      • createSafe

        @Nullable
        public static OVRLayerEyeMatrix createSafe​(long address)
        Like create, but returns null if address is NULL.
      • createSafe

        @Nullable
        public static OVRLayerEyeMatrix.Buffer createSafe​(long address,
                                                          int capacity)
        Like create, but returns null if address is NULL.
      • mallocStack

        public static OVRLayerEyeMatrix mallocStack()
        Returns a new OVRLayerEyeMatrix instance allocated on the thread-local MemoryStack.
      • callocStack

        public static OVRLayerEyeMatrix callocStack()
        Returns a new OVRLayerEyeMatrix instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      • mallocStack

        public static OVRLayerEyeMatrix mallocStack​(org.lwjgl.system.MemoryStack stack)
        Returns a new OVRLayerEyeMatrix instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
      • callocStack

        public static OVRLayerEyeMatrix callocStack​(org.lwjgl.system.MemoryStack stack)
        Returns a new OVRLayerEyeMatrix instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
      • callocStack

        public static OVRLayerEyeMatrix.Buffer callocStack​(int capacity)
        Returns a new OVRLayerEyeMatrix.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
        Parameters:
        capacity - the buffer capacity
      • mallocStack

        public static OVRLayerEyeMatrix.Buffer mallocStack​(int capacity,
                                                           org.lwjgl.system.MemoryStack stack)
        Returns a new OVRLayerEyeMatrix.Buffer instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity
      • callocStack

        public static OVRLayerEyeMatrix.Buffer callocStack​(int capacity,
                                                           org.lwjgl.system.MemoryStack stack)
        Returns a new OVRLayerEyeMatrix.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity
      • nColorTexture

        public static org.lwjgl.PointerBuffer nColorTexture​(long struct)
        Unsafe version of ColorTexture().
      • nColorTexture

        public static long nColorTexture​(long struct,
                                         int index)
        Unsafe version of ColorTexture.
      • nViewport

        public static OVRRecti nViewport​(long struct,
                                         int index)
        Unsafe version of Viewport.
      • nRenderPose

        public static OVRPosef nRenderPose​(long struct,
                                           int index)
        Unsafe version of RenderPose.
      • nMatrix

        public static OVRMatrix4f nMatrix​(long struct,
                                          int index)
        Unsafe version of Matrix.
      • nSensorSampleTime

        public static double nSensorSampleTime​(long struct)
        Unsafe version of SensorSampleTime().
      • nHeader

        public static void nHeader​(long struct,
                                   OVRLayerHeader value)
        Unsafe version of Header.
      • nColorTexture

        public static void nColorTexture​(long struct,
                                         org.lwjgl.PointerBuffer value)
        Unsafe version of ColorTexture.
      • nColorTexture

        public static void nColorTexture​(long struct,
                                         int index,
                                         long value)
        Unsafe version of ColorTexture.
      • nViewport

        public static void nViewport​(long struct,
                                     int index,
                                     OVRRecti value)
        Unsafe version of Viewport.
      • nRenderPose

        public static void nRenderPose​(long struct,
                                       int index,
                                       OVRPosef value)
        Unsafe version of RenderPose.
      • nMatrix

        public static void nMatrix​(long struct,
                                   int index,
                                   OVRMatrix4f value)
        Unsafe version of Matrix.
      • nSensorSampleTime

        public static void nSensorSampleTime​(long struct,
                                             double value)
        Unsafe version of SensorSampleTime.
      • validate

        public static void validate​(long struct)
        Validates pointer members that should not be NULL.
        Parameters:
        struct - the struct to validate
      • validate

        public static void validate​(long array,
                                    int count)
        Calls validate(long) for each struct contained in the specified struct array.
        Parameters:
        array - the struct array to validate
        count - the number of structs in array