Monado OpenXR Runtime
ns_interface.h
Go to the documentation of this file.
1 // Copyright 2019-2020, Collabora, Ltd.
2 // Copyright 2020, Nova King.
3 // SPDX-License-Identifier: BSL-1.0
4 /*!
5  * @file
6  * @brief Interface to North Star driver code.
7  * @author Nova King <technobaboo@gmail.com>
8  * @ingroup drv_ns
9  */
10 
11 #pragma once
12 
13 #ifdef __cplusplus
14 extern "C" {
15 #endif
16 
17 
18 /*!
19  * @defgroup drv_ns North Star driver
20  * @ingroup drv
21  *
22  * @brief Driver for the North Star HMD.
23  */
24 
25 /*!
26  * Create a probe for NS devices.
27  *
28  * @ingroup drv_ns
29  */
30 struct xrt_auto_prober *
31 ns_create_auto_prober(void);
32 
33 /*!
34  * Create a North Star hmd.
35  *
36  * @ingroup drv_ns
37  */
38 struct xrt_device *
39 ns_hmd_create(const char *config_path, bool print_spew, bool print_debug);
40 
41 /*!
42  * @dir drivers/north_star
43  *
44  * @brief @ref drv_ns files.
45  */
46 
47 
48 #ifdef __cplusplus
49 }
50 #endif
xrt_auto_prober
A simple prober to probe for a HMD device connected to the system.
Definition: xrt_prober.h:333
ns_create_auto_prober
struct xrt_auto_prober * ns_create_auto_prober(void)
Create a probe for NS devices.
Definition: ns_prober.c:69
ns_hmd_create
struct xrt_device * ns_hmd_create(const char *config_path, bool print_spew, bool print_debug)
Create a North Star hmd.
Definition: ns_hmd.c:290
xrt_device
A single HMD or input device.
Definition: xrt_device.h:203
Generated by   doxygen 1.8.13