summaryrefslogtreecommitdiffstats
path: root/gfx/vr/service/osvr/Util/ClientOpaqueTypesC.h
diff options
context:
space:
mode:
Diffstat (limited to 'gfx/vr/service/osvr/Util/ClientOpaqueTypesC.h')
-rw-r--r--gfx/vr/service/osvr/Util/ClientOpaqueTypesC.h69
1 files changed, 69 insertions, 0 deletions
diff --git a/gfx/vr/service/osvr/Util/ClientOpaqueTypesC.h b/gfx/vr/service/osvr/Util/ClientOpaqueTypesC.h
new file mode 100644
index 0000000000..84203bb0d4
--- /dev/null
+++ b/gfx/vr/service/osvr/Util/ClientOpaqueTypesC.h
@@ -0,0 +1,69 @@
+/** @file
+ @brief Header declaring opaque types used by @ref Client and @ref ClientKit
+
+ Must be c-safe!
+
+ @date 2014
+
+ @author
+ Sensics, Inc.
+ <http://sensics.com/osvr>
+*/
+
+/*
+// 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_ClientOpaqueTypesC_h_GUID_24B79ED2_5751_4BA2_1690_BBD250EBC0C1
+#define INCLUDED_ClientOpaqueTypesC_h_GUID_24B79ED2_5751_4BA2_1690_BBD250EBC0C1
+
+/* Internal Includes */
+#include <osvr/Util/APIBaseC.h>
+
+/* Library/third-party includes */
+/* none */
+
+/* Standard includes */
+/* none */
+
+OSVR_EXTERN_C_BEGIN
+
+/** @addtogroup ClientKit
+ @{
+*/
+/** @brief Opaque handle that should be retained by your application. You need
+ only and exactly one.
+
+ Created by osvrClientInit() at application start.
+
+ You are required to clean up this handle with osvrClientShutdown().
+*/
+typedef struct OSVR_ClientContextObject* OSVR_ClientContext;
+
+/** @brief Opaque handle to an interface used for registering callbacks and
+ getting status.
+
+ You are not required to clean up this handle (it will be automatically
+ cleaned up when the context is), but you can if you are no longer using it,
+ using osvrClientFreeInterface() to inform the context that you no longer need
+ this interface.
+*/
+typedef struct OSVR_ClientInterfaceObject* OSVR_ClientInterface;
+
+/** @} */
+
+OSVR_EXTERN_C_END
+
+#endif