AR Engine SDK

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