OSVR-Core  0.6-1962-g59773924
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
C++ wrappers for ClientKit

The header-only C++ wrappers around the ClientKit C API. More...

Classes

class  osvr::clientkit::ClientContext
 Client context object: Create and keep one in your application. Handles lifetime management and provides access to ClientKit functionality. More...
 
class  osvr::clientkit::Surface
 Wrapper for a viewer, eye, and surface bound to a display config. DOES NOT provide lifetime management for the associated display config! More...
 
class  osvr::clientkit::Eye
 Wrapper for a viewer and eye bound to a display config. DOES NOT provide lifetime management for the associated display config! More...
 
class  osvr::clientkit::Viewer
 Wrapper for a viewer bound to a display config. DOES NOT provide lifetime management for the associated display config! More...
 
class  osvr::clientkit::DisplayConfig
 Class wrapping OSVR_DisplayConfig objects, optionally managing shared ownership. More...
 
struct  osvr::clientkit::ImagingReport
 The user-friendly imaging report. Note that passing this around by value is OK (doesn't copy the image), and the easiest way to ensure that the image buffer doesn't get freed before you're done using it. More...
 
class  osvr::clientkit::Interface
 Interface handle object. Typically acquired from a ClientContext. More...
 

Typedefs

typedef void(* osvr::clientkit::ImagingCallback )(void *userdata, util::time::TimeValue const &timestamp, ImagingReport report)
 The user-friendly imaging callback type.
 

Functions

UnderlyingDisplayConfigPtr osvr::clientkit::getDisplay (ClientContext &ctx)
 Get a shared_ptr to a DisplayConfig (with appropriate deleter pre-loaded)
 
bool operator== (Surface const &lhs, Surface const &rhs)
 Equality operator for clientkit::Surface. More...
 
bool operator!= (Surface const &lhs, Surface const &rhs)
 Inequality operator for clientkit::Surface. More...
 
bool operator== (Eye const &lhs, Eye const &rhs)
 Equality operator for clientkit::Eye. More...
 
bool operator!= (Eye const &lhs, Eye const &rhs)
 Inequality operator for clientkit::Eye. More...
 
bool operator== (Viewer const &lhs, Viewer const &rhs)
 Equality operator for clientkit::Viewer. More...
 
bool operator!= (Viewer const &lhs, Viewer const &rhs)
 Inequality operator for clientkit::Viewer. More...
 
bool operator== (DisplayConfig const &lhs, DisplayConfig const &rhs)
 Equality operator for clientkit::DisplayConfig - does not consider the ownership status in the comparison. More...
 
bool operator== (DisplayConfig const &lhs, OSVR_DisplayConfig rhs)
 Equality operator for clientkit::DisplayConfig. More...
 
bool operator== (OSVR_DisplayConfig lhs, DisplayConfig const &rhs)
 Equality operator for clientkit::DisplayConfig. More...
 
bool operator!= (DisplayConfig const &lhs, DisplayConfig const &rhs)
 Inequality operator for clientkit::DisplayConfig - does not consider the ownership status in the comparison. More...
 
bool operator!= (DisplayConfig const &lhs, OSVR_DisplayConfig rhs)
 Inequality operator for clientkit::DisplayConfig. More...
 
bool operator!= (OSVR_DisplayConfig lhs, DisplayConfig const &rhs)
 Inequality operator for clientkit::DisplayConfig. More...
 

Detailed Description

The header-only C++ wrappers around the ClientKit C API.

A smart pointer controlling deletion of the image buffer. The buffer is automatically wrapped in one of these before your callback gets it.

Register a callback to receive each new full frame of imaging data.

Function Documentation

bool operator== ( Surface const &  lhs,
Surface const &  rhs 
)
related

Equality operator for clientkit::Surface.

Definition at line 570 of file Display.h.

bool operator!= ( Surface const &  lhs,
Surface const &  rhs 
)
related

Inequality operator for clientkit::Surface.

Definition at line 579 of file Display.h.

bool operator== ( Eye const &  lhs,
Eye const &  rhs 
)
related

Equality operator for clientkit::Eye.

Definition at line 588 of file Display.h.

bool operator!= ( Eye const &  lhs,
Eye const &  rhs 
)
related

Inequality operator for clientkit::Eye.

Definition at line 596 of file Display.h.

bool operator== ( Viewer const &  lhs,
Viewer const &  rhs 
)
related

Equality operator for clientkit::Viewer.

Definition at line 604 of file Display.h.

bool operator!= ( Viewer const &  lhs,
Viewer const &  rhs 
)
related

Inequality operator for clientkit::Viewer.

Definition at line 611 of file Display.h.

bool operator== ( DisplayConfig const &  lhs,
DisplayConfig const &  rhs 
)
related

Equality operator for clientkit::DisplayConfig - does not consider the ownership status in the comparison.

Definition at line 619 of file Display.h.

bool operator== ( DisplayConfig const &  lhs,
OSVR_DisplayConfig  rhs 
)
related

Equality operator for clientkit::DisplayConfig.

Definition at line 625 of file Display.h.

bool operator== ( OSVR_DisplayConfig  lhs,
DisplayConfig const &  rhs 
)
related

Equality operator for clientkit::DisplayConfig.

Definition at line 631 of file Display.h.

bool operator!= ( DisplayConfig const &  lhs,
DisplayConfig const &  rhs 
)
related

Inequality operator for clientkit::DisplayConfig - does not consider the ownership status in the comparison.

Definition at line 638 of file Display.h.

bool operator!= ( DisplayConfig const &  lhs,
OSVR_DisplayConfig  rhs 
)
related

Inequality operator for clientkit::DisplayConfig.

Definition at line 644 of file Display.h.

bool operator!= ( OSVR_DisplayConfig  lhs,
DisplayConfig const &  rhs 
)
related

Inequality operator for clientkit::DisplayConfig.

Definition at line 650 of file Display.h.