AR Engine SDK

v1.6.12 (2024-04-29)


  • Fixes related to input events when using Onirix Player app.
  • Avoiding pollution of WebGL context when using WebXR.

v1.6.11 (2024-04-22)


  • Fixes for Spatial AR localization

v1.6.10 (2024-04-12)


  • Fixes for OnTouch events

v1.6.9 (2024-04-05)


  • Fixed a FOV issue within Web XR sessions

v1.6.8 (2024-04-03)


  • Supporting Spatial AR from Onirix Player app

v1.6.7 (2024-03-18)


  • Fix camera feed placement in Samsung Internet.

v1.6.6 (2024-03-15)


  • Avoid asking for WebXR permissions from Onirix Player app

v1.6.5 (2024-02-28)


  • Upgraded SDK package for Spatial mode now simplifies deployment by eliminating the need for self-hosting workers on user domains.

v1.6.4 (2024-02-28)


  • Added 'highResolutionCamera' configuration parameter (default: false) to increase the resolution of the camera feed.

v1.6.3 (2024-02-14)


  • The init method can now throw a 'ReconstructionPendingError' to indicate that the Spatial scene is not yet ready for localization.

v1.6.2 (2024-02-02)


  • Other fixes for some iOS WebXR-compatible browsers (Mozilla XR Viewer, XR Browser).

v1.6.1 (2024-02-01)


  • Fixed a bug that prevented initialization in some iOS WebXR-compatible browsers (Mozilla XR Viewer, XR Browser).

v1.6.0 (2024-01-25)


  • Introduced 'Spatial' mode enabling localization within previously scanned environments (spaces). This feature allows for precise placement of virtual objects in that spaces.

v1.5.7 (2024-01-22)


  • Improved World-Tracking to handle better outdoor environments and rotation-only movements.

v1.5.6 (2023-12-05)


  • Added "cameraAccess" config parameter for enabling WebXR raw camera access feature.

v1.5.5 (2023-11-22)


  • Hit test plane now faces camera when inside a WebXR session
  • Fixed touch events for some iOS browsers (Mozilla XR Viewer and XR Browser)

v1.5.4 (2023-11-15)


  • Fixed backface camera selection under certain circumstances

v1.5.3 (2023-10-20)


  • Fixed other issues regarding resizing the browser window during a WebXR session.

v1.5.2 (2023-10-12)


  • Fixed other bug that produced render canvas not to resize correctly within a WebXR session.

v1.5.1 (2023-10-11)


  • Fixed bug that produced render canvas not to resize correctly within a WebXR session.

v1.5.0 (2023-09-20)


  • Support for WebXR capable iOS browsers (Mozilla XR Viewer and XR Browser).


  • Mitigation for WebXR orientation bug in Google Chrome.

v1.4.2 (2023-07-25)


  • World-Tracking jitter in certain circunstances

v1.4.1 (2023-07-19)


  • World-Tracking fixes

v1.4.0 (2023-07-18)


  • World-Tracking now handles better rotation-only movements.
  • Adaptative tracking parameters for a more balanced performance / quality tradeoff.

v1.3.1 (2023-06-21)


  • Pose smoothing adjustements to reduce jitter.
  • Minor performance improvements.

v1.3.0 (2023-06-13)


  • Significant improvements in World-Tracking. Tracking now works well in non-planar environments and is more robust under high motion and ilumination changes.

v1.2.2 (2023-06-02)


  • Disabled camera access in WebXR as some devices were showing the android status bar as an overlay due to a bug.
  • Improved pose filtering for image tracking.

v1.2.1 (2023-05-26)


  • Allow camera access in WebXR.
  • New "getXRParams" method for retrieving webXR session info.

v1.2.0 (2023-05-25)


  • Significant improvements in World-Tracking. Less drift and better stability in textureless environments.
  • New "TRACKING_LIMITED" World-Tracking status. It outputs when the tracking was lost but partially recovered.

v1.1.2 (2023-02-22)


  • CORS error when loading images at runtime (addImage function) from external sites.

v1.1.1 (2023-02-21)


  • QR Code pose orientation.

v1.1.0 (2023-02-10)


  • OnLost(undefined) call before any OnDetected call for Image and QRCode tracking.


  • Improved accuracy and performance of Onirix custom World-Tracking.

v1.0.0 (2023-01-19)

Breaking changes:

  • All tracking modes now require calling the start method after initializing in order to run.
  • Removed useWebXR config option. It can now be disabled using the new disableWebXR option.


  • Added custom World Tracking capabilities for Surface mode in case running devices don't support WebXR. Can also be forced by using the config option disableWebXR = true to develop more homogeneous experiences between devices and operating systems.
  • Added start and stop methods in order to control when tracking is active after initialization.
  • Added OnFrame event in order to synchronize tracking with 3D engine rendering.
  • Added disableWebXR and disableWorldTracking options for Surface mode.

v0.4.5 (2022-11-15)


  • Render canvas is now added as the first body element to avoid modifying z-index for same index UI elements

v0.4.4 (2022-09-16)


  • Updated permission dialog styles

v0.4.3 (2022-07-15)


  • Fixed rotation on hit test


  • Added OnTouchStart, OnTouchEnd, OnTouchMove and OnSessionEnd events

v0.4.2 (2022-04-02)

  • Use WebGL2 when possible

v0.4.1 (2022-03-16)

  • First NPM build

v0.4.0 (2022-02-24)

  • Decreased size of WASM module significantly.

v0.3.0 (2021-07-16)

  • Breacking changes:
    • SDK is now an ES6 module. This allows for tree-shacking and integration with bundlers (Webpack, Rollup ...).
    • SDK token is now passed in the OnirixSDK constructor instead of the config object.
  • Added stop() method for stopping the SDK and free resources.
  • Added hit test support for Surface-Tracking mode. A new hit test event will be triggered each time a surface is detected.
  • Added addImage(url) method to allow adding image markers on runtime. Currently only 640x480px images are supported.
  • Added unsubscribe(eventListener) method to allow unsubscribing from OnirixSDK events.
  • Other minor improvements

v0.2.0 (2021-05-22)

  • Added support for WebXR device API. This means, when using surface mode, objects will remain anchored to a surface (both in position and rotation) and thus, provide a more reallistic AR experience. This feature is now used by default on compatible devices, and automatically falled back to the old gyroscope emulated mode for non-compatible devices.

v0.1.0 (2021-03-26)

  • Initial release.
  • Includes 3 tracking modes:
    • Surface (gyroscope emulated)
    • Image
    • QR Code