Browse Source

Renamed .deallocate() to .dispose() as discussed in #2760 and fdb737d078e0e3d6eba9856cec77401082a42fe8.

Mr.doob 12 years ago
parent
commit
0fd5a5ce24

+ 0 - 12
docs/api/renderers/WebGLRenderer.html

@@ -238,18 +238,6 @@
 		<h3>.addPrePlugin( plugin )</h3>
 		<h3>.addPrePlugin( plugin )</h3>
 		<div>Initialises the preprocessing plugin, and adds it to the renderPluginsPre array.</div>
 		<div>Initialises the preprocessing plugin, and adds it to the renderPluginsPre array.</div>
 
 
-		<h3>.deallocateObject( [page:Object3D object] )</h3>
-		<div>object — an instance of [page:Object3D]</div>
-		<div>Removes an object from the GL context and releases all the data (geometry, matrices...) that the GL context keeps about the object, but it doesn't release textures or affect any JavaScript data.</div>
-
-		<h3>.deallocateTexture( [page:??? texture] )</h3>
-		<div>texture — an instance of [page:???] TODO</div>
-		<div>Releases a texture from the GL context.</div>
-
-		<h3>.deallocateRenderTarget( [page:WebGLRenderTarget renderTarget] )</h3>
-		<div>renderTarget — an instance of [page:WebGLRenderTarget]</div>
-		<div>Releases a render target from the GL context.</div>
-
 		<h3>.updateShadowMap( [page:Scene scene], [page:Camera camera] )</h3>
 		<h3>.updateShadowMap( [page:Scene scene], [page:Camera camera] )</h3>
 		<div>scene — an instance of [page:Scene]<br />
 		<div>scene — an instance of [page:Scene]<br />
 		camera — an instance of [page:Camera]</div>
 		camera — an instance of [page:Camera]</div>

+ 3 - 3
examples/webgl_test_memory.html

@@ -85,10 +85,10 @@
 
 
 				scene.remove( mesh );
 				scene.remove( mesh );
 
 
-				// force deallocate
+				// clean up
 
 
-				geometry.deallocate();
-				texture.deallocate();
+				geometry.dispose();
+				texture.dispose();
 
 
 			}
 			}
 
 

+ 1 - 1
examples/webgl_test_memory2.html

@@ -131,7 +131,7 @@
 				for ( var i = 0; i < N; i ++ ) {
 				for ( var i = 0; i < N; i ++ ) {
 
 
 					var mesh = meshes[ i ];
 					var mesh = meshes[ i ];
-					mesh.material.deallocate();
+					mesh.material.dispose();
 
 
 				}
 				}
 
 

+ 2 - 2
src/core/BufferGeometry.js

@@ -544,9 +544,9 @@ THREE.BufferGeometry.prototype = {
 
 
 	},
 	},
 
 
-	deallocate: function () {
+	dispose: function () {
 
 
-		this.dispatchEvent( { type: 'deallocate' } );
+		this.dispatchEvent( { type: 'dispose' } );
 
 
 	}
 	}
 
 

+ 2 - 2
src/core/Geometry.js

@@ -736,9 +736,9 @@ THREE.Geometry.prototype = {
 
 
 	},
 	},
 
 
-	deallocate: function () {
+	dispose: function () {
 
 
-		this.dispatchEvent( { type: 'deallocate' } );
+		this.dispatchEvent( { type: 'dispose' } );
 
 
 	}
 	}
 
 

+ 2 - 2
src/materials/Material.js

@@ -116,9 +116,9 @@ THREE.Material.prototype.clone = function ( material ) {
 
 
 };
 };
 
 
-THREE.Material.prototype.deallocate = function () {
+THREE.Material.prototype.dispose = function () {
 
 
-	this.dispatchEvent( { type: 'deallocate' } );
+	this.dispatchEvent( { type: 'dispose' } );
 
 
 };
 };
 
 

+ 2 - 2
src/renderers/WebGLRenderTarget.js

@@ -64,8 +64,8 @@ THREE.WebGLRenderTarget.prototype.clone = function() {
 
 
 };
 };
 
 
-THREE.WebGLRenderTarget.prototype.deallocate = function () {
+THREE.WebGLRenderTarget.prototype.dispose = function () {
 
 
-	this.dispatchEvent( { type: 'deallocate' } );
+	this.dispatchEvent( { type: 'dispose' } );
 
 
 };
 };

+ 12 - 12
src/renderers/WebGLRenderer.js

@@ -462,11 +462,11 @@ THREE.WebGLRenderer = function ( parameters ) {
 
 
 	// Events
 	// Events
 
 
-	var onGeometryDeallocate = function ( event ) {
+	var onGeometryDispose = function ( event ) {
 
 
 		var geometry = event.target;
 		var geometry = event.target;
 
 
-		geometry.removeEventListener( 'deallocate', onGeometryDeallocate );
+		geometry.removeEventListener( 'dispose', onGeometryDispose );
 
 
 		deallocateGeometry( geometry );
 		deallocateGeometry( geometry );
 
 
@@ -474,11 +474,11 @@ THREE.WebGLRenderer = function ( parameters ) {
 
 
 	};
 	};
 
 
-	var onTextureDeallocate = function ( event ) {
+	var onTextureDispose = function ( event ) {
 
 
 		var texture = event.target;
 		var texture = event.target;
 
 
-		texture.removeEventListener( 'deallocate', onTextureDeallocate );
+		texture.removeEventListener( 'dispose', onTextureDispose );
 
 
 		deallocateTexture( texture );
 		deallocateTexture( texture );
 
 
@@ -487,11 +487,11 @@ THREE.WebGLRenderer = function ( parameters ) {
 
 
 	};
 	};
 
 
-	var onRenderTargetDeallocate = function ( event ) {
+	var onRenderTargetDispose = function ( event ) {
 
 
 		var renderTarget = event.target;
 		var renderTarget = event.target;
 
 
-		renderTarget.removeEventListener( 'deallocate', onRenderTargetDeallocate );
+		renderTarget.removeEventListener( 'dispose', onRenderTargetDispose );
 
 
 		deallocateRenderTarget( renderTarget );
 		deallocateRenderTarget( renderTarget );
 
 
@@ -499,11 +499,11 @@ THREE.WebGLRenderer = function ( parameters ) {
 
 
 	};
 	};
 
 
-	var onMaterialDeallocate = function ( event ) {
+	var onMaterialDispose = function ( event ) {
 
 
 		var material = event.target;
 		var material = event.target;
 
 
-		material.removeEventListener( 'deallocate', onMaterialDeallocate );
+		material.removeEventListener( 'dispose', onMaterialDispose );
 
 
 		deallocateMaterial( material );
 		deallocateMaterial( material );
 
 
@@ -4560,7 +4560,7 @@ THREE.WebGLRenderer = function ( parameters ) {
 			if ( object.geometry !== undefined && object.geometry.__webglInit === undefined ) {
 			if ( object.geometry !== undefined && object.geometry.__webglInit === undefined ) {
 
 
 				object.geometry.__webglInit = true;
 				object.geometry.__webglInit = true;
-				object.geometry.addEventListener( 'deallocate', onGeometryDeallocate );
+				object.geometry.addEventListener( 'dispose', onGeometryDispose );
 
 
 			}
 			}
 
 
@@ -4964,7 +4964,7 @@ THREE.WebGLRenderer = function ( parameters ) {
 
 
 	this.initMaterial = function ( material, lights, fog, object ) {
 	this.initMaterial = function ( material, lights, fog, object ) {
 
 
-		material.addEventListener( 'deallocate', onMaterialDeallocate );
+		material.addEventListener( 'dispose', onMaterialDispose );
 
 
 		var u, a, identifiers, i, parameters, maxLightCount, maxBones, maxShadows, shaderID;
 		var u, a, identifiers, i, parameters, maxLightCount, maxBones, maxShadows, shaderID;
 
 
@@ -6743,7 +6743,7 @@ THREE.WebGLRenderer = function ( parameters ) {
 
 
 				texture.__webglInit = true;
 				texture.__webglInit = true;
 
 
-				texture.addEventListener( 'deallocate', onTextureDeallocate );
+				texture.addEventListener( 'dispose', onTextureDispose );
 
 
 				texture.__webglTexture = _gl.createTexture();
 				texture.__webglTexture = _gl.createTexture();
 
 
@@ -7007,7 +7007,7 @@ THREE.WebGLRenderer = function ( parameters ) {
 			if ( renderTarget.depthBuffer === undefined ) renderTarget.depthBuffer = true;
 			if ( renderTarget.depthBuffer === undefined ) renderTarget.depthBuffer = true;
 			if ( renderTarget.stencilBuffer === undefined ) renderTarget.stencilBuffer = true;
 			if ( renderTarget.stencilBuffer === undefined ) renderTarget.stencilBuffer = true;
 
 
-			renderTarget.addEventListener( 'deallocate', onRenderTargetDeallocate );
+			renderTarget.addEventListener( 'dispose', onRenderTargetDispose );
 
 
 			renderTarget.__webglTexture = _gl.createTexture();
 			renderTarget.__webglTexture = _gl.createTexture();
 
 

+ 2 - 2
src/textures/Texture.js

@@ -77,9 +77,9 @@ THREE.Texture.prototype = {
 
 
 	},
 	},
 
 
-	deallocate: function () {
+	dispose: function () {
 
 
-		this.dispatchEvent( { type: 'deallocate' } );
+		this.dispatchEvent( { type: 'dispose' } );
 
 
 	}
 	}