ButtonInterfaceC.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_ButtonInterfaceC_h_GUID_64F54A8F_976B_4A87_7BEA_D5CE628B3E6C
#define INCLUDED_ButtonInterfaceC_h_GUID_64F54A8F_976B_4A87_7BEA_D5CE628B3E6C

/* Internal Includes */
#include <osvr/PluginKit/DeviceInterfaceC.h>
#include <osvr/Util/ClientReportTypesC.h>
#include <osvr/Util/ChannelCountC.h>

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

/* Standard includes */
/* none */

OSVR_EXTERN_C_BEGIN

typedef struct OSVR_ButtonDeviceInterfaceObject *OSVR_ButtonDeviceInterface;

OSVR_PLUGINKIT_EXPORT
OSVR_ReturnCode
osvrDeviceButtonConfigure(OSVR_IN_PTR OSVR_DeviceInitOptions opts,
                          OSVR_OUT_PTR OSVR_ButtonDeviceInterface *iface,
                          OSVR_IN OSVR_ChannelCount numChan)
    OSVR_FUNC_NONNULL((1, 2));

OSVR_PLUGINKIT_EXPORT
OSVR_ReturnCode osvrDeviceButtonSetValue(OSVR_IN_PTR OSVR_DeviceToken dev,
                                         OSVR_IN_PTR OSVR_ButtonDeviceInterface
                                             iface,
                                         OSVR_IN OSVR_ButtonState val,
                                         OSVR_IN OSVR_ChannelCount chan)
    OSVR_FUNC_NONNULL((1, 2));

OSVR_PLUGINKIT_EXPORT
OSVR_ReturnCode osvrDeviceButtonSetValueTimestamped(
    OSVR_IN_PTR OSVR_DeviceToken dev,
    OSVR_IN_PTR OSVR_ButtonDeviceInterface iface, OSVR_IN OSVR_ButtonState val,
    OSVR_IN OSVR_ChannelCount chan, OSVR_IN_PTR OSVR_TimeValue const *timestamp)
    OSVR_FUNC_NONNULL((1, 2, 5));

OSVR_PLUGINKIT_EXPORT
OSVR_ReturnCode osvrDeviceButtonSetValues(OSVR_INOUT_PTR OSVR_DeviceToken dev,
                                          OSVR_IN_PTR OSVR_ButtonDeviceInterface
                                              iface,
                                          OSVR_IN_PTR OSVR_ButtonState val[],
                                          OSVR_IN OSVR_ChannelCount chans)
    OSVR_FUNC_NONNULL((1, 2, 3));

OSVR_PLUGINKIT_EXPORT
OSVR_ReturnCode osvrDeviceButtonSetValuesTimestamped(
    OSVR_IN_PTR OSVR_DeviceToken dev,
    OSVR_IN_PTR OSVR_ButtonDeviceInterface iface,
    OSVR_IN_PTR OSVR_ButtonState val[], OSVR_IN OSVR_ChannelCount chans,
    OSVR_IN_PTR OSVR_TimeValue const *timestamp)
    OSVR_FUNC_NONNULL((1, 2, 3, 5));
 /* end of group */

OSVR_EXTERN_C_END

#endif