Skip to main content

Unofficial Python bindings for OpenXR VR/AR device access

Project description

pyopenxr

Unofficial Python bindings for the OpenXR SDK to access VR and AR devices

pyopenxr is a Python developer SDK for device tracking and rapid virtual reality prototyping using the headset-agnostic OpenXR API. It provides a clean, Pythonic interface to the OpenXR runtime, enabling cross-platform AR/VR development with minimal boilerplate.

Build Status Pages Doc Status Documentation License

hello_xr1


🚀 Installation

pip install pyopenxr

🧪 Quick Start

import xr

# Query the available VR/AR extensions
available = xr.enumerate_instance_extension_properties()

# Replace with whatever extensions are required for your application...
required = [xr.KHR_OPENGL_ENABLE_EXTENSION_NAME]
for prop in required:
    assert prop in available

Explore the complete working example hello_xr.py for a hands-on introduction.

Pythonic naming conventions

symbol Python example C example
function xr.create_instance(...) xrCreateInstance(...)
constant xr.MAX_SYSTEM_NAME_SIZE XR_MAX_SYSTEM_NAME_SIZE
struct name xr.ExtensionProperties XrExtensionProperties
type alias xr.Version XrVersion
enum type xr.FormFactor xrFormFactor
enum value xr.FormFactor.HEAD_MOUNTED_DISPLAY XR_FORM_FACTOR_HEAD_MOUNTED_DISPLAY
handle xr.Instance XrInstance

📚 Documentation

Full API reference and guides are available

📦 License

This project is licensed under the Apache License 2.0.

Copyright © 2021 Christopher Bruns.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyopenxr-1.1.5301.tar.gz (20.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyopenxr-1.1.5301-py3-none-any.whl (20.4 MB view details)

Uploaded Python 3

File details

Details for the file pyopenxr-1.1.5301.tar.gz.

File metadata

  • Download URL: pyopenxr-1.1.5301.tar.gz
  • Upload date:
  • Size: 20.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.13

File hashes

Hashes for pyopenxr-1.1.5301.tar.gz
Algorithm Hash digest
SHA256 7e6aa6fbaed930206385ac2c0bda641b2bae194cdbe62a2bb310f562dc1d4e17
MD5 7ef77fc89406527e295f85373bbf6f68
BLAKE2b-256 ac65220a2950833b4b862364defb9acb798ca9ed1b640c4e3fa3240c2c4c3834

See more details on using hashes here.

File details

Details for the file pyopenxr-1.1.5301-py3-none-any.whl.

File metadata

  • Download URL: pyopenxr-1.1.5301-py3-none-any.whl
  • Upload date:
  • Size: 20.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.13

File hashes

Hashes for pyopenxr-1.1.5301-py3-none-any.whl
Algorithm Hash digest
SHA256 83da1ea6534e55cf5e88860870fa7cc48ec977a58bf173b3d4bfbc273926e3b2
MD5 e630d7320ac9ea2f8d7033a01a092b26
BLAKE2b-256 a80f3703e541dc6e4163b8ea1c5a562cfb5c32515ffb1bb0f9f24d4c7db90c19

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page