Releases
This page lists only the releases that introduce breaking changes, providing the essential information needed to update your projects seamlessly. We highly recommend reviewing this section before upgrading. For a complete history of all releases and their changes, refer to the CHANGELOG.md.
If you encounter issues or need guidance, please refer to our documentation or open an issue on GitHub.
3.x
3.5.0
This update adds WebGPU support and enables it by default. When WebGPU isn’t available, the engine automatically falls back to WebGL.
A new prop, forceWebGL (default: false), allows you to explicitly use the WebGL engine even when WebGPU is supported. This is particularly useful for WebXR, which currently does not work with WebGPU.
If you are migrating to version 3.5.0 and you are using WebGPU:
-
If you use the following features, you must add the corresponding side-effect imports once in your project:
- If you use
<dynamicTexture>or<advancedDynamicTexture>(e.g.: GUI), add:
import '@babylonjs/core/Engines/WebGPU/Extensions/engine.dynamicTexture'- If you use
<videoTexture>, add:
import '@babylonjs/core/Engines/WebGPU/Extensions/engine.videoTexture'Why: Unlike the other side-effect imports that are automatically injected by
babel-plugin-reactylon, these cannot be added for you. The plugin relies on static analysis, which means it cannot evaluate runtime expressions or follow dynamic control flow to figure out whether your app will actually use the WebGPU engine (which requires these side effect) or the WebGL engine (which does not). To keep your bundle as small as possible, you are responsible for adding these imports only when you actually use these features with WebGPU. - If you use
-
If you use WebXR, you must set
forceWebGLto true on the<Engine>component.<Engine forceWebGL><Scene /></Engine>
- The
antialias(enabled by default) andadaptToDeviceRatioprops of the<Engine>component are now part ofengineOptions.
3.0.0
The major update introduced in this version is tree shaking, a technique used to reduce the bundle size. Tree shaking works by analyzing your code and removing any unused or dead code from the final bundle, making the application faster and more efficient. If you are migrating to version 3.0.0 all you need to do is to install and configure the Babel Plugin Reactylon.
2.x
2.0.0
The major update introduced in this version is compatibility with React 19. If you are migrating to version 2.0.0, you have two choices:
-
Upgrade to React 19 - no changes are required.
-
Stay on React 18 - to maintaint compatibility, install
react-reconcilerpackage to version 0.29.2 with:npm install react-reconciler@0.29.2 --save
1.0.0
This is the first initial release.