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

Namespaces
	osvr::clientkit::detail
	Implementation details.

Classes
class	osvr::clientkit::ClientContext
	Client context object: Create and keep one in your application. More...

struct	osvr::clientkit::RelativeViewport

struct	osvr::clientkit::ProjectionClippingPlanes

struct	osvr::clientkit::DisplayDimensions

class	osvr::clientkit::Surface
	Wrapper for a viewer, eye, and surface bound to a display config. More...

class	osvr::clientkit::Eye
	Wrapper for a viewer and eye bound to a display config. More...

class	osvr::clientkit::Viewer
	Wrapper for a viewer bound to a display config. More...

class	osvr::clientkit::DisplayConfig
	Class wrapping OSVR_DisplayConfig objects, optionally managing shared ownership. More...

class	osvr::clientkit::detail::ImagingCallbackRegistration
	Class serving to maintain the registration of and wrap a friendly imaging callback. More...

struct	osvr::clientkit::ImagingReport
	The user-friendly imaging report. More...

class	osvr::clientkit::Interface
	Interface handle object. More...

Typedefs
typedef shared_ptr< OSVR_DisplayConfigObject >	osvr::clientkit::UnderlyingDisplayConfigPtr

typedef boost::shared_ptr< OSVR_ImageBufferElement >	osvr::clientkit::ImageBufferPtr

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)

void	osvr::clientkit::registerImagingCallback (Interface &iface, ImagingCallback cb, void *userdata)

	osvr::clientkit::detail::ImagingCallbackRegistration::ImagingDeleter::ImagingDeleter (OSVR_ClientContext ctx)

void	osvr::clientkit::detail::ImagingCallbackRegistration::ImagingDeleter::operator() (OSVR_ImageBufferElement *buf)

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.

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.

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...

Friends
void	osvr::clientkit::detail::ImagingCallbackRegistration::osvr::clientkit::registerImagingCallback (Interface &iface, ImagingCallback cb, void *userdata)

Detailed Description

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

A smart pointer controlling deletion of the image buffer.

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

The buffer is automatically wrapped in one of these before your callback gets it.

Function Documentation

§ operator!=() [1/5]

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

§ operator!=() [2/5]

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

§ operator!=() [3/5]

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

§ operator!=() [4/5]

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

§ operator!=() [5/5]

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

§ operator==() [1/5]

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

§ operator==() [2/5]

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

§ operator==() [3/5]

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

§ operator==() [4/5]

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

§ operator==() [5/5]

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

Namespaces

Classes

Typedefs

Functions

Friends