Class OsvrDisplayLibrary

java.lang.Object
com.jme3.system.osvr.osvrdisplay.OsvrDisplayLibrary
All Implemented Interfaces:
com.sun.jna.Library

public class OsvrDisplayLibrary extends Object implements com.sun.jna.Library
JNA Wrapper for library osvrDisplay
This file was autogenerated by JNAerator,
a tool written by Olivier Chafik that uses a few opensource projects..
For help, please visit NativeLibs4Java , Rococoa, or JNA.
  • Field Details

    • JNA_LIBRARY_NAME

      public static final String JNA_LIBRARY_NAME
      See Also:
    • JNA_NATIVE_LIB

      public static final com.sun.jna.NativeLibrary JNA_NATIVE_LIB
  • Constructor Details

    • OsvrDisplayLibrary

      public OsvrDisplayLibrary()
  • Method Details

    • osvrClientGetDisplay

      @Deprecated public static byte osvrClientGetDisplay(com.sun.jna.Pointer ctx, com.sun.jna.Pointer disp)
      Allocates a display configuration object populated with data from the
      OSVR system.
      Before this call will succeed, your application will need to be correctly
      and fully connected to an OSVR server. You may consider putting this call in
      a loop alternating with osvrClientUpdate() until this call succeeds.
      Data provided by a display configuration object:
      - The logical display topology (number and relationship of viewers, eyes,
      and surfaces), which remains constant throughout the life of the
      configuration object. (A method of notification of change here is TBD).
      - Pose data for viewers (not required for rendering) and pose/view data for
      eyes (used for rendering) which is based on tracker data: if used, these
      should be queried every frame.
      - Projection matrix data for surfaces, which while in current practice may
      be relatively unchanging, we are not guaranteeing them to be constant:
      these should be queried every frame.
      - Video-input-relative viewport size/location for a surface: would like this
      to be variable, but probably not feasible. If you have input, please
      comment on the dev mailing list.
      - Per-surface distortion strategy priorities/availabilities: constant. Note
      the following, though...
      - Per-surface distortion strategy parameters: variable, request each frame.
      (Could make constant with a notification if needed?)
      Important note: While most of this data is immediately available if you are
      successful in getting a display config object, the pose-based data (viewer
      pose, eye pose, eye view matrix) needs tracker state, so at least one (and in
      practice, typically more) osvrClientUpdate() must be performed before a new
      tracker report is available to populate that state. See
      osvrClientCheckDisplayStartup() to query if all startup data is available.
      todo Decide if relative viewport should be constant in a display config,
      and update docs accordingly.
      todo Decide if distortion params should be constant in a display config,
      and update docs accordingly.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed or some other
      error occurred, in which case the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetDisplay(OSVR_ClientContext, OSVR_DisplayConfig*)
    • osvrClientGetDisplay

      public static byte osvrClientGetDisplay(OsvrClientKitLibrary.OSVR_ClientContext ctx, com.sun.jna.ptr.PointerByReference disp)
      Allocates a display configuration object populated with data from the
      OSVR system.
      Before this call will succeed, your application will need to be correctly
      and fully connected to an OSVR server. You may consider putting this call in
      a loop alternating with osvrClientUpdate() until this call succeeds.
      Data provided by a display configuration object:
      - The logical display topology (number and relationship of viewers, eyes,
      and surfaces), which remains constant throughout the life of the
      configuration object. (A method of notification of change here is TBD).
      - Pose data for viewers (not required for rendering) and pose/view data for
      eyes (used for rendering) which is based on tracker data: if used, these
      should be queried every frame.
      - Projection matrix data for surfaces, which while in current practice may
      be relatively unchanging, we are not guaranteeing them to be constant:
      these should be queried every frame.
      - Video-input-relative viewport size/location for a surface: would like this
      to be variable, but probably not feasible. If you have input, please
      comment on the dev mailing list.
      - Per-surface distortion strategy priorities/availabilities: constant. Note
      the following, though...
      - Per-surface distortion strategy parameters: variable, request each frame.
      (Could make constant with a notification if needed?)
      Important note: While most of this data is immediately available if you are
      successful in getting a display config object, the pose-based data (viewer
      pose, eye pose, eye view matrix) needs tracker state, so at least one (and in
      practice, typically more) osvrClientUpdate() must be performed before a new
      tracker report is available to populate that state. See
      osvrClientCheckDisplayStartup() to query if all startup data is available.
      todo Decide if relative viewport should be constant in a display config,
      and update docs accordingly.
      todo Decide if distortion params should be constant in a display config,
      and update docs accordingly.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed or some other
      error occurred, in which case the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetDisplay(OSVR_ClientContext, OSVR_DisplayConfig*)
    • osvrClientGetDisplay

      public static byte osvrClientGetDisplay(com.sun.jna.Pointer ctx, com.sun.jna.ptr.PointerByReference disp)
      Allocates a display configuration object populated with data from the
      OSVR system.
      Before this call will succeed, your application will need to be correctly
      and fully connected to an OSVR server. You may consider putting this call in
      a loop alternating with osvrClientUpdate() until this call succeeds.
      Data provided by a display configuration object:
      - The logical display topology (number and relationship of viewers, eyes,
      and surfaces), which remains constant throughout the life of the
      configuration object. (A method of notification of change here is TBD).
      - Pose data for viewers (not required for rendering) and pose/view data for
      eyes (used for rendering) which is based on tracker data: if used, these
      should be queried every frame.
      - Projection matrix data for surfaces, which while in current practice may
      be relatively unchanging, we are not guaranteeing them to be constant:
      these should be queried every frame.
      - Video-input-relative viewport size/location for a surface: would like this
      to be variable, but probably not feasible. If you have input, please
      comment on the dev mailing list.
      - Per-surface distortion strategy priorities/availabilities: constant. Note
      the following, though...
      - Per-surface distortion strategy parameters: variable, request each frame.
      (Could make constant with a notification if needed?)
      Important note: While most of this data is immediately available if you are
      successful in getting a display config object, the pose-based data (viewer
      pose, eye pose, eye view matrix) needs tracker state, so at least one (and in
      practice, typically more) osvrClientUpdate() must be performed before a new
      tracker report is available to populate that state. See
      osvrClientCheckDisplayStartup() to query if all startup data is available.
      todo Decide if relative viewport should be constant in a display config,
      and update docs accordingly.
      todo Decide if distortion params should be constant in a display config,
      and update docs accordingly.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed or some other
      error occurred, in which case the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetDisplay(OSVR_ClientContext, OSVR_DisplayConfig*)
    • osvrClientFreeDisplay

      @Deprecated public static byte osvrClientFreeDisplay(com.sun.jna.Pointer disp)
      Frees a display configuration object. The corresponding context must
      still be open.
      If you fail to call this, it will be automatically called as part of
      clean-up when the corresponding context is closed.
      Returns:
      OSVR_RETURN_FAILURE if a null config was passed, or if the given
      display object was already freed.
      Original signature : OSVR_ReturnCode osvrClientFreeDisplay(OSVR_DisplayConfig)
    • osvrClientFreeDisplay

      public static byte osvrClientFreeDisplay(OsvrDisplayLibrary.OSVR_DisplayConfig disp)
      Frees a display configuration object. The corresponding context must
      still be open.
      If you fail to call this, it will be automatically called as part of
      clean-up when the corresponding context is closed.
      Returns:
      OSVR_RETURN_FAILURE if a null config was passed, or if the given
      display object was already freed.
      Original signature : OSVR_ReturnCode osvrClientFreeDisplay(OSVR_DisplayConfig)
    • osvrClientCheckDisplayStartup

      @Deprecated public static byte osvrClientCheckDisplayStartup(com.sun.jna.Pointer disp)
      Checks to see if a display is fully configured and ready, including
      having received its first pose update.
      Once this first succeeds, it will continue to succeed for the lifetime of
      the display config object, so it is not necessary to keep calling once you
      get a successful result.
      Returns:
      OSVR_RETURN_FAILURE if a null config was passed, or if the given
      display config object was otherwise not ready for full use.
      Original signature : OSVR_ReturnCode osvrClientCheckDisplayStartup(OSVR_DisplayConfig)
    • osvrClientCheckDisplayStartup

      public static byte osvrClientCheckDisplayStartup(OsvrDisplayLibrary.OSVR_DisplayConfig disp)
      Checks to see if a display is fully configured and ready, including
      having received its first pose update.
      Once this first succeeds, it will continue to succeed for the lifetime of
      the display config object, so it is not necessary to keep calling once you
      get a successful result.
      Returns:
      OSVR_RETURN_FAILURE if a null config was passed, or if the given
      display config object was otherwise not ready for full use.
      Original signature : OSVR_ReturnCode osvrClientCheckDisplayStartup(OSVR_DisplayConfig)
    • osvrClientGetNumDisplayInputs

      @Deprecated public static byte osvrClientGetNumDisplayInputs(com.sun.jna.Pointer disp, com.sun.jna.Pointer numDisplayInputs)
      A display config can have one or more display inputs to pass pixels
      over (HDMI/DVI connections, etcetera): retrieve the number of display inputs in
      the current configuration.
      Parameters:
      disp - Display config object.
      numDisplayInputs - Number of display inputs in the logical display
      topology, **constant** throughout the active, valid lifetime of a display
      config object.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed, in
      which case the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetNumDisplayInputs(OSVR_DisplayConfig, OSVR_DisplayInputCount*)
    • osvrClientGetNumDisplayInputs

      public static byte osvrClientGetNumDisplayInputs(OsvrDisplayLibrary.OSVR_DisplayConfig disp, ByteBuffer numDisplayInputs)
      A display config can have one or more display inputs to pass pixels
      over (HDMI/DVI connections, etcetera): retrieve the number of display inputs in
      the current configuration.
      Parameters:
      disp - Display config object.
      numDisplayInputs - Number of display inputs in the logical display
      topology, **constant** throughout the active, valid lifetime of a display
      config object.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed, in
      which case the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetNumDisplayInputs(OSVR_DisplayConfig, OSVR_DisplayInputCount*)
    • osvrClientGetDisplayDimensions

      @Deprecated public static byte osvrClientGetDisplayDimensions(com.sun.jna.Pointer disp, byte displayInputIndex, com.sun.jna.ptr.IntByReference width, com.sun.jna.ptr.IntByReference height)
      Retrieve the pixel dimensions of a given display input for a display
      config
      Parameters:
      disp - Display config object.
      displayInputIndex - The zero-based index of the display input.
      width - Width (in pixels) of the display input.
      height - Height (in pixels) of the display input.
      The out parameters are **constant** throughout the active, valid lifetime of
      a display config object.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed, in
      which case the output arguments are unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetDisplayDimensions(OSVR_DisplayConfig, OSVR_DisplayInputCount, OSVR_DisplayDimension*, OSVR_DisplayDimension*)
    • osvrClientGetDisplayDimensions

      public static byte osvrClientGetDisplayDimensions(OsvrDisplayLibrary.OSVR_DisplayConfig disp, byte displayInputIndex, IntBuffer width, IntBuffer height)
      Retrieve the pixel dimensions of a given display input for a display
      config
      Parameters:
      disp - Display config object.
      displayInputIndex - The zero-based index of the display input.
      width - Width (in pixels) of the display input.
      height - Height (in pixels) of the display input.
      The out parameters are **constant** throughout the active, valid lifetime of
      a display config object.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed, in
      which case the output arguments are unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetDisplayDimensions(OSVR_DisplayConfig, OSVR_DisplayInputCount, OSVR_DisplayDimension*, OSVR_DisplayDimension*)
    • osvrClientGetNumViewers

      @Deprecated public static byte osvrClientGetNumViewers(com.sun.jna.Pointer disp, com.sun.jna.ptr.IntByReference viewers)
      A display config can have one (or theoretically more) viewers:
      retrieve the viewer count.
      Parameters:
      disp - Display config object.
      viewers - Number of viewers in the logical display topology,
      *constant** throughout the active, valid lifetime of a display config
      object.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
      the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetNumViewers(OSVR_DisplayConfig, OSVR_ViewerCount*)
    • osvrClientGetNumViewers

      public static byte osvrClientGetNumViewers(OsvrDisplayLibrary.OSVR_DisplayConfig disp, IntBuffer viewers)
      A display config can have one (or theoretically more) viewers:
      retrieve the viewer count.
      Parameters:
      disp - Display config object.
      viewers - Number of viewers in the logical display topology,
      *constant** throughout the active, valid lifetime of a display config
      object.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
      the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetNumViewers(OSVR_DisplayConfig, OSVR_ViewerCount*)
    • osvrClientGetViewerPose

      @Deprecated public static byte osvrClientGetViewerPose(com.sun.jna.Pointer disp, int viewer, com.sun.jna.Pointer pose)
      Get the pose of a viewer in a display config.
      Note that there may not necessarily be any surfaces rendered from this pose
      (it's the unused "center" eye in a stereo configuration, for instance) so
      only use this if it makes integration into your engine or existing
      applications (not originally designed for stereo) easier.
      Will only succeed if osvrClientCheckDisplayStartup() succeeds.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed or no pose was
      yet available, in which case the pose argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetViewerPose(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_Pose3*)
    • osvrClientGetViewerPose

      public static byte osvrClientGetViewerPose(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, com.sun.jna.Pointer pose)
      Get the pose of a viewer in a display config.
      Note that there may not necessarily be any surfaces rendered from this pose
      (it's the unused "center" eye in a stereo configuration, for instance) so
      only use this if it makes integration into your engine or existing
      applications (not originally designed for stereo) easier.
      Will only succeed if osvrClientCheckDisplayStartup() succeeds.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed or no pose was
      yet available, in which case the pose argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetViewerPose(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_Pose3*)
    • osvrClientGetNumEyesForViewer

      @Deprecated public static byte osvrClientGetNumEyesForViewer(com.sun.jna.Pointer disp, int viewer, com.sun.jna.Pointer eyes)
      Each viewer in a display config can have one or more "eyes" which
      have a substantially similar pose: get the count.
      Parameters:
      disp - Display config object.
      viewer - Viewer ID
      eyes - Number of eyes for this viewer in the logical display
      topology, **constant** throughout the active, valid lifetime of a display
      config object
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
      the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetNumEyesForViewer(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount*)
    • osvrClientGetNumEyesForViewer

      public static byte osvrClientGetNumEyesForViewer(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, ByteBuffer eyes)
      Each viewer in a display config can have one or more "eyes" which
      have a substantially similar pose: get the count.
      Parameters:
      disp - Display config object.
      viewer - Viewer ID
      eyes - Number of eyes for this viewer in the logical display
      topology, **constant** throughout the active, valid lifetime of a display
      config object
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
      the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetNumEyesForViewer(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount*)
    • osvrClientGetViewerEyePose

      @Deprecated public static byte osvrClientGetViewerEyePose(com.sun.jna.Pointer disp, int viewer, byte eye, com.sun.jna.Pointer pose)
      Get the "viewpoint" for the given eye of a viewer in a display
      config.
      Will only succeed if osvrClientCheckDisplayStartup() succeeds.
      Parameters:
      disp - Display config object
      viewer - Viewer ID
      eye - Eye ID
      pose - Room-space pose (not relative to pose of the viewer)
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed or no pose was
      yet available, in which case the pose argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetViewerEyePose(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_Pose3*)
    • osvrClientGetViewerEyePose

      public static byte osvrClientGetViewerEyePose(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, byte eye, com.sun.jna.Pointer pose)
      Get the "viewpoint" for the given eye of a viewer in a display
      config.
      Will only succeed if osvrClientCheckDisplayStartup() succeeds.
      Parameters:
      disp - Display config object
      viewer - Viewer ID
      eye - Eye ID
      pose - Room-space pose (not relative to pose of the viewer)
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed or no pose was
      yet available, in which case the pose argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetViewerEyePose(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_Pose3*)
    • osvrClientGetViewerEyeViewMatrixd

      @Deprecated public static byte osvrClientGetViewerEyeViewMatrixd(com.sun.jna.Pointer disp, int viewer, byte eye, short flags, com.sun.jna.ptr.DoubleByReference mat)
      Get the view matrix (inverse of pose) for the given eye of a
      viewer in a display config - matrix of **doubles**.
      Will only succeed if osvrClientCheckDisplayStartup() succeeds.
      Parameters:
      disp - Display config object
      viewer - Viewer ID
      eye - Eye ID
      flags - Bitwise OR of matrix convention flags (see @ref MatrixFlags)
      mat - Pass a double[::OSVR_MATRIX_SIZE] to get the transformation
      matrix from room space to eye space (not relative to pose of the viewer)
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed or no pose was
      yet available, in which case the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetViewerEyeViewMatrixd(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_MatrixConventions, double*)
    • osvrClientGetViewerEyeViewMatrixd

      public static byte osvrClientGetViewerEyeViewMatrixd(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, byte eye, short flags, DoubleBuffer mat)
      Get the view matrix (inverse of pose) for the given eye of a
      viewer in a display config - matrix of **doubles**.
      Will only succeed if osvrClientCheckDisplayStartup() succeeds.
      Parameters:
      disp - Display config object
      viewer - Viewer ID
      eye - Eye ID
      flags - Bitwise OR of matrix convention flags (see @ref MatrixFlags)
      mat - Pass a double[::OSVR_MATRIX_SIZE] to get the transformation
      matrix from room space to eye space (not relative to pose of the viewer)
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed or no pose was
      yet available, in which case the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetViewerEyeViewMatrixd(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_MatrixConventions, double*)
    • osvrClientGetViewerEyeViewMatrixf

      @Deprecated public static byte osvrClientGetViewerEyeViewMatrixf(com.sun.jna.Pointer disp, int viewer, byte eye, short flags, com.sun.jna.ptr.FloatByReference mat)
      Get the view matrix (inverse of pose) for the given eye of a
      viewer in a display config - matrix of **floats**.
      Will only succeed if osvrClientCheckDisplayStartup() succeeds.
      Parameters:
      disp - Display config object
      viewer - Viewer ID
      eye - Eye ID
      flags - Bitwise OR of matrix convention flags (see @ref MatrixFlags)
      mat - Pass a float[::OSVR_MATRIX_SIZE] to get the transformation
      matrix from room space to eye space (not relative to pose of the viewer)
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed or no pose was
      yet available, in which case the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetViewerEyeViewMatrixf(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_MatrixConventions, float*)
    • osvrClientGetViewerEyeViewMatrixf

      public static byte osvrClientGetViewerEyeViewMatrixf(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, byte eye, short flags, FloatBuffer mat)
      Get the view matrix (inverse of pose) for the given eye of a
      viewer in a display config - matrix of **floats**.
      Will only succeed if osvrClientCheckDisplayStartup() succeeds.
      Parameters:
      disp - Display config object
      viewer - Viewer ID
      eye - Eye ID
      flags - Bitwise OR of matrix convention flags (see @ref MatrixFlags)
      mat - Pass a float[::OSVR_MATRIX_SIZE] to get the transformation
      matrix from room space to eye space (not relative to pose of the viewer)
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed or no pose was
      yet available, in which case the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetViewerEyeViewMatrixf(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_MatrixConventions, float*)
    • osvrClientGetNumSurfacesForViewerEye

      @Deprecated public static byte osvrClientGetNumSurfacesForViewerEye(com.sun.jna.Pointer disp, int viewer, byte eye, com.sun.jna.ptr.IntByReference surfaces)
      Each eye of each viewer in a display config has one or more surfaces
      (aka "screens") on which content should be rendered.
      Parameters:
      disp - Display config object
      viewer - Viewer ID
      eye - Eye ID
      surfaces - Number of surfaces (numbered [0, surfaces - 1]) for the
      given viewer and eye. **Constant** throughout the active, valid lifetime of
      a display config object.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
      the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetNumSurfacesForViewerEye(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount*)
    • osvrClientGetNumSurfacesForViewerEye

      public static byte osvrClientGetNumSurfacesForViewerEye(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, byte eye, IntBuffer surfaces)
      Each eye of each viewer in a display config has one or more surfaces
      (aka "screens") on which content should be rendered.
      Parameters:
      disp - Display config object
      viewer - Viewer ID
      eye - Eye ID
      surfaces - Number of surfaces (numbered [0, surfaces - 1]) for the
      given viewer and eye. **Constant** throughout the active, valid lifetime of
      a display config object.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
      the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetNumSurfacesForViewerEye(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount*)
    • osvrClientGetRelativeViewportForViewerEyeSurface

      @Deprecated public static byte osvrClientGetRelativeViewportForViewerEyeSurface(com.sun.jna.Pointer disp, int viewer, byte eye, int surface, com.sun.jna.ptr.IntByReference left, com.sun.jna.ptr.IntByReference bottom, com.sun.jna.ptr.IntByReference width, com.sun.jna.ptr.IntByReference height)
      Get the dimensions/location of the viewport **within the display
      input** for a surface seen by an eye of a viewer in a display config. (This
      does not include other video inputs that may be on a single virtual desktop,
      etc. or explicitly account for display configurations that use multiple
      video inputs. It does not necessarily indicate that a viewport in the sense
      of glViewport must be created with these parameters, though the parameter
      order matches for convenience.)
      Parameters:
      disp - Display config object
      viewer - Viewer ID
      eye - Eye ID
      surface - Surface ID
      left - Output: Distance in pixels from the left of the video input
      to the left of the viewport.
      bottom - Output: Distance in pixels from the bottom of the video
      input to the bottom of the viewport.
      width - Output: Width of viewport in pixels.
      height - Output: Height of viewport in pixels.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
      the output arguments are unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetRelativeViewportForViewerEyeSurface(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, OSVR_ViewportDimension*, OSVR_ViewportDimension*, OSVR_ViewportDimension*, OSVR_ViewportDimension*)
    • osvrClientGetRelativeViewportForViewerEyeSurface

      public static byte osvrClientGetRelativeViewportForViewerEyeSurface(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, byte eye, int surface, IntBuffer left, IntBuffer bottom, IntBuffer width, IntBuffer height)
      Get the dimensions/location of the viewport **within the display
      input** for a surface seen by an eye of a viewer in a display config. (This
      does not include other video inputs that may be on a single virtual desktop,
      etc. or explicitly account for display configurations that use multiple
      video inputs. It does not necessarily indicate that a viewport in the sense
      of glViewport must be created with these parameters, though the parameter
      order matches for convenience.)
      Parameters:
      disp - Display config object
      viewer - Viewer ID
      eye - Eye ID
      surface - Surface ID
      left - Output: Distance in pixels from the left of the video input
      to the left of the viewport.
      bottom - Output: Distance in pixels from the bottom of the video
      input to the bottom of the viewport.
      width - Output: Width of viewport in pixels.
      height - Output: Height of viewport in pixels.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
      the output arguments are unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetRelativeViewportForViewerEyeSurface(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, OSVR_ViewportDimension*, OSVR_ViewportDimension*, OSVR_ViewportDimension*, OSVR_ViewportDimension*)
    • osvrClientGetViewerEyeSurfaceDisplayInputIndex

      @Deprecated public static byte osvrClientGetViewerEyeSurfaceDisplayInputIndex(com.sun.jna.Pointer disp, int viewer, byte eye, int surface, com.sun.jna.Pointer displayInput)
      Get the index of the display input for a surface seen by an eye of a
      viewer in a display config.
      This is the OSVR-assigned display input: it may not (and in practice,
      usually will not) match any platform-specific display indices. This function
      exists to associate surfaces with video inputs as enumerated by
      osvrClientGetNumDisplayInputs().
      Parameters:
      disp - Display config object
      viewer - Viewer ID
      eye - Eye ID
      surface - Surface ID
      displayInput - Zero-based index of the display input pixels for
      this surface are transmitted over.
      This association is **constant** throughout the active, valid lifetime of a
      display config object.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed, in which
      case the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetViewerEyeSurfaceDisplayInputIndex(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, OSVR_DisplayInputCount*)
      See Also:
    • osvrClientGetViewerEyeSurfaceDisplayInputIndex

      public static byte osvrClientGetViewerEyeSurfaceDisplayInputIndex(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, byte eye, int surface, ByteBuffer displayInput)
      Get the index of the display input for a surface seen by an eye of a
      viewer in a display config.
      This is the OSVR-assigned display input: it may not (and in practice,
      usually will not) match any platform-specific display indices. This function
      exists to associate surfaces with video inputs as enumerated by
      osvrClientGetNumDisplayInputs().
      Parameters:
      disp - Display config object
      viewer - Viewer ID
      eye - Eye ID
      surface - Surface ID
      displayInput - Zero-based index of the display input pixels for
      this surface are transmitted over.
      This association is **constant** throughout the active, valid lifetime of a
      display config object.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed, in which
      case the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetViewerEyeSurfaceDisplayInputIndex(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, OSVR_DisplayInputCount*)
      See Also:
    • osvrClientGetViewerEyeSurfaceProjectionMatrixd

      @Deprecated public static byte osvrClientGetViewerEyeSurfaceProjectionMatrixd(com.sun.jna.Pointer disp, int viewer, byte eye, int surface, double near, double far, short flags, com.sun.jna.ptr.DoubleByReference matrix)
      Get the projection matrix for a surface seen by an eye of a viewer
      in a display config. (double version)
      Parameters:
      disp - Display config object
      viewer - Viewer ID
      eye - Eye ID
      surface - Surface ID
      near - Distance from viewpoint to near clipping plane - must be
      positive.
      far - Distance from viewpoint to far clipping plane - must be positive
      and not equal to near, typically greater than near.
      flags - Bitwise OR of matrix convention flags (see @ref MatrixFlags)
      matrix - Output projection matrix: supply an array of 16
      (::OSVR_MATRIX_SIZE) doubles.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
      the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetViewerEyeSurfaceProjectionMatrixd(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, double, double, OSVR_MatrixConventions, double*)
    • osvrClientGetViewerEyeSurfaceProjectionMatrixd

      public static byte osvrClientGetViewerEyeSurfaceProjectionMatrixd(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, byte eye, int surface, double near, double far, short flags, DoubleBuffer matrix)
      Get the projection matrix for a surface seen by an eye of a viewer
      in a display config. (double version)
      Parameters:
      disp - Display config object
      viewer - Viewer ID
      eye - Eye ID
      surface - Surface ID
      near - Distance from viewpoint to near clipping plane - must be
      positive.
      far - Distance from viewpoint to far clipping plane - must be positive
      and not equal to near, typically greater than near.
      flags - Bitwise OR of matrix convention flags (see @ref MatrixFlags)
      matrix - Output projection matrix: supply an array of 16
      (::OSVR_MATRIX_SIZE) doubles.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
      the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetViewerEyeSurfaceProjectionMatrixd(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, double, double, OSVR_MatrixConventions, double*)
    • osvrClientGetViewerEyeSurfaceProjectionMatrixf

      @Deprecated public static byte osvrClientGetViewerEyeSurfaceProjectionMatrixf(com.sun.jna.Pointer disp, int viewer, byte eye, int surface, float near, float far, short flags, com.sun.jna.ptr.FloatByReference matrix)
      Get the projection matrix for a surface seen by an eye of a viewer
      in a display config. (float version)
      Parameters:
      disp - Display config object
      viewer - Viewer ID
      eye - Eye ID
      surface - Surface ID
      near - Distance to near clipping plane - must be nonzero, typically
      positive.
      far - Distance to far clipping plane - must be nonzero, typically
      positive and greater than near.
      flags - Bitwise OR of matrix convention flags (see @ref MatrixFlags)
      matrix - Output projection matrix: supply an array of 16
      (::OSVR_MATRIX_SIZE) floats.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
      the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetViewerEyeSurfaceProjectionMatrixf(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, float, float, OSVR_MatrixConventions, float*)
    • osvrClientGetViewerEyeSurfaceProjectionMatrixf

      public static byte osvrClientGetViewerEyeSurfaceProjectionMatrixf(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, byte eye, int surface, float near, float far, short flags, FloatBuffer matrix)
      Get the projection matrix for a surface seen by an eye of a viewer
      in a display config. (float version)
      Parameters:
      disp - Display config object
      viewer - Viewer ID
      eye - Eye ID
      surface - Surface ID
      near - Distance to near clipping plane - must be nonzero, typically
      positive.
      far - Distance to far clipping plane - must be nonzero, typically
      positive and greater than near.
      flags - Bitwise OR of matrix convention flags (see @ref MatrixFlags)
      matrix - Output projection matrix: supply an array of 16
      (::OSVR_MATRIX_SIZE) floats.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
      the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetViewerEyeSurfaceProjectionMatrixf(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, float, float, OSVR_MatrixConventions, float*)
    • osvrClientGetViewerEyeSurfaceProjectionClippingPlanes

      @Deprecated public static byte osvrClientGetViewerEyeSurfaceProjectionClippingPlanes(com.sun.jna.Pointer disp, int viewer, byte eye, int surface, com.sun.jna.ptr.DoubleByReference left, com.sun.jna.ptr.DoubleByReference right, com.sun.jna.ptr.DoubleByReference bottom, com.sun.jna.ptr.DoubleByReference top)
      Get the clipping planes (positions at unit distance) for a surface
      seen by an eye of a viewer
      in a display config.
      This is only for use in integrations that cannot accept a fully-formulated
      projection matrix as returned by
      osvrClientGetViewerEyeSurfaceProjectionMatrixf() or
      osvrClientGetViewerEyeSurfaceProjectionMatrixd(), and may not necessarily
      provide the same optimizations.
      As all the planes are given at unit (1) distance, before passing these
      planes to a consuming function in your application/engine, you will typically
      divide them by your near clipping plane distance.
      Parameters:
      disp - Display config object
      viewer - Viewer ID
      eye - Eye ID
      surface - Surface ID
      left - Distance to left clipping plane
      right - Distance to right clipping plane
      bottom - Distance to bottom clipping plane
      top - Distance to top clipping plane
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
      the output arguments are unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetViewerEyeSurfaceProjectionClippingPlanes(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, double*, double*, double*, double*)
    • osvrClientGetViewerEyeSurfaceProjectionClippingPlanes

      public static byte osvrClientGetViewerEyeSurfaceProjectionClippingPlanes(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, byte eye, int surface, DoubleBuffer left, DoubleBuffer right, DoubleBuffer bottom, DoubleBuffer top)
      Get the clipping planes (positions at unit distance) for a surface
      seen by an eye of a viewer
      in a display config.
      This is only for use in integrations that cannot accept a fully-formulated
      projection matrix as returned by
      osvrClientGetViewerEyeSurfaceProjectionMatrixf() or
      osvrClientGetViewerEyeSurfaceProjectionMatrixd(), and may not necessarily
      provide the same optimizations.
      As all the planes are given at unit (1) distance, before passing these
      planes to a consuming function in your application/engine, you will typically
      divide them by your near clipping plane distance.
      Parameters:
      disp - Display config object
      viewer - Viewer ID
      eye - Eye ID
      surface - Surface ID
      left - Distance to left clipping plane
      right - Distance to right clipping plane
      bottom - Distance to bottom clipping plane
      top - Distance to top clipping plane
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
      the output arguments are unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetViewerEyeSurfaceProjectionClippingPlanes(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, double*, double*, double*, double*)
    • osvrClientDoesViewerEyeSurfaceWantDistortion

      @Deprecated public static byte osvrClientDoesViewerEyeSurfaceWantDistortion(com.sun.jna.Pointer disp, int viewer, byte eye, int surface, com.sun.jna.Pointer distortionRequested)
      Determines if a surface seen by an eye of a viewer in a display
      config requests some distortion to be performed.
      This simply reports true or false, and does not specify which kind of
      distortion implementations have been parameterized for this display. For
      each distortion implementation your application supports, you'll want to
      call the corresponding priority function to find out if it is available.
      Parameters:
      disp - Display config object
      viewer - Viewer ID
      eye - Eye ID
      surface - Surface ID
      distortionRequested - Output parameter: whether distortion is
      requested. **Constant** throughout the active, valid lifetime of a display
      config object.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
      the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientDoesViewerEyeSurfaceWantDistortion(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, OSVR_CBool*)
    • osvrClientDoesViewerEyeSurfaceWantDistortion

      public static byte osvrClientDoesViewerEyeSurfaceWantDistortion(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, byte eye, int surface, ByteBuffer distortionRequested)
      Determines if a surface seen by an eye of a viewer in a display
      config requests some distortion to be performed.
      This simply reports true or false, and does not specify which kind of
      distortion implementations have been parameterized for this display. For
      each distortion implementation your application supports, you'll want to
      call the corresponding priority function to find out if it is available.
      Parameters:
      disp - Display config object
      viewer - Viewer ID
      eye - Eye ID
      surface - Surface ID
      distortionRequested - Output parameter: whether distortion is
      requested. **Constant** throughout the active, valid lifetime of a display
      config object.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
      the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientDoesViewerEyeSurfaceWantDistortion(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, OSVR_CBool*)
    • osvrClientGetViewerEyeSurfaceRadialDistortionPriority

      @Deprecated public static byte osvrClientGetViewerEyeSurfaceRadialDistortionPriority(com.sun.jna.Pointer disp, int viewer, byte eye, int surface, com.sun.jna.ptr.IntByReference priority)
      Returns the priority/availability of radial distortion parameters for
      a surface seen by an eye of a viewer in a display config.
      If osvrClientDoesViewerEyeSurfaceWantDistortion() reports false, then the
      display does not request distortion of any sort, and thus neither this nor
      any other distortion strategy priority function will report an "available"
      priority.
      Parameters:
      disp - Display config object
      viewer - Viewer ID
      eye - Eye ID
      surface - Surface ID
      priority - Output: the priority level. Negative values
      (canonically OSVR_DISTORTION_PRIORITY_UNAVAILABLE) indicate this technique
      not available, higher values indicate higher preference for the given
      technique based on the device's description. **Constant** throughout the
      active, valid lifetime of a display config object.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
      the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetViewerEyeSurfaceRadialDistortionPriority(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, OSVR_DistortionPriority*)
    • osvrClientGetViewerEyeSurfaceRadialDistortionPriority

      public static byte osvrClientGetViewerEyeSurfaceRadialDistortionPriority(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, byte eye, int surface, IntBuffer priority)
      Returns the priority/availability of radial distortion parameters for
      a surface seen by an eye of a viewer in a display config.
      If osvrClientDoesViewerEyeSurfaceWantDistortion() reports false, then the
      display does not request distortion of any sort, and thus neither this nor
      any other distortion strategy priority function will report an "available"
      priority.
      Parameters:
      disp - Display config object
      viewer - Viewer ID
      eye - Eye ID
      surface - Surface ID
      priority - Output: the priority level. Negative values
      (canonically OSVR_DISTORTION_PRIORITY_UNAVAILABLE) indicate this technique
      not available, higher values indicate higher preference for the given
      technique based on the device's description. **Constant** throughout the
      active, valid lifetime of a display config object.
      Returns:
      OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
      the output argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetViewerEyeSurfaceRadialDistortionPriority(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, OSVR_DistortionPriority*)
    • osvrClientGetViewerEyeSurfaceRadialDistortion

      @Deprecated public static byte osvrClientGetViewerEyeSurfaceRadialDistortion(com.sun.jna.Pointer disp, int viewer, byte eye, int surface, com.sun.jna.Pointer params)
      Returns the radial distortion parameters, if known/requested, for a
      surface seen by an eye of a viewer in a display config.
      Will only succeed if osvrClientGetViewerEyeSurfaceRadialDistortionPriority()
      reports a non-negative priority.
      Parameters:
      disp - Display config object
      viewer - Viewer ID
      eye - Eye ID
      surface - Surface ID
      params - Output: the parameters for radial distortion
      Returns:
      OSVR_RETURN_FAILURE if this surface does not have these parameters
      described, or if invalid parameters were passed, in which case the output
      argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetViewerEyeSurfaceRadialDistortion(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, OSVR_RadialDistortionParameters*)
    • osvrClientGetViewerEyeSurfaceRadialDistortion

      public static byte osvrClientGetViewerEyeSurfaceRadialDistortion(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, byte eye, int surface, com.sun.jna.Pointer params)
      Returns the radial distortion parameters, if known/requested, for a
      surface seen by an eye of a viewer in a display config.
      Will only succeed if osvrClientGetViewerEyeSurfaceRadialDistortionPriority()
      reports a non-negative priority.
      Parameters:
      disp - Display config object
      viewer - Viewer ID
      eye - Eye ID
      surface - Surface ID
      params - Output: the parameters for radial distortion
      Returns:
      OSVR_RETURN_FAILURE if this surface does not have these parameters
      described, or if invalid parameters were passed, in which case the output
      argument is unmodified.
      Original signature : OSVR_ReturnCode osvrClientGetViewerEyeSurfaceRadialDistortion(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, OSVR_RadialDistortionParameters*)