DeviceInterfaceC.h

Go to the documentation of this file.

/*
// Copyright 2014 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_DeviceInterfaceC_h_GUID_8B82B108_1B20_4D80_9FE5_C31E424E3652
#define INCLUDED_DeviceInterfaceC_h_GUID_8B82B108_1B20_4D80_9FE5_C31E424E3652

/* Internal Includes */
#include <osvr/PluginKit/Export.h>
#include <osvr/PluginKit/CommonC.h>
#include <osvr/Util/DeviceCallbackTypesC.h>
#include <osvr/Util/AnnotationMacrosC.h>
#include <osvr/Util/TimeValueC.h>

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

/* Standard includes */
#include <stddef.h>

OSVR_EXTERN_C_BEGIN

typedef struct OSVR_DeviceTokenObject *OSVR_DeviceToken;

typedef struct OSVR_MessageTypeObject *OSVR_MessageType;

typedef struct OSVR_DeviceInitObject *OSVR_DeviceInitOptions;

OSVR_PLUGINKIT_EXPORT OSVR_DeviceInitOptions
osvrDeviceCreateInitOptions(OSVR_IN_PTR OSVR_PluginRegContext ctx)
    OSVR_FUNC_NONNULL((1));

OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode
osvrDeviceRegisterMessageType(OSVR_IN_PTR OSVR_PluginRegContext ctx,
                              OSVR_IN_STRZ const char *name,
                              OSVR_OUT_PTR OSVR_MessageType *msgtype)
    OSVR_FUNC_NONNULL((1, 2, 3));

OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode
osvrDeviceSendData(OSVR_IN_PTR OSVR_DeviceToken dev,
                   OSVR_IN_PTR OSVR_MessageType msg,
                   OSVR_IN_READS(len) const char *bytestream,
                   OSVR_IN size_t len) OSVR_FUNC_NONNULL((1, 2));

OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode
osvrDeviceSendTimestampedData(OSVR_IN_PTR OSVR_DeviceToken dev,
                              OSVR_IN_PTR const OSVR_TimeValue *timestamp,
                              OSVR_IN_PTR OSVR_MessageType msg,
                              OSVR_IN_READS(len) const char *bytestream,
                              OSVR_IN size_t len) OSVR_FUNC_NONNULL((1, 2, 3));

OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode
osvrDeviceSendJsonDescriptor(OSVR_IN_PTR OSVR_DeviceToken dev,
                             OSVR_IN_READS(len) const char *json,
                             OSVR_IN size_t len) OSVR_FUNC_NONNULL((1, 2));

OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode osvrDeviceRegisterUpdateCallback(
    OSVR_IN_PTR OSVR_DeviceToken dev,
    OSVR_IN OSVR_DeviceUpdateCallback updateCallback,
    OSVR_IN_OPT void *userData OSVR_CPP_ONLY(= NULL)) OSVR_FUNC_NONNULL((1));

OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode
osvrDeviceSyncInit(OSVR_IN_PTR OSVR_PluginRegContext ctx,
                   OSVR_IN_STRZ const char *name,
                   OSVR_OUT_PTR OSVR_DeviceToken *device)
    OSVR_FUNC_NONNULL((1, 2, 3));

OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode
osvrDeviceSyncInitWithOptions(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_FUNC_NONNULL((1, 2, 3, 4));

OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode
osvrDeviceAsyncInit(OSVR_IN_PTR OSVR_PluginRegContext ctx,
                    OSVR_IN_STRZ const char *name,
                    OSVR_OUT_PTR OSVR_DeviceToken *device)
    OSVR_FUNC_NONNULL((1, 2, 3));

OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode
osvrDeviceAsyncInitWithOptions(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_FUNC_NONNULL((1, 2, 3, 4));

OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode
osvrDeviceMicrosleep(OSVR_IN uint64_t microseconds);
 /* end of group */

OSVR_EXTERN_C_END

#endif