osvr::clientkit Namespace Reference

Contains C++ header-only wrappers for the ClientKit C API. More...

Namespaces
	detail
	Implementation details.

Classes
class	ClientContext
	Client context object: Create and keep one in your application. More...
class	DisplayConfig
	Class wrapping OSVR_DisplayConfig objects, optionally managing shared ownership. More...
struct	DisplayDimensions
class	Eye
	Wrapper for a viewer and eye bound to a display config. More...
struct	ImagingReport
	The user-friendly imaging report. More...
class	Interface
	Interface handle object. More...
struct	ProjectionClippingPlanes
struct	RelativeViewport
class	Surface
	Wrapper for a viewer, eye, and surface bound to a display config. More...
class	Viewer
	Wrapper for a viewer bound to a display config. More...

Typedefs
typedef shared_ptr< OSVR_DisplayConfigObject >	UnderlyingDisplayConfigPtr
typedef boost::shared_ptr< OSVR_ImageBufferElement >	ImageBufferPtr
typedef void(*	ImagingCallback) (void *userdata, util::time::TimeValue const &timestamp, ImagingReport report)
	The user-friendly imaging callback type.

Functions
UnderlyingDisplayConfigPtr	getDisplay (ClientContext &ctx)
	Get a shared_ptr to a DisplayConfig (with appropriate deleter pre-loaded)
void	registerImagingCallback (Interface &iface, ImagingCallback cb, void *userdata)
std::string	getStringParameter (OSVR_ClientContext ctx, const char path[])
	Get a string parameter value from the given path. More...

Detailed Description

Contains C++ header-only wrappers for the ClientKit C API.

Use of these wrappers is optional: they duplicate functionality found in the C API as they are implemented in headers on top of the C API. However, they also provide a much cleaner, low-boilerplate interface for the most common operations.

Some functionality may not be "wrapped" in a C++ API, however, it is always possible to extract the C entities being wrapped and use them with the C API in those cases.

Function Documentation

getStringParameter()

std::string osvr::clientkit::getStringParameter ( OSVR_ClientContext  ctx, const char  path[]  )

inline

Get a string parameter value from the given path.

Parameters

ctx	Client context
path	A resource path (null-terminated string)

Returns

parameter value, or empty string if parameter does not exist or is not a string.