OSVR-Core
AnalysisPluginKitC.h
Go to the documentation of this file.
1 
13 /*
14 // Copyright 2015 Sensics, Inc.
15 //
16 // Licensed under the Apache License, Version 2.0 (the "License");
17 // you may not use this file except in compliance with the License.
18 // You may obtain a copy of the License at
19 //
20 // http://www.apache.org/licenses/LICENSE-2.0
21 //
22 // Unless required by applicable law or agreed to in writing, software
23 // distributed under the License is distributed on an "AS IS" BASIS,
24 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
25 // See the License for the specific language governing permissions and
26 // limitations under the License.
27 */
28 
29 #ifndef INCLUDED_AnalysisPluginKitC_h_GUID_A33681AB_B02B_4DA1_83EF_4E4EB265E387
30 #define INCLUDED_AnalysisPluginKitC_h_GUID_A33681AB_B02B_4DA1_83EF_4E4EB265E387
31 
32 /* Internal Includes */
33 #include <osvr/AnalysisPluginKit/Export.h>
34 #include <osvr/Util/APIBaseC.h>
35 #include <osvr/Util/ReturnCodesC.h>
38 
39 /* Library/third-party includes */
40 /* none */
41 
42 /* Standard includes */
43 /* none */
44 
45 OSVR_EXTERN_C_BEGIN
68 OSVR_ANALYSISPLUGINKIT_EXPORT OSVR_ReturnCode osvrAnalysisSyncInit(
69  OSVR_IN_PTR OSVR_PluginRegContext ctx, OSVR_IN_STRZ const char *name,
73  OSVR_FUNC_NONNULL((1, 2, 3, 4, 5)); /* end of group */
75 
76 OSVR_EXTERN_C_END
77 
78 #endif
#define OSVR_OUT_PTR
Indicates a required pointer (non-null) function parameter that serves only as output.
Definition: AnnotationMacrosC.h:151
OSVR_ANALYSISPLUGINKIT_EXPORT OSVR_ReturnCode osvrAnalysisSyncInit(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_OUT_PTR OSVR_ClientContext *clientCtx) OSVR_FUNC_NONNULL((1
Initialize a synchronous analysis device token with the options specified, also returning the associa...
#define OSVR_IN_STRZ
Indicates a null-terminated string function parameter that serves only as input.
Definition: AnnotationMacrosC.h:124
Header declaring a type and values for simple C return codes.
#define OSVR_IN_PTR
Indicates a required pointer (non-null) function parameter that serves only as input.
Definition: AnnotationMacrosC.h:108
A DeviceToken connects the generic device interaction code in PluginKit&#39;s C API with the workings of ...
Definition: DeviceToken.h:56
Header declaring opaque types used by Client and ClientKit.
#define OSVR_FUNC_NONNULL(X)
Indicates the parameter(s) that must be non-null.
Definition: AnnotationMacrosC.h:202
Structure used internally to construct the desired type of device.
Definition: DeviceInitObject.h:59
Header providing basic C macros for defining API headers.
Definition: ClientContext.h:50
OSVR_EXTERN_C_BEGIN typedef void * OSVR_PluginRegContext
A context pointer passed in to your plugin&#39;s entry point and other locations of control flow transfer...
Definition: PluginRegContextC.h:47