OSVR-Core
DisplayC.h File Reference

Header. More...

#include <osvr/ClientKit/Export.h>
#include <osvr/Util/APIBaseC.h>
#include <osvr/Util/ReturnCodesC.h>
#include <osvr/Util/ClientOpaqueTypesC.h>
#include <osvr/Util/RenderingTypesC.h>
#include <osvr/Util/MatrixConventionsC.h>
#include <osvr/Util/Pose3C.h>
#include <osvr/Util/BoolC.h>
#include <osvr/Util/RadialDistortionParametersC.h>

Go to the source code of this file.

Display API

typedef struct OSVR_DisplayConfigObjectOSVR_DisplayConfig
 Opaque type of a display configuration. More...
 
OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetDisplay (OSVR_ClientContext ctx, OSVR_DisplayConfig *disp)
 Allocates a display configuration object populated with data from the OSVR system. More...
 
OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientFreeDisplay (OSVR_DisplayConfig disp)
 Frees a display configuration object. More...
 
OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientCheckDisplayStartup (OSVR_DisplayConfig disp)
 Checks to see if a display is fully configured and ready, including having received its first pose update. More...
 
OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetNumDisplayInputs (OSVR_DisplayConfig disp, OSVR_DisplayInputCount *numDisplayInputs)
 A display config can have one or more display inputs to pass pixels over (HDMI/DVI connections, etc): retrieve the number of display inputs in the current configuration. More...
 
OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetDisplayDimensions (OSVR_DisplayConfig disp, OSVR_DisplayInputCount displayInputIndex, OSVR_DisplayDimension *width, OSVR_DisplayDimension *height)
 Retrieve the pixel dimensions of a given display input for a display config. More...
 
OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetNumViewers (OSVR_DisplayConfig disp, OSVR_ViewerCount *viewers)
 A display config can have one (or theoretically more) viewers: retrieve the viewer count. More...
 
OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetViewerPose (OSVR_DisplayConfig disp, OSVR_ViewerCount viewer, OSVR_Pose3 *pose)
 Get the pose of a viewer in a display config. More...
 
OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetNumEyesForViewer (OSVR_DisplayConfig disp, OSVR_ViewerCount viewer, OSVR_EyeCount *eyes)
 Each viewer in a display config can have one or more "eyes" which have a substantially similar pose: get the count. More...
 
OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetViewerEyePose (OSVR_DisplayConfig disp, OSVR_ViewerCount viewer, OSVR_EyeCount eye, OSVR_Pose3 *pose)
 Get the "viewpoint" for the given eye of a viewer in a display config. More...
 
OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetViewerEyeViewMatrixd (OSVR_DisplayConfig disp, OSVR_ViewerCount viewer, OSVR_EyeCount eye, OSVR_MatrixConventions flags, double *mat)
 Get the view matrix (inverse of pose) for the given eye of a viewer in a display config - matrix of doubles. More...
 
OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetViewerEyeViewMatrixf (OSVR_DisplayConfig disp, OSVR_ViewerCount viewer, OSVR_EyeCount eye, OSVR_MatrixConventions flags, float *mat)
 Get the view matrix (inverse of pose) for the given eye of a viewer in a display config - matrix of floats. More...
 
OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetNumSurfacesForViewerEye (OSVR_DisplayConfig disp, OSVR_ViewerCount viewer, OSVR_EyeCount eye, OSVR_SurfaceCount *surfaces)
 Each eye of each viewer in a display config has one or more surfaces (aka "screens") on which content should be rendered. More...
 
OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetRelativeViewportForViewerEyeSurface (OSVR_DisplayConfig disp, OSVR_ViewerCount viewer, OSVR_EyeCount eye, OSVR_SurfaceCount surface, OSVR_ViewportDimension *left, OSVR_ViewportDimension *bottom, OSVR_ViewportDimension *width, OSVR_ViewportDimension *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. More...
 
OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetViewerEyeSurfaceDisplayInputIndex (OSVR_DisplayConfig disp, OSVR_ViewerCount viewer, OSVR_EyeCount eye, OSVR_SurfaceCount surface, OSVR_DisplayInputCount *displayInput)
 Get the index of the display input for a surface seen by an eye of a viewer in a display config. More...
 
OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetViewerEyeSurfaceProjectionMatrixd (OSVR_DisplayConfig disp, OSVR_ViewerCount viewer, OSVR_EyeCount eye, OSVR_SurfaceCount surface, double near, double far, OSVR_MatrixConventions flags, double *matrix)
 Get the projection matrix for a surface seen by an eye of a viewer in a display config. More...
 
OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetViewerEyeSurfaceProjectionMatrixf (OSVR_DisplayConfig disp, OSVR_ViewerCount viewer, OSVR_EyeCount eye, OSVR_SurfaceCount surface, float near, float far, OSVR_MatrixConventions flags, float *matrix)
 Get the projection matrix for a surface seen by an eye of a viewer in a display config. More...
 
OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetViewerEyeSurfaceProjectionClippingPlanes (OSVR_DisplayConfig disp, OSVR_ViewerCount viewer, OSVR_EyeCount eye, OSVR_SurfaceCount surface, double *left, double *right, double *bottom, double *top)
 Get the clipping planes (positions at unit distance) for a surface seen by an eye of a viewer in a display config. More...
 
OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientDoesViewerEyeSurfaceWantDistortion (OSVR_DisplayConfig disp, OSVR_ViewerCount viewer, OSVR_EyeCount eye, OSVR_SurfaceCount surface, OSVR_CBool *distortionRequested)
 Determines if a surface seen by an eye of a viewer in a display config requests some distortion to be performed. More...
 
OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetViewerEyeSurfaceRadialDistortionPriority (OSVR_DisplayConfig disp, OSVR_ViewerCount viewer, OSVR_EyeCount eye, OSVR_SurfaceCount surface, OSVR_DistortionPriority *priority)
 Returns the priority/availability of radial distortion parameters for a surface seen by an eye of a viewer in a display config. More...
 
OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetViewerEyeSurfaceRadialDistortion (OSVR_DisplayConfig disp, OSVR_ViewerCount viewer, OSVR_EyeCount eye, OSVR_SurfaceCount surface, OSVR_RadialDistortionParameters *params)
 Returns the radial distortion parameters, if known/requested, for a surface seen by an eye of a viewer in a display config. More...
 

Detailed Description

Header.

Must be c-safe!

Date
2015
Author
Sensics, Inc. http://sensics.com/osvr