Home Explore Help
Sign In
javascript
/
three.js
mirror of https://github.com/tazdij/three.js.git
2
0
Fork 0
Files Issues 0 Wiki
Browse Source

Clarify dispose() method (#24667)

WestLangley 2 years ago
parent
561c61ce09
commit
aa8a3f557c
3 changed files with 15 additions and 9 deletions
Unified View Show Diff Stats
  1. 3 1
      docs/examples/en/helpers/LightProbeHelper.html
  2. 7 5
      docs/examples/en/helpers/PositionalAudioHelper.html
  3. 5 3
      docs/examples/en/helpers/RectAreaLightHelper.html

+ 3 - 1
docs/examples/en/helpers/LightProbeHelper.html
View File 

@@ -48,7 +48,9 @@
 
 		<p>See the base [page:Mesh] class for common methods.</p>
 
 		<p>See the base [page:Mesh] class for common methods.</p>
 
 
 
 		<h3>[method:undefined dispose]()</h3>
 
 		<h3>[method:undefined dispose]()</h3>
 
-		<p>Frees internal resources.</p>
 
+		<p>
 
+		Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.
 
+		</p>
 
 
 
 
 
 		<h2>Source</h2>
 
 		<h2>Source</h2>

+ 7 - 5
docs/examples/en/helpers/PositionalAudioHelper.html
View File 

@@ -7,7 +7,7 @@
 
 		<link type="text/css" rel="stylesheet" href="page.css" />
 
 		<link type="text/css" rel="stylesheet" href="page.css" />
 
 	</head>
 
 	</head>
 
 	<body>
 
 	<body>
 
-		[page:Object3D] &rarr;
 
+		[page:Object3D] &rarr; [page:Line] &rarr;
 
 
 
 		<h1>[name]</h1>
 
 		<h1>[name]</h1>
 
 
 
@@ -56,14 +56,16 @@
 
 		<p>The amount of divisions of the outer part of the directional cone.</p>
 
 		<p>The amount of divisions of the outer part of the directional cone.</p>
 
 
 
 		<h2>Methods</h2>
 
 		<h2>Methods</h2>
 
-		<p>See the base [page:Object3D] class for common methods.</p>
 
-
 
-		<h3>[method:undefined dispose]()</h3>
 
-		<p>Disposes of the helper.</p>
 
+		<p>See the base [page:Line] class for common methods.</p>
 
 
 
 		<h3>[method:undefined update]()</h3>
 
 		<h3>[method:undefined update]()</h3>
 
 		<p>Updates the helper.</p>
 
 		<p>Updates the helper.</p>
 
 
 
+		<h3>[method:undefined dispose]()</h3>
 
+		<p>
 
+		Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.
 
+		</p>
 
+
 
 		<h2>Source</h2>
 
 		<h2>Source</h2>
 
 
 
 		<p>
 
 		<p>

+ 5 - 3
docs/examples/en/helpers/RectAreaLightHelper.html
View File 

@@ -7,7 +7,7 @@
 
 		<link type="text/css" rel="stylesheet" href="page.css" />
 
 		<link type="text/css" rel="stylesheet" href="page.css" />
 
 	</head>
 
 	</head>
 
 	<body>
 
 	<body>
 
-		[page:Object3D] &rarr;
 
+		[page:Object3D] &rarr; [page:Line] &rarr;
 
 
 
 		<h1>[name]</h1>
 
 		<h1>[name]</h1>
 
 
 
@@ -48,10 +48,12 @@
 
 
 
 
 
 		<h2>Methods</h2>
 
 		<h2>Methods</h2>
 
-		<p>See the base [page:Object3D] class for common methods.</p>
 
+		<p>See the base [page:Line] class for common methods.</p>
 
 
 
 		<h3>[method:undefined dispose]()</h3>
 
 		<h3>[method:undefined dispose]()</h3>
 
-		<p>Dispose of the rectAreaLightHelper.</p>
 
+		<p>
 
+		Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.
 
+		</p>
 
 
 
 		<h2>Source</h2>
 
 		<h2>Source</h2>