OSVR Framework (Internal Development Docs)  0.6-1962-g59773924
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
PluginRegistration.h File Reference

Header providing C++ interface wrappers around functionality in PluginRegistrationC.h. More...

#include <osvr/PluginKit/PluginRegistrationC.h>
#include <osvr/Util/GenericDeleter.h>
#include <osvr/Util/GenericCaller.h>
#include <osvr/Util/BoostIsCopyConstructible.h>
#include <boost/utility/enable_if.hpp>
#include <boost/type_traits/is_pointer.hpp>
#include <boost/type_traits/remove_pointer.hpp>
#include <boost/static_assert.hpp>
#include <cstddef>
#include <string>
#include <stdexcept>

Go to the source code of this file.

Namespaces

 osvr
 <
 
 osvr::pluginkit
 Contains C++ header-only wrappers for the PluginKit 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.
 
 osvr::pluginkit::detail
 Internal implementation-only namespace.
 

Functions

template<typename T >
T * osvr::pluginkit::registerObjectForDeletion (OSVR_PluginRegContext ctx, T *obj)
 Registers an object to be destroyed with delete when the plugin is unloaded. More...
 
template<typename T >
OSVR_ReturnCode osvr::pluginkit::detail::registerHardwareDetectCallbackImpl (OSVR_PluginRegContext ctx, T functor, typename boost::enable_if< boost::is_pointer< T > >::type *=NULL)
 Traits-based overload to register a hardware detect callback where we're given a pointer to a function object.
 
template<typename T >
OSVR_ReturnCode osvr::pluginkit::detail::registerHardwareDetectCallbackImpl (OSVR_PluginRegContext ctx, T functor, typename boost::disable_if< boost::is_pointer< T > >::type *=NULL)
 Traits based overload to copy a hardware detect callback passed by value then register the copy.
 
template<typename T >
OSVR_ReturnCode osvr::pluginkit::detail::registerDriverInstantiationCallbackImpl (OSVR_PluginRegContext ctx, const char driverName[], T functor, typename boost::enable_if< boost::is_pointer< T > >::type *=NULL)
 Traits-based overload to register an instantiation callback where we're given a pointer to a function object.
 
template<typename T >
OSVR_ReturnCode osvr::pluginkit::detail::registerDriverInstantiationCallbackImpl (OSVR_PluginRegContext ctx, const char driverName[], T functor, typename boost::disable_if< boost::is_pointer< T > >::type *=NULL)
 Traits based overload to copy an instantiation callback passed by value then register the copy.
 
template<typename T >
void osvr::pluginkit::registerHardwareDetectCallback (OSVR_PluginRegContext ctx, T functor)
 Registers a function object to be called when the core requests a hardware detection. More...
 
template<typename T >
void osvr::pluginkit::registerDriverInstantiationCallback (OSVR_PluginRegContext ctx, const char driverName[], T functor)
 Registers a function object to be called when the server is told to instantiate a driver by name with parameters. More...
 
void osvr::pluginkit::log (OSVR_PluginRegContext ctx, OSVR_LogLevel severity, const char *message)
 

Detailed Description

Header providing C++ interface wrappers around functionality in PluginRegistrationC.h.

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

Definition in file PluginRegistration.h.