Skip to content

Commit 26042bf

Browse files
committed
update v1 doc
1 parent cd8f7ef commit 26042bf

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

docs/pages/news/v1.0.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,21 @@ Stage.js v1.0 is rewritten in TypeScript, and ESM exports. In v1.0, all classes
1818

1919
#### Texture atlas
2020

21-
New promises (async/await) are used for preloading images, and preloading textures is separated from creating and mounting an app. You need to use `await` to wait for the preloading to finish, instead of passing a callback function.
21+
New promises (async/await) are used for preloading images, and preloading textures is separated from creating and mounting an app. You need to use `await` to wait for texture preloading to finish, instead of passing a callback function.
2222

2323
- Use `await Stage.atlas({ })` to preload images and create textures before using them, instead of `Stage({ })`.
2424

25+
You can alternatively use `Stage.atlas()` without await, and then call `await Stage.preload()` to await preloading all textures.
26+
2527
#### Relative Paths
2628

27-
Relative image paths for textures are not resolved relative to absolute path anymore. You need to use absolute paths, or resolve them yourself using a build tool.
29+
Relative image paths for textures are not resolved relative to absolute path anymore. You need to use absolute paths, or use a build tool to resolve relative paths at build time.
2830

2931
#### ESM and build files
3032

31-
In v1.0 there are two build files formats: ESM which is the default, and minified UMD for directly using in webpages. Build files are not CommonJS.
33+
In v1.0 there are two build files formats: ESM which is the default, and UMD for directly using in webpages. The package type is changed to "module", so you need to use ESM imports in Node.js or build tools.
3234

33-
FastContext and Cordova custom build is dropped in v1. In previous versions FastContext was used to take advantage of native GPU rendering in Android devices when browser Canvas rendering was not GPU optimized, however this is not needed anymore.
35+
FastContext/Cordova custom build is dropped in v1. In previous versions FastContext was used to take advantage of native GPU rendering in Android devices when browser Canvas rendering was not GPU optimized, however this is not needed anymore.
3436

3537
#### API Changes
3638

0 commit comments

Comments
 (0)