OSVR-Core  0.6-1962-g59773924
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Analysis plugin functionality (base C API)

How to create an "analysis filter/plugin". More...

Functions

OSVR_ANALYSISPLUGINKIT_EXPORT
OSVR_ReturnCode 
osvrAnalysisSyncInit (OSVR_PluginRegContext ctx, const char *name, OSVR_DeviceInitOptions options, OSVR_DeviceToken *device, OSVR_ClientContext *clientCtx)
 Initialize a synchronous analysis device token with the options specified, also returning the associated client context. More...
 

Detailed Description

How to create an "analysis filter/plugin".

Function Documentation

OSVR_ANALYSISPLUGINKIT_EXPORT OSVR_ReturnCode osvrAnalysisSyncInit ( OSVR_PluginRegContext  ctx,
const char *  name,
OSVR_DeviceInitOptions  options,
OSVR_DeviceToken device,
OSVR_ClientContext clientCtx 
)

#include <osvr/AnalysisPluginKit/AnalysisPluginKitC.h>

Initialize a synchronous analysis device token with the options specified, also returning the associated client context.

Parameters
ctxThe plugin registration context received by your entry point function.
nameA unique name for the device, abiding by the rules for an element (directory) in a URL. The library makes a copy of this string.
optionsThe DeviceInitOptions for your device.
[out]deviceWill contain the unique device token assigned to your synchronous device.
[out]clientCtxWill contain the specialized client context for your analysis use. It is owned by the device token, and should not be updated or shutdown, but can otherwise be used as provided for in ClientKit.

This transfers ownership of the DeviceInitOptions, and all created objects associated with it, to the returned device token.