OSVR-Core
|
How to create an "analysis filter/plugin". More...
Functions | |
OSVR_ANALYSISPLUGINKIT_EXPORT OSVR_ReturnCode | osvrAnalysisSyncInit (OSVR_IN_PTR OSVR_PluginRegContext ctx, OSVR_IN_STRZ const char *name, OSVR_IN_PTR OSVR_DeviceInitOptions options, OSVR_OUT_PTR OSVR_DeviceToken *device, OSVR_OUT_PTR OSVR_ClientContext *clientCtx) OSVR_FUNC_NONNULL((1 |
Initialize a synchronous analysis device token with the options specified, also returning the associated client context. More... | |
How to create an "analysis filter/plugin".
OSVR_ANALYSISPLUGINKIT_EXPORT OSVR_ReturnCode osvrAnalysisSyncInit | ( | OSVR_IN_PTR OSVR_PluginRegContext | ctx, |
OSVR_IN_STRZ const char * | name, | ||
OSVR_IN_PTR OSVR_DeviceInitOptions | options, | ||
OSVR_OUT_PTR OSVR_DeviceToken * | device, | ||
OSVR_OUT_PTR OSVR_ClientContext * | clientCtx | ||
) |
Initialize a synchronous analysis device token with the options specified, also returning the associated client context.
ctx | The plugin registration context received by your entry point function. | |
name | A unique name for the device, abiding by the rules for an element (directory) in a URL. The library makes a copy of this string. | |
options | The DeviceInitOptions for your device. | |
[out] | device | Will contain the unique device token assigned to your synchronous device. |
[out] | clientCtx | Will 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.