libgoatvr

view src/vr.h @ 25:bb85be761b50

started the documentation
author John Tsiombikas <nuclear@member.fsf.org>
date Sun, 08 Mar 2015 05:30:02 +0200
parents 1067274dc780
children 7eea82cea9d2
line source
1 #ifndef VR_H_
2 #define VR_H_
4 /* unit: pixels */
5 #define VR_DISPLAY_WIDTH "display-xres"
6 #define VR_DISPLAY_HEIGHT "display-yres"
7 #define VR_LEYE_XRES "left-eye-xres"
8 #define VR_LEYE_YRES "left-eye-yres"
9 #define VR_REYE_XRES "right-eye-xres"
10 #define VR_REYE_YRES "right-eye-yres"
11 #define VR_RENDER_XRES "render-xres" /* VR_LEYE_XRES + VR_REYE_XRES */
12 #define VR_RENDER_YRES "render-yres" /* max(VR_LEYE_YRES, VR_REYE_YRES) */
13 #define VR_WIN_XOFFS "win-xoffset"
14 #define VR_WIN_YOFFS "win-yoffset"
15 #define VR_RENDER_RES_SCALE "render-res-scale" /* default 1 */
16 /* unit: meters */
17 #define VR_EYE_HEIGHT "eye-height"
18 #define VR_IPD "ipd"
19 #define VR_LEYE_OFFSET "left-eye-offset" /* stereo offset from center of the head */
20 #define VR_REYE_OFFSET "right-eye-offset" /* stereo offset from center of the head */
21 /* misc options */
22 #define VR_NULL_STEREO "null-stereo" /* bool, default 0 */
24 enum {
25 VR_EYE_LEFT,
26 VR_EYE_RIGHT
27 };
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
33 int vr_init(void);
34 void vr_shutdown(void);
36 int vr_module_count(void);
37 const char *vr_module_name(int idx);
39 int vr_use_module(int idx);
40 int vr_use_module_named(const char *name);
42 void vr_seti(const char *optname, int val);
43 void vr_setf(const char *optname, float val);
44 int vr_geti(const char *optname);
45 float vr_getf(const char *optname);
46 float *vr_getfv(const char *optname, float *res);
47 /* variants of the get functions, with an additional "default value"
48 * argument, which is returned if the requested option is missing
49 */
50 int vr_geti_def(const char *optname, int def_val);
51 float vr_getf_def(const char *optname, float def_val);
53 int vr_view_translation(int eye, float *vec);
54 int vr_view_rotation(int eye, float *quat);
56 /* returns non-zero if the active vr module provides this kind of matrix
57 * information, otherwise it returns zero, and sets mat to identity
58 */
59 int vr_view_matrix(int eye, float *mat);
60 int vr_proj_matrix(int eye, float znear, float zfar, float *mat);
62 void vr_begin(int eye);
63 void vr_end(void);
64 int vr_swap_buffers(void);
66 /* set the output texture or separate textures for each eye */
67 void vr_output_texture(unsigned int tex, float umin, float vmin, float umax, float vmax);
68 void vr_output_texture_eye(int eye, unsigned int tex, float umin, float vmin, float umax, float vmax);
70 void vr_recenter(void);
72 #ifdef __cplusplus
73 }
74 #endif
76 #endif /* VR_H_ */