OSVR Framework (Internal Development Docs)  0.6-1962-g59773924
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
OSVR Framework (Internal Development Docs) Documentation

Maintained at https://github.com/OSVR/OSVR-Core

For details, see http://osvr.github.io

For support, see http://support.osvr.com

This is the code and libraries to use when developing with OSVR.

  • For developing plugins, you'll use the PluginKit library.
  • For developing applications using the framework, you'll use the ClientKit library.

Binary Snapshot Documentation

If you're looking at this file in a binary build of OSVR-Core, please seen the BINARY_README file for more targeted information, as this main README file is focused on the source tree.

Source Documentation

See the HACKING file for some development guidelines for working on this code base itself.

If you're looking at the source tree, not a binary snapshot, you may be interested in build docs. You may also be interested in binary snapshots at http://osvr.github.io .

License and Vendored Projects

This project: Licensed under the Apache License, Version 2.0.

Some directories under /vendor are in fact not external libraries vendored-in, but "internally-vendored" - developed as a part of OSVR-Core, and likewise licensed under the Apache License 2.0, but are logically distinct from the Core in their functionality and are thus kept separate in anticipation of potential splitting off into a separate project at some future point. These include /vendor/comutils and /vendor/dummy-sal.