JointClientKitC.h File Reference

Header. More...

#include <osvr/JointClientKit/Export.h>
#include <osvr/Util/APIBaseC.h>
#include <osvr/Util/ReturnCodesC.h>
#include <osvr/Util/AnnotationMacrosC.h>
#include <osvr/Util/StdInt.h>
#include <osvr/Util/ClientOpaqueTypesC.h>

Go to the source code of this file.

Typedefs
typedef struct OSVR_JointClientContextOptsObject *	OSVR_JointClientOpts
	Opaque typedef for options used when starting up a joint client context. More...

Functions
OSVR_JOINTCLIENTKIT_EXPORT OSVR_JointClientOpts	osvrJointClientCreateOptions ()
	Creates an empty OSVR_JointClientOpts. More...
OSVR_JOINTCLIENTKIT_EXPORT OSVR_ClientContext	osvrJointClientInit (const char applicationIdentifier[], OSVR_JointClientOpts opts)
	Initialize the library, starting up a "joint" context that also contains a server. More...
Server configuration actions
Methods that queue up actions to perform on the server when the joint client/server is later created in osvrJointClientInit(). These methods do not perform the actions directly or immediately, and only perform some basic error checking on their inputs: failure in the actions specified may instead be reported later in a failure to create the context.
OSVR_JOINTCLIENTKIT_EXPORT OSVR_ReturnCode	osvrJointClientOptionsAutoloadPlugins (OSVR_JointClientOpts opts)
	Queues up the autoloading of plugins. More...
OSVR_JOINTCLIENTKIT_EXPORT OSVR_ReturnCode	osvrJointClientOptionsLoadPlugin (OSVR_JointClientOpts opts, const char *pluginName)
	Queues up the manual load of a plugin by name.
OSVR_JOINTCLIENTKIT_EXPORT OSVR_ReturnCode	osvrJointClientOptionsInstantiateDriver (OSVR_JointClientOpts opts, const char *pluginName, const char *driverName, const char *params)
	Queues up the manual instantiation of a plugin/driver by name with optional parameters (JSON).
OSVR_JOINTCLIENTKIT_EXPORT OSVR_ReturnCode	osvrJointClientOptionsAddAlias (OSVR_JointClientOpts opts, const char *path, const char *source)
	Queues up the manual addition of an alias to the path tree.
OSVR_JOINTCLIENTKIT_EXPORT OSVR_ReturnCode	osvrJointClientOptionsAddAliases (OSVR_JointClientOpts opts, const char *aliases)
	Queues up the manual addition of aliases specified in JSON to the path tree.
OSVR_JOINTCLIENTKIT_EXPORT OSVR_ReturnCode	osvrJointClientOptionsAddString (OSVR_JointClientOpts opts, const char *path, const char *s)
	Queues up the manual addition of a string element to the path tree.
OSVR_JOINTCLIENTKIT_EXPORT OSVR_ReturnCode	osvrJointClientOptionsTriggerHardwareDetect (OSVR_JointClientOpts opts)
	Queues up a trigger for hardware detection.

Detailed Description

Header.

Must be c-safe!

Date

2015

Author

Sensics, Inc. http://sensics.com/osvr