@zephyr3d/scene 0.1.0 → 0.1.1

package/dist/material/material.js

@@ -45,9 +45,9 @@ class InstanceBindGroupPool {
         return offset;
     }
 }
-/**
- * Base class for any kind of materials
- * @public
+/**
+ * Base class for any kind of materials
+ * @public
  */ class Material {
     /** @internal */ static _debugChannel = '';
     /** @internal */ static _nextId = 0;
@@ -73,8 +73,8 @@ class InstanceBindGroupPool {
     /** @internal */ _optionTag;
     /** @internal */ _materialBindGroup;
     /** @internal */ _id;
-    /**
-   * Creates an instance of material
+    /**
+   * Creates an instance of material
    */ constructor(){
         this._id = ++Material._nextId;
         this._hash = [];
@@ -113,10 +113,10 @@ class InstanceBindGroupPool {
     /** Returns true if shading of the material will be affected by lights  */ supportLighting() {
         return true;
     }
-    /**
-   * Draws a primitive using this material
-   * @param primitive - The prmitive to be drawn
-   * @param ctx - The context of current drawing task
+    /**
+   * Draws a primitive using this material
+   * @param primitive - The prmitive to be drawn
+   * @param ctx - The context of current drawing task
    */ draw(primitive, ctx) {
         if (this.beginDraw(ctx)) {
             if (ctx.instanceData?.worldMatrices.length > 1) {
@@ -127,10 +127,10 @@ class InstanceBindGroupPool {
             this.endDraw();
         }
     }
-    /**
-   * Prepares for drawing
-   * @param ctx - The context of current drawing task
-   * @returns true if succeeded, otherwise false
+    /**
+   * Prepares for drawing
+   * @param ctx - The context of current drawing task
+   * @returns true if succeeded, otherwise false
    */ beginDraw(ctx) {
         const numInstances = ctx.instanceData?.worldMatrices?.length || 1;
         const device = Application.instance.device;
@@ -156,31 +156,31 @@ class InstanceBindGroupPool {
         }
         return false;
     }
-    /**
-   * Ends drawing a primitive
+    /**
+   * Ends drawing a primitive
    */ endDraw() {
         this._materialBindGroup = null;
     }
-    /**
-   * Gets the bind group of this material
-   * @returns The bind group of this material
+    /**
+   * Gets the bind group of this material
+   * @returns The bind group of this material
    */ getMaterialBindGroup() {
         return this._materialBindGroup;
     }
-    /**
-   * Sets all uniform values to the bind group of the material if needed
-   * @param bindGroup - The bind group of the material
-   * @param ctx - The context of current drawing task
-   * @param needUpdate - true if the uniform values needs to update
+    /**
+   * Sets all uniform values to the bind group of the material if needed
+   * @param bindGroup - The bind group of the material
+   * @param ctx - The context of current drawing task
+   * @param needUpdate - true if the uniform values needs to update
    */ applyUniforms(bindGroup, ctx, needUpdate) {
         if (needUpdate) {
             this._applyUniforms(bindGroup, ctx);
         }
     }
-    /**
-   * Fetch the gpu program of the material for drawing
-   * @param ctx - The context for current drawing task
-   * @returns Information of the gpu program
+    /**
+   * Fetch the gpu program of the material for drawing
+   * @param ctx - The context for current drawing task
+   * @returns Information of the gpu program
    */ getOrCreateProgram(ctx) {
         const programMap = Material._programMap;
         const renderPassType = ctx.renderPass.type;
@@ -208,22 +208,22 @@ class InstanceBindGroupPool {
     dispose() {
         this.clearBindGroupCache();
     }
-    /**
-   * Sets the options of garbage collection
-   * @param opt - The options to set
+    /**
+   * Sets the options of garbage collection
+   * @param opt - The options to set
    */ static setGCOptions(opt) {
         this._gcOptions = Object.assign({}, this._gcOptions, opt || {});
     }
-    /**
-   * Gets the options of garbage collection
-   * @returns The options of garbage collection
+    /**
+   * Gets the options of garbage collection
+   * @returns The options of garbage collection
    */ static getGCOptions() {
         return this._gcOptions;
     }
-    /**
-   * Performs a garbage collection for this material
-   * @param ts - Current time stamp
-   * @returns How many bind groups have been garbage collected
+    /**
+   * Performs a garbage collection for this material
+   * @param ts - Current time stamp
+   * @returns How many bind groups have been garbage collected
    */ static garbageCollect(ts) {
         let n = 0;
         ts -= this._gcOptions.inactiveTimeDuration;
@@ -432,23 +432,23 @@ class InstanceBindGroupPool {
     /** @internal */ createRenderStateSet() {
         return Application.instance.device.createRenderStateSet();
     }
-    /**
-   * Creates the shader program
-   * @param pb - The program builder
-   * @param ctx - The drawing context
-   * @param func - The material func
-   * @returns The created shader program
+    /**
+   * Creates the shader program
+   * @param pb - The program builder
+   * @param ctx - The drawing context
+   * @param func - The material func
+   * @returns The created shader program
    */ _createProgram(pb, ctx) {
         return null;
     }
-    /**
-   * Applies uniform values
-   * @param bindGroup - The bind group
-   * @param ctx - The drawing context
+    /**
+   * Applies uniform values
+   * @param bindGroup - The bind group
+   * @param ctx - The drawing context
    */ _applyUniforms(bindGroup, ctx) {}
-    /**
-   * Calculates the hash code of the shader program
-   * @returns The hash code
+    /**
+   * Calculates the hash code of the shader program
+   * @returns The hash code
    */ _createHash(renderPassType) {
         return '';
     }

package/dist/material/meshmaterial.js

@@ -128,21 +128,21 @@ class MeshMaterial extends Material {
         }
         return this._createProgram(pb, ctx);
     }
-    /**
-   * Check if a feature is in use for given render pass type.
-   *
-   * @param feature - The feature name
-   * @param renderPassType - Render pass type
-   * @returns true if the feature is in use, otherwise false.
+    /**
+   * Check if a feature is in use for given render pass type.
+   *
+   * @param feature - The feature name
+   * @param renderPassType - Render pass type
+   * @returns true if the feature is in use, otherwise false.
    */ featureUsed(feature, renderPassType) {
         const index = this._features.get(feature);
         return this._featureStates[renderPassType][index];
     }
-    /**
-   * Use or unuse a feature of the material, this will cause the shader to be rebuild.
-   *
-   * @param feature - Which feature will be used or unused
-   * @param use - true if use the feature, otherwise false
+    /**
+   * Use or unuse a feature of the material, this will cause the shader to be rebuild.
+   *
+   * @param feature - Which feature will be used or unused
+   * @param use - true if use the feature, otherwise false
    */ useFeature(feature, use, renderPassType) {
         renderPassType = renderPassType ?? allRenderPassTypes;
         if (typeof renderPassType === 'number') {
@@ -169,40 +169,40 @@ class MeshMaterial extends Material {
             this.optionChanged(true);
         }
     }
-    /**
-   * {@inheritDoc Material._createHash}
-   * @override
+    /**
+   * {@inheritDoc Material._createHash}
+   * @override
    */ _createHash(renderPassType) {
         return this._featureStates[renderPassType].join('');
     }
-    /**
-   * {@inheritDoc Material._applyUniforms}
-   * @override
+    /**
+   * {@inheritDoc Material._applyUniforms}
+   * @override
    */ _applyUniforms(bindGroup, ctx) {
         this.applyUniformValues(bindGroup, ctx);
     }
-    /**
-   * Check if the color should be computed in fragment shader, this is required for forward render pass or alpha test is in use or alpha to coverage is in use.
-   *
-   * @param ctx - The drawing context
-   * @returns - true if the color should be computed in fragment shader, otherwise false.
+    /**
+   * Check if the color should be computed in fragment shader, this is required for forward render pass or alpha test is in use or alpha to coverage is in use.
+   *
+   * @param ctx - The drawing context
+   * @returns - true if the color should be computed in fragment shader, otherwise false.
    */ needFragmentColor(ctx) {
         return ctx.renderPass.type === RENDER_PASS_TYPE_FORWARD || this._alphaCutoff > 0 || this.alphaToCoverage;
     }
-    /**
-   * Transform vertex position to the clip space and calcuate the world position, world normal and tangent frame if needed
-   *
-   * @remarks
-   * This function handles skin animation and geometry instancing if needed
-   *
-   * @param scope - Current shader scope
+    /**
+   * Transform vertex position to the clip space and calcuate the world position, world normal and tangent frame if needed
+   *
+   * @remarks
+   * This function handles skin animation and geometry instancing if needed
+   *
+   * @param scope - Current shader scope
    */ transformVertexAndNormal(scope) {
         ShaderFramework.ftransform(scope);
     }
-    /**
-   * Vertex shader implementation of this material
-   * @param scope - Shader scope
-   * @param ctx - The drawing context
+    /**
+   * Vertex shader implementation of this material
+   * @param scope - Shader scope
+   * @param ctx - The drawing context
    */ vertexShader(scope, ctx) {
         const pb = scope.$builder;
         ShaderFramework.prepareVertexShader(pb, ctx);
@@ -211,10 +211,10 @@ class MeshMaterial extends Material {
             scope.$inputs.kkBlendWeights = pb.vec4().attrib('blendWeights');
         }
     }
-    /**
-   * Fragment shader implementation of this material
-   * @param scope - Shader scope
-   * @param ctx - The drawing context
+    /**
+   * Fragment shader implementation of this material
+   * @param scope - Shader scope
+   * @param ctx - The drawing context
    */ fragmentShader(scope, ctx) {
         const pb = scope.$builder;
         ShaderFramework.prepareFragmentShader(pb, ctx);
@@ -227,9 +227,9 @@ class MeshMaterial extends Material {
             }
         }
     }
-    /**
-   * {@inheritDoc Material._createProgram}
-   * @override
+    /**
+   * {@inheritDoc Material._createProgram}
+   * @override
    */ _createProgram(pb, ctx) {
         const that = this;
         const program = pb.buildRenderProgram({
@@ -247,14 +247,14 @@ class MeshMaterial extends Material {
         });
         return program;
     }
-    /**
-   * Calculate final fragment color for output.
-   *
-   * @param scope - Shader scope
-   * @param color - Lit fragment color
-   * @param ctx - The drawing context
-   *
-   * @returns The final fragment color
+    /**
+   * Calculate final fragment color for output.
+   *
+   * @param scope - Shader scope
+   * @param color - Lit fragment color
+   * @param ctx - The drawing context
+   *
+   * @returns The final fragment color
    */ outputFragmentColor(scope, color, ctx) {
         const pb = scope.$builder;
         const that = this;

package/dist/material/unlit.js

@@ -2,9 +2,9 @@ import { applyMaterialMixins, MeshMaterial } from './meshmaterial.js';
 import { mixinAlbedoColor } from './mixins/albedocolor.js';
 import { mixinVertexColor } from './mixins/vertexcolor.js';
 
-/**
- * Unlit material
- * @public
+/**
+ * Unlit material
+ * @public
  */ class UnlitMaterial extends applyMaterialMixins(MeshMaterial, mixinVertexColor, mixinAlbedoColor) {
     static FEATURE_VERTEX_COLOR = 'um_vertexcolor';
     constructor(){

package/dist/posteffect/bloom.js

@@ -16,9 +16,9 @@ import '../render/clipmap.js';
 import { TemporalCache } from '../render/temporalcache.js';
 import '../render/watermesh.js';
 
-/**
- * The bloom post effect
- * @public
+/**
+ * The bloom post effect
+ * @public
  */ class Bloom extends AbstractPostEffect {
     static _nearestSampler = null;
     static _programDownsampleH = null;
@@ -39,8 +39,8 @@ import '../render/watermesh.js';
     _threshold;
     _thresholdKnee;
     _intensity;
-    /**
-   * Creates an instance of tonemap post effect
+    /**
+   * Creates an instance of tonemap post effect
    */ constructor(){
         super();
         this._bindgroupDownsampleH = null;

package/dist/posteffect/compositor.js

@@ -16,9 +16,9 @@ import '../render/clipmap.js';
 import { TemporalCache } from '../render/temporalcache.js';
 import '../render/watermesh.js';
 
-/**
- * Post processing compositor
- * @public
+/**
+ * Post processing compositor
+ * @public
  */ class Compositor {
     /** @internal */ _postEffectsOpaque;
     /** @internal */ _postEffectsTransparency;
@@ -27,8 +27,8 @@ import '../render/watermesh.js';
     /** @internal */ static _blitBindgroup = null;
     /** @internal */ static _blitRenderStates = null;
     /** @internal */ static _blitVertexLayout = null;
-    /**
-   * Creates an instance of Compositor
+    /**
+   * Creates an instance of Compositor
    */ constructor(){
         this._postEffectsOpaque = [];
         this._postEffectsTransparency = [];
@@ -46,11 +46,11 @@ import '../render/watermesh.js';
         }
         return false;
     }
-    /**
-   * Adds a posteffect
-   *
-   * @param postEffect - The post effect to add
-   * @param opaque - true if the post effect should be applied after the opaque pass and before the transparent pass, otherwise the post effect should be applied after the transparent pass
+    /**
+   * Adds a posteffect
+   *
+   * @param postEffect - The post effect to add
+   * @param opaque - true if the post effect should be applied after the opaque pass and before the transparent pass, otherwise the post effect should be applied after the transparent pass
    */ appendPostEffect(postEffect) {
         if (postEffect) {
             if (this._postEffectsOpaque.indexOf(postEffect) >= 0 || this._postEffectsTransparency.indexOf(postEffect) >= 0) {
@@ -61,10 +61,10 @@ import '../render/watermesh.js';
             postEffects.push(postEffect);
         }
     }
-    /**
-   * Removes a posteffect that was previously added
-   *
-   * @param postEffect - The posteffect to be remove.
+    /**
+   * Removes a posteffect that was previously added
+   *
+   * @param postEffect - The posteffect to be remove.
    */ removePostEffect(postEffect) {
         for (const list of [
             this._postEffectsOpaque,
@@ -77,8 +77,8 @@ import '../render/watermesh.js';
             }
         }
     }
-    /**
-   * Gets all post effects
+    /**
+   * Gets all post effects
    */ getPostEffects() {
         return [
             ...this._postEffectsOpaque,

package/dist/posteffect/fxaa.js

@@ -3,16 +3,16 @@ import { Application } from '../app.js';
 import { AbstractPostEffect } from './posteffect.js';
 import { linearToGamma } from '../shaders/misc.js';
 
-/**
- * FXAA post effect
- * @public
+/**
+ * FXAA post effect
+ * @public
  */ class FXAA extends AbstractPostEffect {
     static _program = null;
     static _sampler = null;
     _bindgroup;
     _invTexSize;
-    /**
-   * Creates an instance of grayscale post effect
+    /**
+   * Creates an instance of grayscale post effect
    */ constructor(){
         super();
         this._opaque = false;

package/dist/posteffect/grayscale.js

@@ -2,15 +2,15 @@ import { Application } from '../app.js';
 import { AbstractPostEffect } from './posteffect.js';
 import { linearToGamma } from '../shaders/misc.js';
 
-/**
- * Grayscale post effect
- * @public
+/**
+ * Grayscale post effect
+ * @public
  */ class Grayscale extends AbstractPostEffect {
     static _program = null;
     static _sampler = null;
     _bindgroup;
-    /**
-   * Creates an instance of grayscale post effect
+    /**
+   * Creates an instance of grayscale post effect
    */ constructor(){
         super();
         this._opaque = false;

package/dist/posteffect/posteffect.js

@@ -1,9 +1,9 @@
 import { Application } from '../app.js';
 import { drawFullscreenQuad } from '../render/helper.js';
 
-/**
- * Base class for any type of post effect
- * @public
+/**
+ * Base class for any type of post effect
+ * @public
  */ class AbstractPostEffect {
     _outputTexture;
     _quadVertexLayout;
@@ -11,9 +11,9 @@ import { drawFullscreenQuad } from '../render/helper.js';
     _enabled;
     _opaque;
     _intermediateFramebuffers;
-    /**
-   * Creates an instance of a post effect
-   * @param name - Name of the post effect
+    /**
+   * Creates an instance of a post effect
+   * @param name - Name of the post effect
    */ constructor(){
         this._outputTexture = null;
         this._quadVertexLayout = null;
@@ -31,18 +31,18 @@ import { drawFullscreenQuad } from '../render/helper.js';
     /** Whether this post effect will be rendered at opaque phase */ get opaque() {
         return this._opaque;
     }
-    /**
-   * Check if the post effect should be rendered upside down.
-   * @param device - The device object
-   * @returns true if the post effect should be rendered upside down
+    /**
+   * Check if the post effect should be rendered upside down.
+   * @param device - The device object
+   * @returns true if the post effect should be rendered upside down
    */ needFlip(device) {
         return device.type === 'webgpu' && !!device.getFramebuffer();
     }
-    /**
-   * Adds an intermediate frame buffer
-   * @param name - Name of the frame buffer
-   * @param format - Render target texture format
-   * @param useDepth - Whether the scene depth buffer should be attached to the frame buffer
+    /**
+   * Adds an intermediate frame buffer
+   * @param name - Name of the frame buffer
+   * @param format - Render target texture format
+   * @param useDepth - Whether the scene depth buffer should be attached to the frame buffer
    */ addIntermediateFramebuffer(name, depth) {
         if (this._intermediateFramebuffers[name]) {
             throw new Error(`Intermediate framebuffer already exists: ${name}`);
@@ -52,15 +52,15 @@ import { drawFullscreenQuad } from '../render/helper.js';
             framebuffer: null
         };
     }
-    /**
-   * Gets the intermediate frame buffer by name
-   * @param name - Name of the intermediate frame buffer
-   * @param width - Width of the frame buffer
-   * @param height - Height of the frame buffer
-   * @returns The intermediate frame buffer or null if not exists
-   *
-   * @remarks
-   * The intemediate buffer will be resized to fit the given size if needed
+    /**
+   * Gets the intermediate frame buffer by name
+   * @param name - Name of the intermediate frame buffer
+   * @param width - Width of the frame buffer
+   * @param height - Height of the frame buffer
+   * @returns The intermediate frame buffer or null if not exists
+   *
+   * @remarks
+   * The intemediate buffer will be resized to fit the given size if needed
    */ getIntermediateFramebuffer(name, format, width, height) {
         const fb = this._intermediateFramebuffers[name];
         if (!fb) {
@@ -100,8 +100,8 @@ import { drawFullscreenQuad } from '../render/helper.js';
         }
         return fb.framebuffer;
     }
-    /**
-   * Disposes the post effect.
+    /**
+   * Disposes the post effect.
    */ dispose() {
         this._quadVertexLayout?.dispose();
         this._quadVertexLayout = null;
@@ -116,24 +116,24 @@ import { drawFullscreenQuad } from '../render/helper.js';
         }
         this._intermediateFramebuffers = {};
     }
-    /**
-   * Draws a fullscreen quad
-   * @param renderStateSet - Render states that will be used when drawing the fullscreen quad.
+    /**
+   * Draws a fullscreen quad
+   * @param renderStateSet - Render states that will be used when drawing the fullscreen quad.
    */ drawFullscreenQuad(renderStateSet) {
         drawFullscreenQuad(renderStateSet);
-    /*
-    const device = Application.instance.device;
-    if (!this._quadVertexLayout) {
-      this._quadVertexLayout = this.createVertexLayout(device);
-    }
-    if (!this._quadRenderStateSet) {
-      this._quadRenderStateSet = this.createRenderStates(device);
-    }
-    const lastRenderState = device.getRenderStates();
-    device.setVertexLayout(this._quadVertexLayout);
-    device.setRenderStates(renderStateSet ?? this._quadRenderStateSet);
-    device.draw('triangle-strip', 0, 4);
-    device.setRenderStates(lastRenderState);
+    /*
+    const device = Application.instance.device;
+    if (!this._quadVertexLayout) {
+      this._quadVertexLayout = this.createVertexLayout(device);
+    }
+    if (!this._quadRenderStateSet) {
+      this._quadRenderStateSet = this.createRenderStates(device);
+    }
+    const lastRenderState = device.getRenderStates();
+    device.setVertexLayout(this._quadVertexLayout);
+    device.setRenderStates(renderStateSet ?? this._quadRenderStateSet);
+    device.draw('triangle-strip', 0, 4);
+    device.setRenderStates(lastRenderState);
     */ }
     /** @internal */ createVertexLayout(device) {
         return device.createVertexLayout({

package/dist/posteffect/sao.js

@@ -21,9 +21,9 @@ import '../render/watermesh.js';
 
 const NUM_SAMPLES = 7;
 const NUM_RINGS = 4;
-/**
- * The Scalable Ambient Obscurance (SAO) post effect
- * @public
+/**
+ * The Scalable Ambient Obscurance (SAO) post effect
+ * @public
  */ class SAO extends AbstractPostEffect {
     static _nearestSampler = null;
     static _program = null;
@@ -43,8 +43,8 @@ const NUM_RINGS = 4;
     _blitterV;
     _copyBlitter;
     _supported;
-    /**
-   * Creates an instance of SAO post effect
+    /**
+   * Creates an instance of SAO post effect
    */ constructor(){
         super();
         this._bindgroup = null;

package/dist/posteffect/tonemap.js

@@ -2,16 +2,16 @@ import { Application } from '../app.js';
 import { AbstractPostEffect } from './posteffect.js';
 import { linearToGamma } from '../shaders/misc.js';
 
-/**
- * The tonemap post effect
- * @public
+/**
+ * The tonemap post effect
+ * @public
  */ class Tonemap extends AbstractPostEffect {
     static _nearestSampler = null;
     static _programTonemap = null;
     _bindgroupTonemap;
     _exposure;
-    /**
-   * Creates an instance of tonemap post effect
+    /**
+   * Creates an instance of tonemap post effect
    */ constructor(){
         super();
         this._bindgroupTonemap = null;

package/dist/posteffect/water.js

@@ -20,9 +20,9 @@ import { Camera } from '../camera/camera.js';
 import { CopyBlitter } from '../blitter/copy.js';
 import { fresnelSchlick, distributionGGX, visGGX } from '../shaders/pbr.js';
 
-/**
- * The post water effect
- * @public
+/**
+ * The post water effect
+ * @public
  */ class PostWater extends AbstractPostEffect {
     _elevation;
     _region;
@@ -53,9 +53,9 @@ import { fresnelSchlick, distributionGGX, visGGX } from '../shaders/pbr.js';
     _waveCroppiness2;
     _currentWaterMesh;
     _waterMeshes;
-    /**
-   * Creates an instance of PostWater.
-   * @param elevation - Elevation of the water
+    /**
+   * Creates an instance of PostWater.
+   * @param elevation - Elevation of the water
    */ constructor(elevation){
         super();
         this._elevation = elevation ?? 0;