Skip to content

Commit a66c94c

Browse files
authored
Update documentation for ImageBitmapLoader options (mrdoob#32574)
1 parent 7823b2f commit a66c94c

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

src/loaders/ImageBitmapLoader.js

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,16 @@ const _errorMap = new WeakMap();
1010
* textures for rendering.
1111
*
1212
* Note that {@link Texture#flipY} and {@link Texture#premultiplyAlpha} are ignored with image bitmaps.
13-
* They needs these configuration on bitmap creation unlike regular images need them on uploading to GPU.
13+
* These options need to be configured via {@link ImageBitmapLoader#setOptions} prior to loading,
14+
* unlike regular images which can be configured on the Texture to set these options on GPU upload instead.
1415
*
15-
* You need to set the equivalent options via {@link ImageBitmapLoader#setOptions} instead.
16+
* To match the default behaviour of {@link Texture}, the following options are needed:
1617
*
17-
* Also note that unlike {@link FileLoader}, this loader avoids multiple concurrent requests to the same URL only if `Cache` is enabled.
18+
* ```js
19+
* { imageOrientation: 'flipY', premultiplyAlpha: 'none' }
20+
* ```
21+
*
22+
* Also note that unlike {@link FileLoader}, this loader will only avoid multiple concurrent requests to the same URL if {@link Cache} is enabled.
1823
*
1924
* ```js
2025
* const loader = new THREE.ImageBitmapLoader();

0 commit comments

Comments
 (0)