VARJO TRACKING PLUGIN SDK DOCUMENTATION
Varjo_plugin_common.h File Reference

Go to the source code of this file.

Functions

varjo_PluginType varjo_GetPluginType ()
 
uint64_t varjo_GetPluginAPIVersion ()
 
const char * varjo_GetPluginName ()
 
const char * varjo_GetPluginStatusDescription (varjo_PluginStatus pluginStatus)
 
varjo_PluginStatus varjo_PluginInit (const varjo_PluginUtilityAPI *pluginUtilityAPI, varjo_PluginUtilitySession pluginUtilitySession, varjo_PluginContext *context)
 
varjo_PluginStatus varjo_PluginShutdown (varjo_PluginContext *context)
 

Function Documentation

◆ varjo_GetPluginType()

varjo_PluginType varjo_GetPluginType ( )

Provides plugin types supported by the plugin library

Returns
a combination of varjo_PluginType flags

◆ varjo_GetPluginAPIVersion()

uint64_t varjo_GetPluginAPIVersion ( )

Provides the API version number supported by the plugin. Use VARJO_PLUGIN_API_VERSION macro to indicate supported API version number.

Returns
Varjo plugin API version number.

◆ varjo_GetPluginName()

const char* varjo_GetPluginName ( )

Provides plugin name

Returns
Null-terminated C-string containing plugin name

◆ varjo_GetPluginStatusDescription()

const char* varjo_GetPluginStatusDescription ( varjo_PluginStatus  pluginStatus)

Provides a string description of a given status code

Parameters
pluginStatus- plugin status code
Returns
Null-terminated C-string containing description of a given status code

◆ varjo_PluginInit()

varjo_PluginStatus varjo_PluginInit ( const varjo_PluginUtilityAPI pluginUtilityAPI,
varjo_PluginUtilitySession  pluginUtilitySession,
varjo_PluginContext context 
)

Initializes plugin

Parameters
pluginUtilityAPI- pointer to structure containing utility function pointers
pluginUtilitySession- handle to pass to varjo_PluginUtilityAPI functions
context- pointer to write plugin session context
Returns
varjo_PluginStatus_OK if plugin was initialized successfully, other value of type varjo_PluginStatus otherwise

◆ varjo_PluginShutdown()

varjo_PluginStatus varjo_PluginShutdown ( varjo_PluginContext context)

Deinitializes plugin

Parameters
context- plugin session context acquired from varjo_PluginInit
Returns
varjo_PluginStatus_OK if plugin was shut down successfully, other value of type varjo_PluginStatus otherwise