README 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. === OpenHMD ===
  2. This project aims to provide a Free and Open Source API and drivers for immersive technology, such as head mounted displays with built in head tracking.
  3. === License ===
  4. OpenHMD is released under the permissive Boost Software License (see LICENSE for more information), to make sure it can be linked and distributed with both free and non-free software. While it doesn't require contribution from the users, it is still very appriciated.
  5. === Supported Devices ===
  6. * Oculus Rift (SDK)
  7. == Supported Platforms ===
  8. * Linux
  9. * Windows
  10. * Mac Os X
  11. === Requirements ===
  12. * HIDAPI
  13. * http://www.signal11.us/oss/hidapi/
  14. * https://github.com/signal11/hidapi/
  15. === Compiling and Installing ===
  16. ./configure
  17. make
  18. sudo make install
  19. == Cross compiling for windows using mingw ==
  20. export PREFIX=/usr/i686-w64-mingw32/ (or whatever your mingw path is)
  21. PKG_CONFIG_LIBDIR=$PREFIX/lib/pkgconfig ./configure --build=`gcc -dumpmachine` --host=i686-w64-mingw32 --prefix=$PREFIX
  22. make
  23. the library will end up in the .lib directory, you can use microsoft's lib.exe to make a .lib file for it
  24. == Static linking on windows ==
  25. If you're linking statically with OpenHMD using windows/mingw you have to make sure the macro OHMD_STATIC is set before including openhmd.h. In GCC this can be done by adding the compiler flag -DOHMD_STATIC, and with msvc it can be done using /DOHMD_STATIC.
  26. Note that this is *only* if you're linking statically! If you're using the DLL then you *must not* define OHMD_STATIC. (If you're not sure then you're probably linking dynamically and won't have to worry about this).
  27. === Pre-built packages ===
  28. ...
  29. === Using OpenHMD ===
  30. The distribution provides a number of usage examples under the examples/ subdirectory.