Skip to content

v0.10.0
Compare
Choose a tag to compare
@jsantell jsantell released this 18 Dec 23:09
· 42 commits to master since this release
v0.10.0
1680b67

v0.10.0

This is one of the largest updates for the Polyfill in quite some time! Most changes are refactoring, focusing on pulling pieces out to make it easier to scope, test, and work on future changes as the WebXR Device API approaches, so we can be more confident in changes without breaking edge cases. The polyfill was also scope creeping a bit, doing more than just providing a stable API surface for developers to target, and many of these features have been removed that are better off in userland and on a per-project basis.

Feature Changes

  • The polyfill is now enabled by calling the exposed constructor, new window.WebVRPolyfill(options). Previously this was handled by defining options on a global window.WebVRConfig object, and the polyfill would instantiate itself immediately, or require the user to call window.InitializeWebVRPolyfill() if DEFER_INITIALIZATION was set. DEFER_INITIALIZATION has been removed, the polyfill no longer instantiates itself, and options are passed into the constructor rather than relying on a global object. This makes it easier to work with in module environments and other JS build systems.
  • The webvr-polyfill no longer supports adapting 1.0 WebVR APIs to work with 1.1 content. In the event of a 1.0 browser using the polyfill, everything will be polyfilled as if 1.0 support does not exist. InstallWebVRSpecShim() has been removed.
  • navigator.vrEnabled property has been removed. This was used to indicate if displays exist, which can be done by checking the return value of getVRDisplays().
  • MouseKeyboardVRDisplay has been removed. This provided a monoview VRDisplay with some primitive controls for a 3DOF experience. This is better handled with custom controls or OrbitControls depending on the experience. MOUSE_KEYBOARD_CONTROLS_DISABLED option has been removed. This means on desktop, the only displays that can exist are native, so user code should handle when no displays are found.
  • Rules for injecting polyfilled displays have changed and simplified. With the removal of MouseKeyboardVRDisplay, and the WebXR Device API only allowing one display rather than an array of displays, ALWAYS_APPEND_POLYFILL_DISPLAY has been removed. A new option, PROVIDE_MOBILE_VRDISPLAY has been created to provide a CardboardVRDisplay when on mobile and the native API exists but no native displays exists. true by default, this means that the polyfill is always injected on mobile when enabled, since we won't know immediately if any native displays exist. FORCE_ENABLE_VR has been removed. This always provided a CardboardVRDisplay, even on desktop, used mostly for debugging purposes.
  • TOUCH_PANNER_DISABLED has been removed. This is not a part of the WebVR 1.1 spec.
  • Added a DEBUG option. Previously this was triggered by a ?debug query parameter, which caused issues with other environments.
  • The main package.json entry now points to the built output rather than src/node-entry. This lets us take advantage of our build system and not require consumers to handle any transformations implemented.
  • Many WebVRPolyfill methods and properties have been removed: isFullScreenAvailable, isCardboardCompatible, isMobile, NativeVRFrameData, getVRDevices, enableDeprecatedPolyfill, isDeprecatedWebVRAvailable, isWebVRAvailable.

Infrastructure Changes

  • The CardboardVRDisplay has been pulled out of webvr-polyfill into it's own repo googlevr/cardboard-vr-display. This is by far the most complex part of the polyfill, and pulling it into its own repo makes it easier to draw an abstraction line between the polyfill and CardboardVRDisplay, consolidate cardboard-specific rendering issues, allow others to consume and use the CardboardVRDisplay alone, and make it easier to contribute.
  • We now have some tests! The tests cover the logic behind when and how things are polyfilled. There aren't many tests yet as it took a bit to get to this point, but looking forward to even more test coverage in the future.
  • Migrated from Webpack to Rollup for building. We've experimented with Rollup for our team's other projects and prefer it for libraries that are consumed by other projects due to its tree-shaking (227kb to 179kb for webvr-polyfill.js) and it's more simple configurations.
Assets 4
Loading