fix: #523 cleanup texture memory

Author: robertleeplummerjr

src/backend/web-gl/kernel.js

@@ -163,7 +163,7 @@ class WebGLKernel extends GLKernel {
     this.threadDim = null;
     this.framebuffer = null;
     this.buffer = null;
-    this.textureCache = {};
+    this.textureCache = [];
     this.programUniformLocationCache = {};
     this.uniform1fCache = {};
     this.uniform1iCache = {};
@@ -428,7 +428,7 @@ class WebGLKernel extends GLKernel {
         kernel: this,
         strictIntegers: this.strictIntegers,
         onRequestTexture: () => {
-          return this.context.createTexture();
+          return this.createTexture();
         },
         onRequestIndex: () => {
           return textureIndexes++;
@@ -446,6 +446,12 @@ class WebGLKernel extends GLKernel {
     }
   }
 
+  createTexture() {
+    const texture = this.context.createTexture();
+    this.textureCache.push(texture);
+    return texture;
+  }
+
   setupConstants(args) {
     const { context: gl } = this;
     this.kernelConstants = [];
@@ -479,7 +485,7 @@ class WebGLKernel extends GLKernel {
         kernel: this,
         strictIntegers: this.strictIntegers,
         onRequestTexture: () => {
-          return this.context.createTexture();
+          return this.createTexture();
         },
         onRequestIndex: () => {
           return textureIndexes++;
@@ -711,7 +717,7 @@ class WebGLKernel extends GLKernel {
   _setupOutputTexture() {
     const gl = this.context;
     const texSize = this.texSize;
-    const texture = this.outputTexture = this.context.createTexture();
+    const texture = this.outputTexture = this.createTexture();
     gl.activeTexture(gl.TEXTURE0 + this.constantTextureCount + this.argumentTextureCount);
     gl.bindTexture(gl.TEXTURE_2D, texture);
     gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_WRAP_S, gl.CLAMP_TO_EDGE);
@@ -768,7 +774,7 @@ class WebGLKernel extends GLKernel {
     this.drawBuffersMap = [gl.COLOR_ATTACHMENT0];
     this.subKernelOutputTextures = [];
     for (let i = 0; i < this.subKernels.length; i++) {
-      const texture = this.context.createTexture();
+      const texture = this.createTexture();
       this.subKernelOutputTextures.push(texture);
       this.drawBuffersMap.push(gl.COLOR_ATTACHMENT0 + i + 1);
       gl.activeTexture(gl.TEXTURE0 + this.constantTextureCount + this.argumentTextureCount + i);
@@ -1465,9 +1471,6 @@ class WebGLKernel extends GLKernel {
   }
 
   destroy(removeCanvasReferences) {
-    if (this.outputTexture) {
-      this.context.deleteTexture(this.outputTexture);
-    }
     if (this.buffer) {
       this.context.deleteBuffer(this.buffer);
     }
@@ -1483,18 +1486,9 @@ class WebGLKernel extends GLKernel {
     if (this.program) {
       this.context.deleteProgram(this.program);
     }
-
-    const keys = Object.keys(this.textureCache);
-
-    for (let i = 0; i < keys.length; i++) {
-      const name = keys[i];
-      this.context.deleteTexture(this.textureCache[name]);
-    }
-
-    if (this.subKernelOutputTextures) {
-      for (let i = 0; i < this.subKernelOutputTextures.length; i++) {
-        this.context.deleteTexture(this.subKernelOutputTextures[i]);
-      }
+    while (this.textureCache.length > 0) {
+      const texture = this.textureCache.pop();
+      this.context.deleteTexture(texture);
     }
     if (removeCanvasReferences) {
       const idx = canvases.indexOf(this.canvas);
@@ -1535,4 +1529,4 @@ class WebGLKernel extends GLKernel {
 
 module.exports = {
   WebGLKernel
-};
+};

src/backend/web-gl2/kernel.js

@@ -274,7 +274,7 @@ class WebGL2Kernel extends WebGLKernel {
     this.drawBuffersMap = [gl.COLOR_ATTACHMENT0];
     this.subKernelOutputTextures = [];
     for (let i = 0; i < this.subKernels.length; i++) {
-      const texture = this.context.createTexture();
+      const texture = this.createTexture();
       this.subKernelOutputTextures.push(texture);
       this.drawBuffersMap.push(gl.COLOR_ATTACHMENT0 + i + 1);
       gl.activeTexture(gl.TEXTURE0 + this.constantTextureCount + this.argumentTextureCount + i);

test/features/destroy.js

@@ -1,5 +1,5 @@
 const { assert, skip, test, module: describe } = require('qunit');
-const { GPU } = require('../../src');
+const { GPU, WebGLKernel } = require('../../src');
 const sinon = require('sinon');
 
 describe('features: destroy');
@@ -55,3 +55,31 @@ test('with destroy context', (t) => {
   const done = t.async();
   testWithDestroyContext(done);
 });
+
+
+function testTexturesAreDestroyed(done, mode) {
+  const mockTexture1 = {};
+  const mockTexture2 = {};
+  const mockTexture3 = {};
+  const deleteTextureMock = sinon.spy();
+  const mockContext = {
+    deleteTexture: deleteTextureMock,
+  };
+  const mockKernelInstance = {
+    textureCache: [mockTexture1, mockTexture2, mockTexture3],
+    context: mockContext,
+    destroyExtensions: () => {},
+  };
+  mockKernelInstance.destroy = WebGLKernel.prototype.destroy.bind(mockKernelInstance);
+  GPU.prototype.destroy.call({ kernels: [mockKernelInstance] });
+  setTimeout(() => {
+    assert.equal(deleteTextureMock.callCount, 3);
+    assert.ok(true);
+    done();
+  }, 2);
+}
+
+test('textures are destroyed', (t) => {
+  const done = t.async();
+  testTexturesAreDestroyed(done);
+});