Canvas vs WebGL
The JS/WASM runtime provides various packages which are published to npm. For simple usage and best performance, we recommend starting with
@rive-app/canvas (more on that below). On the web, Rive offers the ability to use a backing CanvasRenderingContext2D context or WebGL context associated with a <canvas> element for rendering Rive animations.Note: The high-level API and the logic for creating a Rive instance in your script remain the same for the
@rive-app/webgl and @rive-app/canvas packages. That means if you decide one runtime package is better for your use case over the other, you only need to switch the dependency, but not the usage.
See more below on each of the different runtimes for JS/WASM and when to use which package.npm install @rive-app/canvas
An easy-to-use high-level Rive API using a backing CanvasRenderingContext2D renderer. This lets Rive use the browser's native high-level vector graphics renderer. Some benefits of this package:
- Extremely small download size
- Great for displaying many animated canvases concurrently on the screen. This is ideal for when you want to render lists or grids of Rive animations on the screen, as there is no context limit by the browser (as opposed to WebGL)
- Support for simple vector graphics animations and raster
- Requests the Web Assembly (WASM) backing dependency for you
- Web Assembly (WASM) backing dependency is part of the JS bundle; no need for any WASM request
- Highest fidelity with edit-time experience.
- Requests the Web Assembly (WASM) backing dependency for you
A note about WebGL: Most browsers limit the number of concurrent WebGL contexts by page/domain. Using Rive, this means that the browser limit impacts the number of
new Rive({...}) instances created. See the Rive Parameters docs for the useOffscreenRenderer option that may assist in working around this limitation.If you're planning on displaying Rive content in a list/grid or many times on the same page, it's up to you to manage the lifecycle of the provided context and
canvas element. If you need to display many animations (i.e grids/lists), consider using the @rive-app/canvas package which uses the CanvasRenderingContext2D renderer and does not have a context limitation.We are working on a better solution to getting around the browser context limit, while still being performant in various browsers.
It is highly recommended to set the
useOffscreenRenderer: true property in the Rive parameters when creating a new Rive({...}) object, especially when rendering multiple Rive objects on the page.A low-level Rive API using the CanvasRenderingContext2D renderer. It has the same benefits as the regular
@rive-app/canvas package plus:- Full control over the update and render loop
- Allows for rendering multiple Rive artboards to a single canvas
- Allows deeper control and manipulation of the components in a Rive hierarchy
- Web Assembly (WASM) is part of the NPM bundle, but you load in the WASM manually
A low-level Rive API using the WebGL renderer. It has the same benefits as the regular
@rive-app/webgl package plus:- Full control over the update and render loop.
- Allows for rendering multiple Rive artboards to a single canvas.
- Allows deeper control and manipulation of the components in a Rive hierarchy.
- Web Assembly (WASM) is part of the NPM bundle, but you load in the WASM manually
Each of the above NPM packages includes the
rive.wasm file. In the high-level APIs (@rive-app/canvas and @rive-app/webgl) the runtime requests this for you so you don't have to, as opposed to their -advanced counterparts. We also have alternative versions of each of the above packages on NPM that have the WASM encoded in the JS bundle. This means you won't have to make a network request for the WASM that powers the Rive animations, as it's all in one main JS file.While there is no request for WASM here, the JS bundle will be larger than the above packages. The non-single versions may cache better on your web applications, as the WASM gets loaded from the same CDN source if loaded from multiple pages.
Last modified 11d ago