Repository for the WebXR Device API Specification.
Clone or download

README.md

WebXR Device API Specification

Build Status

WebXR is driving support for accessing virtual reality (VR) and augmented reality (AR) devices, including sensors and head-mounted displays on the Web.

This is currently the repository for the WebVR Community Group and the WebXR Device API Specification. We have a charter (in progress).

The specification has recently undergone a name change, so expect to see multiple references to "WebVR" sprinkled throughout.

Specifications

  • WebXR Device API Specification: Main specification for JavaScript API for accessing VR and AR devices, including sensors and head-mounted displays.
  • Legacy WebVR API Specification: Legacy WebVR API 1.1 specification for JavaScript API for accessing VR displays. Development of the WebVR API has halted in favor of being replaced the WebXR Device API. Several browsers will continue to support this version of the API in the meantime.
  • Gamepad API Specification: Introduces a low-level JS API interface for accessing gamepad devices.
  • Gamepad Extensions API Specification: Extends the Gamepad API to enable access to more advanced device capabilities.

Relevant Links

Communication

Maintainers

To generate the spec document (index.html) from the index.bs Bikeshed document:

make

Tests

For normative changes, a corresponding web-platform-tests PR is highly appreciated. Typically, both PRs will be merged at the same time. Note that a test change that contradicts the spec should not be merged before the corresponding spec change. If testing is not practical, please explain why and if appropriate file a web-platform-tests issue to follow up later. Add the type:untestable or type:missing-coverage label as appropriate.

License

Per the LICENSE.md file:

All Reports in this Repository are licensed by Contributors under the W3C Software and Document License.

Contributions to Specifications are made under the W3C CLA.

Contributions to Test Suites are made under the W3C 3-clause BSD License