libgoatvr
annotate doc/index.rst @ 25:bb85be761b50
started the documentation
| author | John Tsiombikas <nuclear@member.fsf.org> |
|---|---|
| date | Sun, 08 Mar 2015 05:30:02 +0200 |
| parents | |
| children | e819f63535b3 |
| rev | line source |
|---|---|
| nuclear@25 | 1 libgoatvr |
| nuclear@25 | 2 ========= |
| nuclear@25 | 3 |
| nuclear@25 | 4 **This documentation is incomplete** |
| nuclear@25 | 5 |
| nuclear@25 | 6 Overview |
| nuclear@25 | 7 -------- |
| nuclear@25 | 8 |
| nuclear@25 | 9 Libgoatvr is a simplified abstraction library for dealing with VR headsets. It |
| nuclear@25 | 10 is designed to expose a single common API to access VR HMDs through any of the |
| nuclear@25 | 11 supported backend modules, such as the Oculus SDK or OpenHMD, even allowing the |
| nuclear@25 | 12 application to switch between them at runtime. |
| nuclear@25 | 13 |
| nuclear@25 | 14 This documentation describes how to use libgoatvr in your programs, and is |
| nuclear@25 | 15 split into the following sections: |
| nuclear@25 | 16 |
| nuclear@25 | 17 1. Initialization_ |
| nuclear@25 | 18 2. Head tracking |
| nuclear@25 | 19 3. Rendering |
| nuclear@25 | 20 4. options and properties |
| nuclear@25 | 21 |
| nuclear@25 | 22 .. _Initialization: 1-init.html |