Skip to content

Docs: Improve dispose guide. #30524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Mugen87 merged 2 commits into from
Feb 17, 2025
Merged

Docs: Improve dispose guide. #30524

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9c72ff
30516 added FAQ mentioning the existance of internal geometries/textu…
catalin-enache Feb 17, 2025
f2303cd
Update How-to-dispose-of-objects.html
Mugen87 Feb 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion docs/manual/en/introduction/How-to-dispose-of-objects.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ <h3>What happens when you call `dispose()` on a texture but the image is not loa
<h3>What happens when I call `dispose()` and then use the respective object at a later point?</h3>

<p>
That depends. For geometries, materials, textures, render targets and post processing passes the deleted internal resources can be created again by the engine.
That depends. For geometries, materials, textures, render targets and post processing passes the deleted internal resources can be created again by the engine.
So no runtime error will occur but you might notice a negative performance impact for the current frame, especially when shader programs have to be compiled.

Controls and renderers are an exception. Instances of these classes can not be used after `dispose()` has been called. You have to create new instances in this case.
Expand All @@ -121,6 +121,18 @@ <h3>How should I manage *three.js* objects in my app? When do I know how to disp
produce a runtime error if you dispose an object that is actually still in use. The worst thing that can happen is performance drop for a single frame.
</p>

<h3>Why `renderer.info.memory` is still reporting geometries and textures after traversing the scene and disposing all reachable textures and geometries?</h3>

<p>
In certain cases, there are some textures and geometries used internally by Three.js
that are not reachable when traversing the scene graph in order to be disposed.
It is expected that `renderer.info.memory` will still report them even after a full scene cleanup.
However, they do not leak, but they are reused on consecutive scene cleanup/repopulating cycles.

These cases could be related to using `material.envMap`, `scene.background`, `scene.environment`,
or other contexts that would require the engine to create textures or geometries for internal use.
</p>

<h2>Examples that demonstrate the usage of dispose()</h2>

<p>
Expand Down