@rive-app/webgl-single 1.0.56 → 1.0.59
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -6
- package/package.json +1 -1
- package/rive.js +8 -8
- package/rive.js.map +1 -1
package/README.md
CHANGED
|
@@ -1,16 +1,19 @@
|
|
|
1
1
|
|
|
2
2
|
|
|
3
3
|
# Rive
|
|
4
|
-
High
|
|
4
|
+
High-level Rive API using WebGL and inline WASM. Please see https://github.com/rive-app/rive-wasm for a list of all the available web runtimes and their details.
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
## WebGL Single
|
|
7
7
|
```
|
|
8
8
|
npm install @rive-app/webgl-single
|
|
9
9
|
```
|
|
10
|
-
An easy
|
|
10
|
+
An easy-to-use high-level Rive API using the [WebGL](https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API) renderer. This runtime will support Rive's upcoming advanced rendering features which may not be available to the Canvas renderers. Some benefits of this package:
|
|
11
11
|
- Highest fidelity with edit-time experience.
|
|
12
|
-
-
|
|
13
|
-
-
|
|
12
|
+
- Support for future advanced rendering features
|
|
13
|
+
- Web Assembly (WASM) is part of the JS bundle; there is no need to make a request to load it in at runtime
|
|
14
14
|
|
|
15
|
+
**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 README docs for the `useOffscreenRenderer` option that may assist in working around this limitation.
|
|
15
16
|
|
|
16
|
-
|
|
17
|
+
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.
|
|
18
|
+
|
|
19
|
+
[Getting Started](https://github.com/rive-app/rive-wasm#getting-started)
|