Metadata-Version: 2.1
Name: openxr
Version: 0.0.2
Summary: OpenXR bindings for Python.
Home-page: https://github.com/drypy/openxr.py
Author: Arto Bendiken
Author-email: arto@bendiken.net
License: Public Domain
Project-URL: Source Code, https://github.com/drypy/openxr.py
Project-URL: Documentation, https://github.com/drypy/openxr.py/blob/master/README.md
Project-URL: Bug Tracker, https://github.com/drypy/openxr.py/issues
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: Public Domain
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Multimedia :: Graphics :: 3D Rendering
Classifier: Topic :: Scientific/Engineering :: Human Machine Interfaces
Classifier: Topic :: Software Development :: User Interfaces
Requires-Python: ~=3.6
Description-Content-Type: text/markdown
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'

OpenXR for Python
=================

[![Project license](https://img.shields.io/badge/license-Public%20Domain-blue.svg)](https://unlicense.org)
[![PyPI package](https://img.shields.io/pypi/v/openxr.svg)](https://pypi.org/project/openxr/)

This project provides [ctypes](https://docs.python.org/3/library/ctypes.html)
bindings to enable programming with [OpenXR](https://www.khronos.org/openxr/)
from Python.

OpenXR is the new cross-platform, open standard and API for virtual reality
(VR) and augmented reality (AR) devices. (Think OpenGL for VR/AR.)

Installation
------------

    $ pip3 install openxr

Prerequisites
-------------

- [Python](https://www.python.org) 3.6+
- [OpenXR SDK](https://github.com/KhronosGroup/OpenXR-SDK) 1.0.8+

Examples
--------

### Loading the library

    import openxr

Development
-----------

We recommend Debian 11 (aka [Bullseye](https://www.debian.org/releases/bullseye/))
as a development environment. If you're on a Mac, you can run Debian in a
virtual machine using [VMware Fusion](https://www.vmware.com/products/fusion.html)
or [VirtualBox](https://www.virtualbox.org).

Install the Debian packages for the OpenXR SDK's loader as follows:

    $ apt install libopenxr-loader1

That is the only required package. Find related packages of interest using:

    $ apt search openxr

In addition, you _will_ need an OpenXR runtime for your hardware. In the
absence of suitable vendor-supplied runtimes, have a look at the open-source
[Monado](https://monado.freedesktop.org) project which supports many common
devices.


