@luma.gl/core 9.0.0-beta.3 → 9.0.0-beta.5

package/dist/adapter/resources/framebuffer.js

@@ -1,102 +1,163 @@
-let _Symbol$toStringTag;
-import { Resource } from "./resource.js";
-import { Texture } from "./texture.js";
-import { log } from "../../utils/log.js";
-_Symbol$toStringTag = Symbol.toStringTag;
+// luma.gl, MIT license
+// Copyright (c) vis.gl contributors
+import { Resource } from './resource';
+import { Texture } from './texture';
+import { log } from '../../utils/log';
+/**
+ * Create new textures with correct size for all attachments.
+ * @note resize() destroys existing textures (if size has changed).
+ */
 export class Framebuffer extends Resource {
-  get [_Symbol$toStringTag]() {
-    return 'Framebuffer';
-  }
-  constructor(device) {
-    let props = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-    super(device, props, Framebuffer.defaultProps);
-    this.width = void 0;
-    this.height = void 0;
-    this.colorAttachments = [];
-    this.depthStencilAttachment = null;
-    this.width = this.props.width;
-    this.height = this.props.height;
-  }
-  resize(size) {
-    let updateSize = !size;
-    if (size) {
-      const [width, height] = Array.isArray(size) ? size : [size.width, size.height];
-      updateSize = updateSize || height !== this.height || width !== this.width;
-      this.width = width;
-      this.height = height;
+    static defaultProps = {
+        ...Resource.defaultProps,
+        width: 1,
+        height: 1,
+        colorAttachments: [], // ['rgba8unorm-unsized'],
+        depthStencilAttachment: null // 'depth24plus-stencil8'
+    };
+    get [Symbol.toStringTag]() {
+        return 'Framebuffer';
     }
-    if (updateSize) {
-      log.log(2, `Resizing framebuffer ${this.id} to ${this.width}x${this.height}`)();
-      this.resizeAttachments(this.width, this.height);
+    /** Width of all attachments in this framebuffer */
+    width;
+    /** Height of all attachments in this framebuffer */
+    height;
+    /** Color attachments */
+    colorAttachments = [];
+    /** Depth-stencil attachment, if provided */
+    depthStencilAttachment = null;
+    constructor(device, props = {}) {
+        super(device, props, Framebuffer.defaultProps);
+        this.width = this.props.width;
+        this.height = this.props.height;
+        // NOTE: call from subclass constructor as we cannot call overridden methods here (subclass not yet constructed)
+        // this.autoCreateAttachmentTextures();
     }
-  }
-  autoCreateAttachmentTextures() {
-    this.colorAttachments = this.props.colorAttachments.map(attachment => {
-      if (typeof attachment === 'string') {
-        const texture = this.createColorTexture(attachment);
-        this.attachResource(texture);
-        return texture;
-      }
-      return attachment;
-    });
-    if (this.props.depthStencilAttachment) {
-      if (typeof this.props.depthStencilAttachment === 'string') {
-        const texture = this.createDepthStencilTexture(this.props.depthStencilAttachment);
-        this.attachResource(texture);
-        this.depthStencilAttachment = texture;
-      } else {
-        this.depthStencilAttachment = this.props.depthStencilAttachment;
-      }
+    resize(size) {
+        let updateSize = !size;
+        if (size) {
+            const [width, height] = Array.isArray(size) ? size : [size.width, size.height];
+            updateSize = updateSize || height !== this.height || width !== this.width;
+            this.width = width;
+            this.height = height;
+        }
+        if (updateSize) {
+            log.log(2, `Resizing framebuffer ${this.id} to ${this.width}x${this.height}`)();
+            this.resizeAttachments(this.width, this.height);
+        }
     }
-  }
-  createColorTexture(format) {
-    return this.device.createTexture({
-      id: 'color-attachment',
-      usage: Texture.RENDER_ATTACHMENT,
-      format,
-      width: this.width,
-      height: this.height
-    });
-  }
-  createDepthStencilTexture(format) {
-    return this.device.createTexture({
-      id: 'depth-stencil-attachment',
-      usage: Texture.RENDER_ATTACHMENT,
-      format,
-      width: this.width,
-      height: this.height
-    });
-  }
-  resizeAttachments(width, height) {
-    for (let i = 0; i < this.colorAttachments.length; ++i) {
-      if (this.colorAttachments[i]) {
-        const resizedTexture = this.device._createTexture({
-          ...this.colorAttachments[i].props,
-          width,
-          height
+    // /** Returns fully populated attachment object. */
+    // protected normalizeColorAttachment(
+    //   attachment: Texture | ColorTextureFormat
+    // ): Required<ColorAttachment> {
+    //   const COLOR_ATTACHMENT_DEFAULTS: Required<ColorAttachment> = {
+    //     texture: undefined!,
+    //     format: undefined!,
+    //     clearValue: [0.0, 0.0, 0.0, 0.0],
+    //     loadOp: 'clear',
+    //     storeOp: 'store'
+    //   };
+    //   if (attachment instanceof Texture) {
+    //     return {...COLOR_ATTACHMENT_DEFAULTS, texture: attachment};
+    //   }
+    //   if (typeof attachment === 'string') {
+    //     return {...COLOR_ATTACHMENT_DEFAULTS, format: attachment};
+    //   }
+    //   return {...COLOR_ATTACHMENT_DEFAULTS, ...attachment};
+    // }
+    // /** Wraps texture inside fully populated attachment object. */
+    // protected normalizeDepthStencilAttachment(
+    //   attachment: DepthStencilAttachment | Texture | DepthStencilTextureFormat
+    // ): Required<DepthStencilAttachment> {
+    //   const DEPTH_STENCIL_ATTACHMENT_DEFAULTS: Required<DepthStencilAttachment> = {
+    //     texture: undefined!,
+    //     format: undefined!,
+    //     depthClearValue: 1.0,
+    //     depthLoadOp: 'clear',
+    //     depthStoreOp: 'store',
+    //     depthReadOnly: false,
+    //     stencilClearValue: 0,
+    //     stencilLoadOp: 'clear',
+    //     stencilStoreOp: 'store',
+    //     stencilReadOnly: false
+    //   };
+    //   if (typeof attachment === 'string') {
+    //     return {...DEPTH_STENCIL_ATTACHMENT_DEFAULTS, format: attachment};
+    //   }
+    //   // @ts-expect-error attachment instanceof Texture doesn't cover Renderbuffer
+    //   if (attachment.handle || attachment instanceof Texture) {
+    //     return {...DEPTH_STENCIL_ATTACHMENT_DEFAULTS, texture: attachment as Texture};
+    //   }
+    //   return {...DEPTH_STENCIL_ATTACHMENT_DEFAULTS, ...attachment};
+    // }
+    /** Auto creates any textures */
+    autoCreateAttachmentTextures() {
+        this.colorAttachments = this.props.colorAttachments.map(attachment => {
+            if (typeof attachment === 'string') {
+                const texture = this.createColorTexture(attachment);
+                this.attachResource(texture);
+                return texture;
+            }
+            return attachment;
         });
-        this.destroyAttachedResource(this.colorAttachments[i]);
-        this.colorAttachments[i] = resizedTexture;
-        this.attachResource(resizedTexture);
-      }
+        if (this.props.depthStencilAttachment) {
+            if (typeof this.props.depthStencilAttachment === 'string') {
+                const texture = this.createDepthStencilTexture(this.props.depthStencilAttachment);
+                this.attachResource(texture);
+                this.depthStencilAttachment = texture;
+            }
+            else {
+                this.depthStencilAttachment = this.props.depthStencilAttachment;
+            }
+        }
     }
-    if (this.depthStencilAttachment) {
-      const resizedTexture = this.device._createTexture({
-        ...this.depthStencilAttachment.props,
-        width,
-        height
-      });
-      this.destroyAttachedResource(this.depthStencilAttachment);
-      this.depthStencilAttachment = resizedTexture;
-      this.attachResource(resizedTexture);
+    /** Create a color texture */
+    createColorTexture(format) {
+        return this.device.createTexture({
+            id: 'color-attachment',
+            usage: Texture.RENDER_ATTACHMENT,
+            format,
+            width: this.width,
+            height: this.height,
+        });
+    }
+    /** Create depth stencil texture */
+    createDepthStencilTexture(format) {
+        return this.device.createTexture({
+            id: 'depth-stencil-attachment',
+            usage: Texture.RENDER_ATTACHMENT,
+            format,
+            width: this.width,
+            height: this.height
+        });
+    }
+    /**
+     * Default implementation of resize
+     * Creates new textures with correct size for all attachments.
+     * and destroys existing textures if owned
+     */
+    resizeAttachments(width, height) {
+        for (let i = 0; i < this.colorAttachments.length; ++i) {
+            if (this.colorAttachments[i]) {
+                const resizedTexture = this.device._createTexture({
+                    ...this.colorAttachments[i].props,
+                    width,
+                    height
+                });
+                this.destroyAttachedResource(this.colorAttachments[i]);
+                this.colorAttachments[i] = resizedTexture;
+                this.attachResource(resizedTexture);
+            }
+        }
+        if (this.depthStencilAttachment) {
+            const resizedTexture = this.device._createTexture({
+                ...this.depthStencilAttachment.props,
+                width,
+                height
+            });
+            this.destroyAttachedResource(this.depthStencilAttachment);
+            this.depthStencilAttachment = resizedTexture;
+            this.attachResource(resizedTexture);
+        }
     }
-  }
 }
-Framebuffer.defaultProps = {
-  ...Resource.defaultProps,
-  width: 1,
-  height: 1,
-  colorAttachments: [],
-  depthStencilAttachment: null
-};
-//# sourceMappingURL=framebuffer.js.map

package/dist/adapter/resources/render-pass.js

@@ -1,23 +1,30 @@
-let _Symbol$toStringTag;
-import { Resource } from "./resource.js";
-_Symbol$toStringTag = Symbol.toStringTag;
+// import {Binding} from '../types/shader-layout';
+import { Resource } from './resource';
+/**
+ * A RenderPass instance is a required parameter to all draw calls.
+ *
+ * It holds a combination of
+ * - render targets (specified via a framebuffer)
+ * - clear colors, read/write, discard information for the framebuffer attachments
+ * - a couple of mutable parameters ()
+ */
 export class RenderPass extends Resource {
-  get [_Symbol$toStringTag]() {
-    return 'RenderPass';
-  }
-  constructor(device, props) {
-    super(device, props, RenderPass.defaultProps);
-  }
+    /** Default properties for RenderPass */
+    static defaultProps = {
+        ...Resource.defaultProps,
+        framebuffer: null,
+        parameters: undefined,
+        clearColor: [0, 0, 0, 0],
+        clearDepth: 1,
+        clearStencil: 0,
+        depthReadOnly: false,
+        stencilReadOnly: false,
+        discard: false
+    };
+    get [Symbol.toStringTag]() {
+        return 'RenderPass';
+    }
+    constructor(device, props) {
+        super(device, props, RenderPass.defaultProps);
+    }
 }
-RenderPass.defaultProps = {
-  ...Resource.defaultProps,
-  framebuffer: null,
-  parameters: undefined,
-  clearColor: [0, 0, 0, 0],
-  clearDepth: 1,
-  clearStencil: 0,
-  depthReadOnly: false,
-  stencilReadOnly: false,
-  discard: false
-};
-//# sourceMappingURL=render-pass.js.map

package/dist/adapter/resources/render-pipeline.d.ts

@@ -54,6 +54,8 @@ export declare abstract class RenderPipeline extends Resource<RenderPipelineProp
     shaderLayout: ShaderLayout;
     /** Buffer map describing buffer interleaving etc */
     readonly bufferLayout: BufferLayout[];
+    /** The linking status of the pipeline. 'pending' if linking is asynchronous, and on production */
+    linkStatus: 'pending' | 'success' | 'error';
     constructor(device: Device, props: RenderPipelineProps);
     /** Set bindings (stored on pipeline and set before each call) */
     abstract setBindings(bindings: Record<string, Binding>): void;
@@ -82,7 +84,7 @@ export declare abstract class RenderPipeline extends Resource<RenderPipelineProp
         /** First instance to draw from */
         firstInstance?: number;
         baseVertex?: number;
-        /** Transform feedback. WebGL 2 only. */
+        /** Transform feedback. WebGL only. */
         transformFeedback?: TransformFeedback;
     }): void;
 }

package/dist/adapter/resources/render-pipeline.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"render-pipeline.d.ts","sourceRoot":"","sources":["../../../src/adapter/resources/render-pipeline.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,WAAW,CAAC;AACtC,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,EAAC,iBAAiB,EAAE,wBAAwB,EAAC,MAAM,qBAAqB,CAAC;AACrF,OAAO,KAAK,EAAC,YAAY,EAAE,OAAO,EAAC,MAAM,wBAAwB,CAAC;AAClE,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,wBAAwB,CAAC;AAEzD,OAAO,EAAC,QAAQ,EAAE,aAAa,EAAC,MAAM,YAAY,CAAC;AACnD,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,UAAU,CAAC;AACrC,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAC,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAEvD,MAAM,MAAM,mBAAmB,GAAG,aAAa,GAAG;IAGhD,6BAA6B;IAC7B,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,gEAAgE;IAChE,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,+DAA+D;IAC/D,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,+BAA+B;IAC/B,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,kEAAkE;IAClE,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iEAAiE;IACjE,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAErC,+EAA+E;IAC/E,YAAY,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;IACnC;;;OAGG;IACH,YAAY,CAAC,EAAE,YAAY,EAAE,CAAC;IAE9B,oEAAoE;IACpE,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAC7B,iDAAiD;IACjD,UAAU,CAAC,EAAE,wBAAwB,CAAC;IAKtC,yBAAyB;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0BAA0B;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;CACzC,CAAC;AAEF;;GAEG;AACH,8BAAsB,cAAe,SAAQ,QAAQ,CAAC,mBAAmB,CAAC;IACxE,OAAgB,YAAY,EAAE,QAAQ,CAAC,mBAAmB,CAAC,CAqBzD;IAEF,IAAa,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAE1C;IAED,IAAI,EAAE,MAAM,CAAM;IAClB,QAAQ,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,wBAAwB;IACxB,YAAY,EAAE,YAAY,CAAC;IAC3B,oDAAoD;IACpD,QAAQ,CAAC,YAAY,EAAE,YAAY,EAAE,CAAC;gBAE1B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,mBAAmB;IAMtD,iEAAiE;IACjE,QAAQ,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAC7D;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,IAAI;IAElE,gBAAgB;IAChB,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE;QACrB,iEAAiE;QACjE,UAAU,CAAC,EAAE,UAAU,CAAC;QACxB,wBAAwB;QACxB,WAAW,EAAE,WAAW,CAAC;QACzB,uCAAuC;QACvC,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,2CAA2C;QAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,6CAA6C;QAC7C,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,gCAAgC;QAChC,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,+BAA+B;QAC/B,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,kCAAkC;QAClC,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,wCAAwC;QACxC,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;KACvC,GAAG,IAAI;CACT"}
+{"version":3,"file":"render-pipeline.d.ts","sourceRoot":"","sources":["../../../src/adapter/resources/render-pipeline.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,WAAW,CAAC;AACtC,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,EAAC,iBAAiB,EAAE,wBAAwB,EAAC,MAAM,qBAAqB,CAAC;AACrF,OAAO,KAAK,EAAC,YAAY,EAAE,OAAO,EAAC,MAAM,wBAAwB,CAAC;AAClE,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,wBAAwB,CAAC;AAEzD,OAAO,EAAC,QAAQ,EAAE,aAAa,EAAC,MAAM,YAAY,CAAC;AACnD,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,UAAU,CAAC;AACrC,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAC,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAEvD,MAAM,MAAM,mBAAmB,GAAG,aAAa,GAAG;IAGhD,6BAA6B;IAC7B,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,gEAAgE;IAChE,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,+DAA+D;IAC/D,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,+BAA+B;IAC/B,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,kEAAkE;IAClE,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iEAAiE;IACjE,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAErC,+EAA+E;IAC/E,YAAY,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;IACnC;;;OAGG;IACH,YAAY,CAAC,EAAE,YAAY,EAAE,CAAC;IAE9B,oEAAoE;IACpE,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAC7B,iDAAiD;IACjD,UAAU,CAAC,EAAE,wBAAwB,CAAC;IAKtC,yBAAyB;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0BAA0B;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;CACzC,CAAC;AAEF;;GAEG;AACH,8BAAsB,cAAe,SAAQ,QAAQ,CAAC,mBAAmB,CAAC;IACxE,OAAgB,YAAY,EAAE,QAAQ,CAAC,mBAAmB,CAAC,CAqBzD;IAEF,IAAa,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAE1C;IAED,IAAI,EAAE,MAAM,CAAM;IAClB,QAAQ,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,wBAAwB;IACxB,YAAY,EAAE,YAAY,CAAC;IAC3B,oDAAoD;IACpD,QAAQ,CAAC,YAAY,EAAE,YAAY,EAAE,CAAC;IACtC,kGAAkG;IAClG,UAAU,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,CAAa;gBAE5C,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,mBAAmB;IAMtD,iEAAiE;IACjE,QAAQ,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAC7D;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,IAAI;IAElE,gBAAgB;IAChB,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE;QACrB,iEAAiE;QACjE,UAAU,CAAC,EAAE,UAAU,CAAC;QACxB,wBAAwB;QACxB,WAAW,EAAE,WAAW,CAAC;QACzB,uCAAuC;QACvC,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,2CAA2C;QAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,6CAA6C;QAC7C,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,gCAAgC;QAChC,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,+BAA+B;QAC/B,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,kCAAkC;QAClC,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,sCAAsC;QACtC,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;KACvC,GAAG,IAAI;CACT"}

package/dist/adapter/resources/render-pipeline.js

@@ -1,36 +1,39 @@
-let _Symbol$toStringTag;
-import { Resource } from "./resource.js";
-_Symbol$toStringTag = Symbol.toStringTag;
+// import {normalizeAttributeMap} from '../helpers/attribute-bindings';
+import { Resource } from './resource';
+/**
+ * A compiled and linked shader program
+ */
 export class RenderPipeline extends Resource {
-  get [_Symbol$toStringTag]() {
-    return 'RenderPipeline';
-  }
-  constructor(device, props) {
-    super(device, props, RenderPipeline.defaultProps);
-    this.hash = '';
-    this.vs = void 0;
-    this.fs = void 0;
-    this.shaderLayout = void 0;
-    this.bufferLayout = void 0;
-    this.shaderLayout = this.props.shaderLayout;
-    this.bufferLayout = this.props.bufferLayout || [];
-  }
+    static defaultProps = {
+        ...Resource.defaultProps,
+        vs: null,
+        vsEntryPoint: '', // main
+        vsConstants: {},
+        fs: null,
+        fsEntryPoint: '', // main
+        fsConstants: {},
+        shaderLayout: null,
+        bufferLayout: [],
+        topology: 'triangle-list',
+        parameters: {},
+        vertexCount: 0,
+        instanceCount: 0,
+        bindings: {},
+        uniforms: {}
+    };
+    get [Symbol.toStringTag]() {
+        return 'RenderPipeline';
+    }
+    hash = '';
+    /** The merged layout */
+    shaderLayout;
+    /** Buffer map describing buffer interleaving etc */
+    bufferLayout;
+    /** The linking status of the pipeline. 'pending' if linking is asynchronous, and on production */
+    linkStatus = 'pending';
+    constructor(device, props) {
+        super(device, props, RenderPipeline.defaultProps);
+        this.shaderLayout = this.props.shaderLayout;
+        this.bufferLayout = this.props.bufferLayout || [];
+    }
 }
-RenderPipeline.defaultProps = {
-  ...Resource.defaultProps,
-  vs: null,
-  vsEntryPoint: '',
-  vsConstants: {},
-  fs: null,
-  fsEntryPoint: '',
-  fsConstants: {},
-  shaderLayout: null,
-  bufferLayout: [],
-  topology: 'triangle-list',
-  parameters: {},
-  vertexCount: 0,
-  instanceCount: 0,
-  bindings: {},
-  uniforms: {}
-};
-//# sourceMappingURL=render-pipeline.js.map

package/dist/adapter/resources/resource.js

@@ -1,101 +1,139 @@
-import { uid } from "../../utils/utils.js";
+import { uid } from '../../utils/utils';
+/**
+ * Base class for GPU (WebGPU/WebGL) Resources
+ */
 export class Resource {
-  constructor(device, props, defaultProps) {
-    this.id = void 0;
-    this.props = void 0;
-    this.userData = {};
-    this.device = void 0;
-    this._device = void 0;
-    this.destroyed = false;
-    this.allocatedBytes = 0;
-    this._attachedResources = new Set();
-    if (!device) {
-      throw new Error('no device');
+    /** Default properties for resource */
+    static defaultProps = {
+        id: 'undefined',
+        handle: undefined,
+        userData: undefined,
+    };
+    /** props.id, for debugging. */
+    id;
+    props;
+    userData = {};
+    _device;
+    /** Whether this resource has been destroyed */
+    destroyed = false;
+    /** For resources that allocate GPU memory */
+    allocatedBytes = 0;
+    /** Attached resources will be destroyed when this resource is destroyed. Tracks auto-created "sub" resources. */
+    _attachedResources = new Set();
+    /**
+     * Create a new Resource. Called from Subclass
+     */
+    constructor(device, props, defaultProps) {
+        if (!device) {
+            throw new Error('no device');
+        }
+        this._device = device;
+        this.props = selectivelyMerge(props, defaultProps);
+        const id = this.props.id !== 'undefined' ? this.props.id : uid(this[Symbol.toStringTag]);
+        this.props.id = id;
+        this.id = id;
+        this.userData = this.props.userData || {};
+        this.addStats();
     }
-    this._device = device;
-    this.props = selectivelyMerge(props, defaultProps);
-    const id = this.props.id !== 'undefined' ? this.props.id : uid(this[Symbol.toStringTag]);
-    this.props.id = id;
-    this.id = id;
-    this.userData = this.props.userData || {};
-    this.addStats();
-  }
-  destroy() {
-    this.destroyResource();
-  }
-  delete() {
-    this.destroy();
-    return this;
-  }
-  toString() {
-    return `${this[Symbol.toStringTag] || this.constructor.name}(${this.id})`;
-  }
-  getProps() {
-    return this.props;
-  }
-  attachResource(resource) {
-    this._attachedResources.add(resource);
-  }
-  detachResource(resource) {
-    this._attachedResources.delete(resource);
-  }
-  destroyAttachedResource(resource) {
-    if (this._attachedResources.delete(resource)) {
-      resource.destroy();
+    /**
+     * destroy can be called on any resource to release it before it is garbage collected.
+     */
+    destroy() {
+        this.destroyResource();
     }
-  }
-  destroyAttachedResources() {
-    for (const resource of Object.values(this._attachedResources)) {
-      resource.destroy();
+    /** @deprecated Use destroy() */
+    delete() {
+        this.destroy();
+        return this;
+    }
+    toString() {
+        return `${this[Symbol.toStringTag] || this.constructor.name}(${this.id})`;
+    }
+    /**
+     * Combines a map of user props and default props, only including props from defaultProps
+     * @returns returns a map of overridden default props
+     */
+    getProps() {
+        return this.props;
+    }
+    // ATTACHED RESOURCES
+    /**
+     * Attaches a resource. Attached resources are auto destroyed when this resource is destroyed
+     * Called automatically when sub resources are auto created but can be called by application
+     */
+    attachResource(resource) {
+        this._attachedResources.add(resource);
+    }
+    /**
+     * Detach an attached resource. The resource will no longer be auto-destroyed when this resource is destroyed.
+     */
+    detachResource(resource) {
+        this._attachedResources.delete(resource);
+    }
+    /**
+     * Destroys a resource (only if owned), and removes from the owned (auto-destroy) list for this resource.
+     */
+    destroyAttachedResource(resource) {
+        if (this._attachedResources.delete(resource)) {
+            resource.destroy();
+        }
+    }
+    /** Destroy all owned resources. Make sure the resources are no longer needed before calling. */
+    destroyAttachedResources() {
+        for (const resource of Object.values(this._attachedResources)) {
+            resource.destroy();
+        }
+        // don't remove while we are iterating
+        this._attachedResources = new Set();
+    }
+    // PROTECTED METHODS
+    /** Perform all destroy steps. Can be called by derived resources when overriding destroy() */
+    destroyResource() {
+        this.destroyAttachedResources();
+        this.removeStats();
+        this.destroyed = true;
+    }
+    /** Called by .destroy() to track object destruction. Subclass must call if overriding destroy() */
+    removeStats() {
+        const stats = this._device.statsManager.getStats('Resource Counts');
+        const name = this[Symbol.toStringTag];
+        stats.get(`${name}s Active`).decrementCount();
+    }
+    /** Called by subclass to track memory allocations */
+    trackAllocatedMemory(bytes, name = this[Symbol.toStringTag]) {
+        const stats = this._device.statsManager.getStats('Resource Counts');
+        stats.get('GPU Memory').addCount(bytes);
+        stats.get(`${name} Memory`).addCount(bytes);
+        this.allocatedBytes = bytes;
+    }
+    /** Called by subclass to track memory deallocations */
+    trackDeallocatedMemory(name = this[Symbol.toStringTag]) {
+        const stats = this._device.statsManager.getStats('Resource Counts');
+        stats.get('GPU Memory').subtractCount(this.allocatedBytes);
+        stats.get(`${name} Memory`).subtractCount(this.allocatedBytes);
+        this.allocatedBytes = 0;
+    }
+    /** Called by resource constructor to track object creation */
+    addStats() {
+        const stats = this._device.statsManager.getStats('Resource Counts');
+        const name = this[Symbol.toStringTag];
+        stats.get('Resources Created').incrementCount();
+        stats.get(`${name}s Created`).incrementCount();
+        stats.get(`${name}s Active`).incrementCount();
     }
-    this._attachedResources = new Set();
-  }
-  destroyResource() {
-    this.destroyAttachedResources();
-    this.removeStats();
-    this.destroyed = true;
-  }
-  removeStats() {
-    const stats = this._device.statsManager.getStats('Resource Counts');
-    const name = this[Symbol.toStringTag];
-    stats.get(`${name}s Active`).decrementCount();
-  }
-  trackAllocatedMemory(bytes) {
-    let name = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : this[Symbol.toStringTag];
-    const stats = this._device.statsManager.getStats('Resource Counts');
-    stats.get('GPU Memory').addCount(bytes);
-    stats.get(`${name} Memory`).addCount(bytes);
-    this.allocatedBytes = bytes;
-  }
-  trackDeallocatedMemory() {
-    let name = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : this[Symbol.toStringTag];
-    const stats = this._device.statsManager.getStats('Resource Counts');
-    stats.get('GPU Memory').subtractCount(this.allocatedBytes);
-    stats.get(`${name} Memory`).subtractCount(this.allocatedBytes);
-    this.allocatedBytes = 0;
-  }
-  addStats() {
-    const stats = this._device.statsManager.getStats('Resource Counts');
-    const name = this[Symbol.toStringTag];
-    stats.get('Resources Created').incrementCount();
-    stats.get(`${name}s Created`).incrementCount();
-    stats.get(`${name}s Active`).incrementCount();
-  }
 }
-Resource.defaultProps = {
-  id: 'undefined',
-  handle: undefined,
-  userData: undefined
-};
+/**
+ * Combines a map of user props and default props, only including props from defaultProps
+ * @param props
+ * @param defaultProps
+ * @returns returns a map of overridden default props
+ */
 function selectivelyMerge(props, defaultProps) {
-  const mergedProps = {
-    ...defaultProps
-  };
-  for (const key in props) {
-    if (props[key] !== undefined) {
-      mergedProps[key] = props[key];
+    const mergedProps = { ...defaultProps };
+    for (const key in props) {
+        if (props[key] !== undefined) {
+            mergedProps[key] = props[key];
+        }
     }
-  }
-  return mergedProps;
+    return mergedProps;
 }
-//# sourceMappingURL=resource.js.map