Skip to content

Commit

Permalink
Docs: Mentioned the need for ImageBitmap.close(). (mrdoob#23959)
Browse files Browse the repository at this point in the history
  • Loading branch information
Mugen87 authored and abernier committed Sep 16, 2022
1 parent 924d841 commit 4b648e2
Show file tree
Hide file tree
Showing 7 changed files with 37 additions and 2 deletions.
5 changes: 5 additions & 0 deletions docs/examples/en/loaders/GLTFLoader.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ <h1>[name]</h1>
textures, skins, skeletons, morph targets, animations, lights, and/or cameras.
</p>

<p>
[name] uses [page:ImageBitmapLoader] whenever possible. Be advised that image bitmaps are not automatically GC-collected when they are no longer referenced,
and they require special handling during the disposal process. More information in the [link:https://threejs.org/docs/#manual/en/introduction/How-to-dispose-of-objects How to dispose of objects] guide.
</p>

<h2>Extensions</h2>

<p>
Expand Down
5 changes: 5 additions & 0 deletions docs/examples/zh/loaders/GLTFLoader.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ <h1>GLTF加载器([name])</h1>
包括网格、材质、贴图、蒙皮、骨架、变形目标、动画、灯光以及摄像机。
</p>

<p>
[name] uses [page:ImageBitmapLoader] whenever possible. Be advised that image bitmaps are not automatically GC-collected when they are no longer referenced,
and they require special handling during the disposal process. More information in the [link:https://threejs.org/docs/#manual/en/introduction/How-to-dispose-of-objects How to dispose of objects] guide.
</p>

<h2>扩展</h2>

<p>
Expand Down
5 changes: 5 additions & 0 deletions docs/manual/ar/introduction/How-to-dispose-of-objects.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ <h2>الأنسجة (Textures)</h2>
على غرار المخازن المؤقتة ، لا يمكن حذف هذا الكائن إلا عن طريق استدعاء [page:Texture.dispose]().
</p>

<p>
If you use an *ImageBitmap* as the texture's data source, you have to call [link:https://developer.mozilla.org/en-US/docs/Web/API/ImageBitmap/close ImageBitmap.close]() at the application level to dispose of all CPU-side resources.
An automated call of *ImageBitmap.close()* in [page:Texture.dispose]() is not possible, since the image bitmap becomes unusable, and the engine has no way of knowing if the image bitmap is used elsewhere.
</p>

<h2>أهداف العرض</h2>

<p>
Expand Down
5 changes: 5 additions & 0 deletions docs/manual/en/introduction/How-to-dispose-of-objects.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@ <h2>Textures</h2>
Similar to buffers, this object can only be deleted by calling [page:Texture.dispose]().
</p>

<p>
If you use an *ImageBitmap* as the texture's data source, you have to call [link:https://developer.mozilla.org/en-US/docs/Web/API/ImageBitmap/close ImageBitmap.close]() at the application level to dispose of all CPU-side resources.
An automated call of *ImageBitmap.close()* in [page:Texture.dispose]() is not possible, since the image bitmap becomes unusable, and the engine has no way of knowing if the image bitmap is used elsewhere.
</p>

<h2>Render Targets</h2>

<p>
Expand Down
7 changes: 6 additions & 1 deletion docs/manual/ja/introduction/How-to-dispose-of-objects.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,11 @@ <h2>Textures</h2>
バッファと同様に、このオブジェクトは[page:Texture.dispose]()を呼ぶことでしか削除できません。
</p>

<p>
If you use an *ImageBitmap* as the texture's data source, you have to call [link:https://developer.mozilla.org/en-US/docs/Web/API/ImageBitmap/close ImageBitmap.close]() at the application level to dispose of all CPU-side resources.
An automated call of *ImageBitmap.close()* in [page:Texture.dispose]() is not possible, since the image bitmap becomes unusable, and the engine has no way of knowing if the image bitmap is used elsewhere.
</p>

<h2>Render Targets</h2>

<p>
Expand Down Expand Up @@ -127,4 +132,4 @@ <h2>Examples that demonstrate the usage of dispose()</h2>

</body>

</html>
</html>
7 changes: 6 additions & 1 deletion docs/manual/ko/introduction/How-to-dispose-of-objects.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@ <h2>텍스쳐</h2>
buffer와 비슷하게, 이 오브젝트는 [page:Texture.dispose]() 호출로만 삭제가 가능합니다.
</p>

<p>
If you use an *ImageBitmap* as the texture's data source, you have to call [link:https://developer.mozilla.org/en-US/docs/Web/API/ImageBitmap/close ImageBitmap.close]() at the application level to dispose of all CPU-side resources.
An automated call of *ImageBitmap.close()* in [page:Texture.dispose]() is not possible, since the image bitmap becomes unusable, and the engine has no way of knowing if the image bitmap is used elsewhere.
</p>

<h2>렌더링 대상</h2>

<p>
Expand Down Expand Up @@ -112,4 +117,4 @@ <h2>dispose() 사용법 예제</h2>

</body>

</html>
</html>
5 changes: 5 additions & 0 deletions docs/manual/zh/introduction/How-to-dispose-of-objects.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@ <h2>纹理</h2>
和buffer相似,该对象只能通过调用[page:Texture.dispose]()来删除。
</p>

<p>
If you use an *ImageBitmap* as the texture's data source, you have to call [link:https://developer.mozilla.org/en-US/docs/Web/API/ImageBitmap/close ImageBitmap.close]() at the application level to dispose of all CPU-side resources.
An automated call of *ImageBitmap.close()* in [page:Texture.dispose]() is not possible, since the image bitmap becomes unusable, and the engine has no way of knowing if the image bitmap is used elsewhere.
</p>

<h2>渲染目标</h2>

<p>
Expand Down

0 comments on commit 4b648e2

Please sign in to comment.