JointClientKitC.h

Go to the documentation of this file.

/*
// Copyright 2015 Sensics, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//        http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
*/

#ifndef INCLUDED_JointClientKitC_h_GUID_AEF51E42_05FE_4095_DC94_0D1E5CF76A76
#define INCLUDED_JointClientKitC_h_GUID_AEF51E42_05FE_4095_DC94_0D1E5CF76A76

/* Internal Includes */
#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>

/* Library/third-party includes */
/* none */

/* Standard includes */
/* none */

OSVR_EXTERN_C_BEGIN

typedef struct OSVR_JointClientContextOptsObject *OSVR_JointClientOpts;

OSVR_JOINTCLIENTKIT_EXPORT OSVR_JointClientOpts osvrJointClientCreateOptions();

OSVR_JOINTCLIENTKIT_EXPORT OSVR_ReturnCode
osvrJointClientOptionsAutoloadPlugins(OSVR_JointClientOpts opts);

OSVR_JOINTCLIENTKIT_EXPORT OSVR_ReturnCode osvrJointClientOptionsLoadPlugin(
    OSVR_JointClientOpts opts, const char *pluginName);

OSVR_JOINTCLIENTKIT_EXPORT OSVR_ReturnCode
osvrJointClientOptionsInstantiateDriver(OSVR_JointClientOpts opts,
                                        const char *pluginName,
                                        const char *driverName,
                                        const char *params);

OSVR_JOINTCLIENTKIT_EXPORT OSVR_ReturnCode osvrJointClientOptionsAddAlias(
    OSVR_JointClientOpts opts, const char *path, const char *source);

OSVR_JOINTCLIENTKIT_EXPORT OSVR_ReturnCode osvrJointClientOptionsAddAliases(
    OSVR_JointClientOpts opts, const char *aliases);

OSVR_JOINTCLIENTKIT_EXPORT OSVR_ReturnCode osvrJointClientOptionsAddString(
    OSVR_JointClientOpts opts, const char *path, const char *s);

OSVR_JOINTCLIENTKIT_EXPORT OSVR_ReturnCode
osvrJointClientOptionsTriggerHardwareDetect(OSVR_JointClientOpts opts);

OSVR_JOINTCLIENTKIT_EXPORT OSVR_ClientContext osvrJointClientInit(
    const char applicationIdentifier[], OSVR_JointClientOpts opts);

OSVR_EXTERN_C_END

#endif