@babylonjs/smart-filters 0.1.0-alpha

package/dist/smartFilter.js

@@ -0,0 +1,154 @@
+import { OutputBlock } from "./blocks/outputBlock.js";
+import { InternalSmartFilterRuntime } from "./runtime/smartFilterRuntime.js";
+import { RenderTargetGenerator } from "./runtime/renderTargetGenerator.js";
+import { AggregateBlock } from "./blocks/aggregateBlock.js";
+/**
+ * How long to wait for shader compilation and texture loading to complete before erroring out.
+ */
+const InitializationTimeout = 10000;
+/**
+ * The smart filter class is the main class of the smart filter module.
+ *
+ * It is responsible for managing a graph of smart filter blocks.
+ *
+ * It is also responsible for creating the runtime associated to the current state of the filter.
+ */
+export class SmartFilter {
+    /**
+     * Creates a new instance of a @see SmartFilter.
+     * @param name - The friendly name of the smart filter
+     */
+    constructor(name) {
+        /**
+         * User defined comments to describe the current smart filter.
+         */
+        this.comments = null;
+        /**
+         * Data used by the smart filter editor.
+         * TODO. strong type and hide this.
+         */
+        this.editorData = null;
+        this.name = name;
+        this._attachedBlocks = new Array();
+        this._outputBlock = new OutputBlock(this);
+        this.output = this._outputBlock.input;
+    }
+    /**
+     * @returns the list of blocks attached to the smart filter.
+     */
+    get attachedBlocks() {
+        return this._attachedBlocks;
+    }
+    /**
+     * @returns The current class name of the smart filter.
+     */
+    getClassName() {
+        return "SmartFilter";
+    }
+    /**
+     * Registers a block to be part of this smart filter.
+     * @param block - The block to register on the smart filter
+     * @throws if the block is already registered on another smart filter
+     * @remarks This function will not register the block if it is already registered on the smart filter.
+     */
+    registerBlock(block) {
+        // It is impossible to attach a block from another filter
+        if (block.smartFilter !== this) {
+            throw new Error("Block is not part of this smart filter");
+        }
+        // No need to attach a block several times
+        if (this._attachedBlocks.indexOf(block) !== -1) {
+            return;
+        }
+        // Add the block to the list of attached blocks
+        this._attachedBlocks.push(block);
+    }
+    /**
+     * Removes the block from the smart filter.
+     * @param block - The block to remove from the smart filter
+     * @remarks This function will disconnect the block on removal.
+     * This Output block cannot be removed.
+     */
+    removeBlock(block) {
+        const attachedBlockIndex = this._attachedBlocks.indexOf(block);
+        // The block can only be removed if it is not the output block
+        // and if it is attached to the smart filter
+        if (attachedBlockIndex > -1 && !block.isOutput) {
+            // Disconnects all the connections of the block
+            block.disconnect();
+            // Removes the block from the list of attached blocks
+            this._attachedBlocks.splice(attachedBlockIndex, 1);
+        }
+    }
+    _generateCommandsAndGatherInitPromises(initializationData) {
+        const outputBlock = this._outputBlock;
+        outputBlock.visit(initializationData, (block, initializationData) => {
+            var _a, _b;
+            // If the block is the output block,
+            if (block === outputBlock) {
+                // We only need to do something if the connected block is an input block.
+                // Indeed, any other block linked to the output block would directly render to the canvas
+                // as an optimization.
+                // In case the output block is not linked to an input block, we do not need extra commands
+                // or resources to create a render pass.
+                if ((_a = outputBlock.input.connectedTo) === null || _a === void 0 ? void 0 : _a.ownerBlock.isInput) {
+                    block.generateCommandsAndGatherInitPromises(initializationData, true);
+                }
+                return;
+            }
+            block.generateCommandsAndGatherInitPromises(initializationData, ((_b = outputBlock.input.connectedTo) === null || _b === void 0 ? void 0 : _b.ownerBlock) === block);
+        });
+    }
+    /**
+     * Create a new runtime for the current state of the smart filter.
+     * @param engine - The Babylon.js engine to use for the runtime
+     * @param renderTargetGenerator - The render target generator to use to generate the RTTs for the shader blocks. If not provided, a default one will be created.
+     * @returns the runtime that can be used to render the smart filter
+     */
+    async createRuntimeAsync(engine, renderTargetGenerator) {
+        const runtime = new InternalSmartFilterRuntime(engine);
+        const initializationData = {
+            runtime,
+            outputBlock: this._outputBlock,
+            initializationPromises: [],
+        };
+        this._workWithAggregateFreeGraph(() => {
+            this._outputBlock.prepareForRuntime();
+            renderTargetGenerator = renderTargetGenerator !== null && renderTargetGenerator !== void 0 ? renderTargetGenerator : new RenderTargetGenerator(false);
+            renderTargetGenerator.setOutputTextures(this, initializationData);
+            this._outputBlock.propagateRuntimeData();
+            this._generateCommandsAndGatherInitPromises(initializationData);
+        });
+        // Wait for all the blocks to be initialized
+        if (initializationData.initializationPromises.length > 0) {
+            const timeoutPromise = new Promise((resolve) => setTimeout(resolve, InitializationTimeout, true));
+            const initializationPromises = Promise.all(initializationData.initializationPromises).then(() => false);
+            const timedOut = await Promise.race([initializationPromises, timeoutPromise]);
+            if (timedOut) {
+                throw new Error("Initialization promises timed out");
+            }
+        }
+        return runtime;
+    }
+    /**
+     * @internal
+     * Merges all aggregate blocks into the smart filter graph, executes the passed-in work, then restores the aggregate blocks.
+     * @param work - The work to execute with the aggregate blocks merged
+     */
+    _workWithAggregateFreeGraph(work) {
+        const mergedAggregateBlocks = [];
+        // Merge all aggregate blocks
+        this._outputBlock.visit({}, (block, _extraData) => {
+            if (block instanceof AggregateBlock) {
+                block._mergeIntoSmartFilter(mergedAggregateBlocks);
+            }
+        });
+        // Do the passed in work
+        work();
+        // Restore all aggregate blocks
+        for (const block of mergedAggregateBlocks) {
+            block._unmergeFromSmartFilter();
+        }
+    }
+}
+//# sourceMappingURL=smartFilter.js.map

package/dist/smartFilter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"smartFilter.js","sourceRoot":"","sources":["../src/smartFilter.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAE5D;;GAEG;AACH,MAAM,qBAAqB,GAAG,KAAK,CAAC;AAsBpC;;;;;;GAMG;AACH,MAAM,OAAO,WAAW;IA2BpB;;;OAGG;IACH,YAAY,IAAY;QAlBxB;;WAEG;QACI,aAAQ,GAAqB,IAAI,CAAC;QAEzC;;;WAGG;QACI,eAAU,GAAQ,IAAI,CAAC;QAU1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAEjB,IAAI,CAAC,eAAe,GAAG,IAAI,KAAK,EAAa,CAAC;QAC9C,IAAI,CAAC,YAAY,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;QACrB,OAAO,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;IAED;;OAEG;IACI,YAAY;QACf,OAAO,aAAa,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,KAAgB;QACjC,yDAAyD;QACzD,IAAI,KAAK,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC9D,CAAC;QAED,0CAA0C;QAC1C,IAAI,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YAC7C,OAAO;QACX,CAAC;QAED,+CAA+C;QAC/C,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAC,KAAgB;QAC/B,MAAM,kBAAkB,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAE/D,8DAA8D;QAC9D,4CAA4C;QAC5C,IAAI,kBAAkB,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;YAC7C,+CAA+C;YAC/C,KAAK,CAAC,UAAU,EAAE,CAAC;YAEnB,qDAAqD;YACrD,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC;QACvD,CAAC;IACL,CAAC;IAEO,sCAAsC,CAAC,kBAAsC;QACjF,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC;QAEtC,WAAW,CAAC,KAAK,CAAC,kBAAkB,EAAE,CAAC,KAAgB,EAAE,kBAAsC,EAAE,EAAE;;YAC/F,oCAAoC;YACpC,IAAI,KAAK,KAAK,WAAW,EAAE,CAAC;gBACxB,yEAAyE;gBACzE,yFAAyF;gBACzF,sBAAsB;gBACtB,0FAA0F;gBAC1F,wCAAwC;gBACxC,IAAI,MAAA,WAAW,CAAC,KAAK,CAAC,WAAW,0CAAE,UAAU,CAAC,OAAO,EAAE,CAAC;oBACpD,KAAK,CAAC,qCAAqC,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAC;gBAC1E,CAAC;gBACD,OAAO;YACX,CAAC;YAED,KAAK,CAAC,qCAAqC,CACvC,kBAAkB,EAClB,CAAA,MAAA,WAAW,CAAC,KAAK,CAAC,WAAW,0CAAE,UAAU,MAAK,KAAK,CACtD,CAAC;QACN,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,kBAAkB,CAC3B,MAAkB,EAClB,qBAA6C;QAE7C,MAAM,OAAO,GAAG,IAAI,0BAA0B,CAAC,MAAM,CAAC,CAAC;QAEvD,MAAM,kBAAkB,GAAuB;YAC3C,OAAO;YACP,WAAW,EAAE,IAAI,CAAC,YAAY;YAC9B,sBAAsB,EAAE,EAAE;SAC7B,CAAC;QAEF,IAAI,CAAC,2BAA2B,CAAC,GAAG,EAAE;YAClC,IAAI,CAAC,YAAY,CAAC,iBAAiB,EAAE,CAAC;YAEtC,qBAAqB,GAAG,qBAAqB,aAArB,qBAAqB,cAArB,qBAAqB,GAAI,IAAI,qBAAqB,CAAC,KAAK,CAAC,CAAC;YAClF,qBAAqB,CAAC,iBAAiB,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;YAElE,IAAI,CAAC,YAAY,CAAC,oBAAoB,EAAE,CAAC;YAEzC,IAAI,CAAC,sCAAsC,CAAC,kBAAkB,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;QAEH,4CAA4C;QAC5C,IAAI,kBAAkB,CAAC,sBAAsB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvD,MAAM,cAAc,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,qBAAqB,EAAE,IAAI,CAAC,CAAC,CAAC;YAClG,MAAM,sBAAsB,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,sBAAsB,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;YACxG,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,sBAAsB,EAAE,cAAc,CAAC,CAAC,CAAC;YAC9E,IAAI,QAAQ,EAAE,CAAC;gBACX,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;YACzD,CAAC;QACL,CAAC;QAED,OAAO,OAAO,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,2BAA2B,CAAC,IAAgB;QAC/C,MAAM,qBAAqB,GAAqB,EAAE,CAAC;QAEnD,6BAA6B;QAC7B,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,KAAgB,EAAE,UAAkB,EAAE,EAAE;YACjE,IAAI,KAAK,YAAY,cAAc,EAAE,CAAC;gBAClC,KAAK,CAAC,qBAAqB,CAAC,qBAAqB,CAAC,CAAC;YACvD,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,wBAAwB;QACxB,IAAI,EAAE,CAAC;QAEP,+BAA+B;QAC/B,KAAK,MAAM,KAAK,IAAI,qBAAqB,EAAE,CAAC;YACxC,KAAK,CAAC,uBAAuB,EAAE,CAAC;QACpC,CAAC;IACL,CAAC;CACJ"}

package/dist/utils/shaderCodeUtils.d.ts

@@ -0,0 +1,131 @@
+import type { Effect } from "@babylonjs/core/Materials/effect";
+/**
+ * The shader code decorator.
+ * Used to decorate the names of uniform, function and const variables for easier parsing.
+ */
+export declare const decorateChar = "_";
+/**
+ * Describes a shader function.
+ */
+export type ShaderFunction = {
+    /**
+     * The name of the function.
+     */
+    name: string;
+    /**
+     * The code of the function.
+     */
+    code: string;
+};
+/**
+ * Describes a shader code.
+ */
+export type ShaderCode = {
+    /**
+     * The declaration of the const variables.
+     */
+    const?: string;
+    /**
+     * The declaration of the uniform variables.
+     */
+    uniform?: string;
+    /**
+     * The declaration of the uniform variables that should be common for all ShaderBlock instances using this shader code.
+     */
+    uniformSingle?: string;
+    /**
+     * The name of the main function.
+     */
+    mainFunctionName: string;
+    /**
+     * The name of the main input texture.
+     */
+    mainInputTexture?: string;
+    /**
+     * The list of functions used in the shader.
+     */
+    functions: ShaderFunction[];
+};
+/**
+ * Describes a shader program.
+ */
+export type ShaderProgram = {
+    /**
+     * The vertex shader code.
+     */
+    vertex?: string | undefined;
+    /**
+     * The fragment shader code.
+     */
+    fragment: ShaderCode;
+};
+/**
+ * The list of options required to create a shader block.
+ * It mainly contains the shader code to execute and its associated parameters.
+ */
+export type ShaderCreationOptions = {
+    /**
+     * A friendly name for the shader visible in Spector or in logs.
+     */
+    name: string;
+    /**
+     * Fragment shader source code.
+     */
+    fragmentShader: string;
+    /**
+     * Vertex shader source code.
+     */
+    vertexShader?: string;
+    /**
+     * Attributes to use in the shader
+     */
+    attributeNames?: Array<string>;
+    /**
+     * Uniforms to use in the shader
+     */
+    uniformNames?: Array<string>;
+    /**
+     * Texture sampler names to use in the shader
+     */
+    samplerNames?: Array<string>;
+    /**
+     * Defines to use in the shader
+     */
+    defines?: Array<string>;
+    /**
+     * Callback when the effect is compiled
+     */
+    onCompiled?: (effect: Effect) => void;
+};
+/**
+ * Injects the disable uniform into a shader program.
+ * @param shaderProgram - The shader program to inject the disable uniform into.
+ * @returns The modified shader program
+ */
+export declare function injectDisableUniform(shaderProgram: ShaderProgram): ShaderProgram;
+/**
+ * Gets the shader fragment code.
+ * @param shaderProgram - The shader program to extract the code from.
+ * @param mainCodeOnly - If true, only the main function code will be returned.
+ * @returns The shader fragment code.
+ */
+export declare function getShaderFragmentCode(shaderProgram: ShaderProgram, mainCodeOnly?: boolean): string;
+/**
+ * Gets the shader creation options from a shader program.
+ * @param shaderProgram - The shader program to build the create options from.
+ * @returns The shader creation options.
+ */
+export declare function getShaderCreateOptions(shaderProgram: ShaderProgram): ShaderCreationOptions;
+/**
+ * Decorates a symbol (uniform, function or const) name.
+ * @param symbol - The symbol to decorate.
+ * @returns The decorated symbol.
+ */
+export declare function decorateSymbol(symbol: string): string;
+/**
+ * Undecorates a symbol (uniform, function or const) name.
+ * @param symbol - The symbol to undecorate.
+ * @returns The undecorated symbol. Throws an error if the symbol is not decorated.
+ */
+export declare function undecorateSymbol(symbol: string): string;
+//# sourceMappingURL=shaderCodeUtils.d.ts.map

package/dist/utils/shaderCodeUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shaderCodeUtils.d.ts","sourceRoot":"","sources":["../../src/utils/shaderCodeUtils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AAE/D;;;GAGG;AACH,eAAO,MAAM,YAAY,MAAM,CAAC;AAEhC;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IACzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,cAAc,EAAE,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IACxB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,UAAU,CAAC;CACxB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC/B;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7B;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACxB;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;CACzC,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,aAAa,EAAE,aAAa,iBAiBhE;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,aAAa,EAAE,YAAY,UAAQ,GAAG,MAAM,CA0BhG;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,aAAa,EAAE,aAAa,GAAG,qBAAqB,CA4C1F;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAErD;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAMvD"}

package/dist/utils/shaderCodeUtils.js

@@ -0,0 +1,115 @@
+/**
+ * The shader code decorator.
+ * Used to decorate the names of uniform, function and const variables for easier parsing.
+ */
+export const decorateChar = "_";
+/**
+ * Injects the disable uniform into a shader program.
+ * @param shaderProgram - The shader program to inject the disable uniform into.
+ * @returns The modified shader program
+ */
+export function injectDisableUniform(shaderProgram) {
+    const shaderFragment = shaderProgram.fragment;
+    shaderFragment.uniform += "\nuniform bool _disabled_;";
+    for (let i = 0; i < shaderFragment.functions.length; ++i) {
+        const func = shaderFragment.functions[i];
+        if (func.name === shaderFragment.mainFunctionName) {
+            func.code = func.code.replace("{", `{\n    if (_disabled_) return texture2D(${shaderProgram.fragment.mainInputTexture}, vUV);\n`);
+            break;
+        }
+    }
+    return shaderProgram;
+}
+/**
+ * Gets the shader fragment code.
+ * @param shaderProgram - The shader program to extract the code from.
+ * @param mainCodeOnly - If true, only the main function code will be returned.
+ * @returns The shader fragment code.
+ */
+export function getShaderFragmentCode(shaderProgram, mainCodeOnly = false) {
+    var _a, _b;
+    const shaderFragment = shaderProgram.fragment;
+    const declarations = ((_a = shaderFragment.const) !== null && _a !== void 0 ? _a : "") +
+        "\n" +
+        shaderFragment.uniform +
+        "\n" +
+        ((_b = shaderFragment.uniformSingle) !== null && _b !== void 0 ? _b : "") +
+        "\n";
+    let mainFunctionCode = "";
+    let otherFunctionsCode = "";
+    for (let i = 0; i < shaderFragment.functions.length; ++i) {
+        const func = shaderFragment.functions[i];
+        if (func.name === shaderFragment.mainFunctionName) {
+            mainFunctionCode += func.code + "\n";
+            if (mainCodeOnly) {
+                break;
+            }
+        }
+        else {
+            otherFunctionsCode += func.code + "\n";
+        }
+    }
+    return mainCodeOnly ? mainFunctionCode : declarations + otherFunctionsCode + mainFunctionCode;
+}
+/**
+ * Gets the shader creation options from a shader program.
+ * @param shaderProgram - The shader program to build the create options from.
+ * @returns The shader creation options.
+ */
+export function getShaderCreateOptions(shaderProgram) {
+    var _a;
+    const shaderFragment = shaderProgram.fragment;
+    let code = getShaderFragmentCode(shaderProgram);
+    const uniforms = shaderFragment.uniform + "\n" + ((_a = shaderFragment.uniformSingle) !== null && _a !== void 0 ? _a : "");
+    const uniformNames = [];
+    const samplerNames = [];
+    const rx = new RegExp(`uniform\\s+(\\S+)\\s+(\\w+)\\s*;`, "g");
+    let match = rx.exec(uniforms);
+    while (match !== null) {
+        const varType = match[1];
+        const varName = match[2];
+        if (varType === "sampler2D" || varType === "sampler3D") {
+            samplerNames.push(varName);
+        }
+        else {
+            uniformNames.push(varName);
+        }
+        match = rx.exec(uniforms);
+    }
+    code =
+        "varying vec2 vUV;\n" +
+            code +
+            "\nvoid main(void) {\ngl_FragColor = " +
+            shaderFragment.mainFunctionName +
+            "(vUV);\n}";
+    const options = {
+        name: shaderFragment.mainFunctionName,
+        fragmentShader: code,
+        uniformNames: uniformNames,
+        samplerNames: samplerNames,
+    };
+    if (shaderProgram.vertex) {
+        options.vertexShader = shaderProgram.vertex;
+    }
+    return options;
+}
+/**
+ * Decorates a symbol (uniform, function or const) name.
+ * @param symbol - The symbol to decorate.
+ * @returns The decorated symbol.
+ */
+export function decorateSymbol(symbol) {
+    return decorateChar + symbol + decorateChar;
+}
+/**
+ * Undecorates a symbol (uniform, function or const) name.
+ * @param symbol - The symbol to undecorate.
+ * @returns The undecorated symbol. Throws an error if the symbol is not decorated.
+ */
+export function undecorateSymbol(symbol) {
+    if (symbol.charAt(0) !== decorateChar || symbol.charAt(symbol.length - 1) !== decorateChar) {
+        throw new Error(`undecorateSymbol: Invalid symbol name "${symbol}"`);
+    }
+    return symbol.substring(1, symbol.length - 1);
+}
+//# sourceMappingURL=shaderCodeUtils.js.map

package/dist/utils/shaderCodeUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shaderCodeUtils.js","sourceRoot":"","sources":["../../src/utils/shaderCodeUtils.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,GAAG,CAAC;AA0GhC;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAC,aAA4B;IAC7D,MAAM,cAAc,GAAG,aAAa,CAAC,QAAQ,CAAC;IAE9C,cAAc,CAAC,OAAO,IAAI,4BAA4B,CAAC;IAEvD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;QACvD,MAAM,IAAI,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC,CAAE,CAAC;QAC1C,IAAI,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;YAChD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CACzB,GAAG,EACH,2CAA2C,aAAa,CAAC,QAAQ,CAAC,gBAAgB,WAAW,CAChG,CAAC;YACF,MAAM;QACV,CAAC;IACL,CAAC;IAED,OAAO,aAAa,CAAC;AACzB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CAAC,aAA4B,EAAE,YAAY,GAAG,KAAK;;IACpF,MAAM,cAAc,GAAG,aAAa,CAAC,QAAQ,CAAC;IAE9C,MAAM,YAAY,GACd,CAAC,MAAA,cAAc,CAAC,KAAK,mCAAI,EAAE,CAAC;QAC5B,IAAI;QACJ,cAAc,CAAC,OAAO;QACtB,IAAI;QACJ,CAAC,MAAA,cAAc,CAAC,aAAa,mCAAI,EAAE,CAAC;QACpC,IAAI,CAAC;IAET,IAAI,gBAAgB,GAAG,EAAE,CAAC;IAC1B,IAAI,kBAAkB,GAAG,EAAE,CAAC;IAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;QACvD,MAAM,IAAI,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC,CAAE,CAAC;QAC1C,IAAI,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;YAChD,gBAAgB,IAAI,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;YACrC,IAAI,YAAY,EAAE,CAAC;gBACf,MAAM;YACV,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,kBAAkB,IAAI,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAC3C,CAAC;IACL,CAAC;IAED,OAAO,YAAY,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,YAAY,GAAG,kBAAkB,GAAG,gBAAgB,CAAC;AAClG,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CAAC,aAA4B;;IAC/D,MAAM,cAAc,GAAG,aAAa,CAAC,QAAQ,CAAC;IAE9C,IAAI,IAAI,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAAC;IAEhD,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,GAAG,IAAI,GAAG,CAAC,MAAA,cAAc,CAAC,aAAa,mCAAI,EAAE,CAAC,CAAC;IACtF,MAAM,YAAY,GAAG,EAAE,CAAC;IACxB,MAAM,YAAY,GAAG,EAAE,CAAC;IAExB,MAAM,EAAE,GAAG,IAAI,MAAM,CAAC,kCAAkC,EAAE,GAAG,CAAC,CAAC;IAE/D,IAAI,KAAK,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC9B,OAAO,KAAK,KAAK,IAAI,EAAE,CAAC;QACpB,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC;QAE1B,IAAI,OAAO,KAAK,WAAW,IAAI,OAAO,KAAK,WAAW,EAAE,CAAC;YACrD,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/B,CAAC;aAAM,CAAC;YACJ,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/B,CAAC;QAED,KAAK,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAED,IAAI;QACA,qBAAqB;YACrB,IAAI;YACJ,sCAAsC;YACtC,cAAc,CAAC,gBAAgB;YAC/B,WAAW,CAAC;IAEhB,MAAM,OAAO,GAA0B;QACnC,IAAI,EAAE,cAAc,CAAC,gBAAgB;QACrC,cAAc,EAAE,IAAI;QACpB,YAAY,EAAE,YAAY;QAC1B,YAAY,EAAE,YAAY;KAC7B,CAAC;IAEF,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC;QACvB,OAAO,CAAC,YAAY,GAAG,aAAa,CAAC,MAAM,CAAC;IAChD,CAAC;IAED,OAAO,OAAO,CAAC;AACnB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,MAAc;IACzC,OAAO,YAAY,GAAG,MAAM,GAAG,YAAY,CAAC;AAChD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAc;IAC3C,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,YAAY,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,YAAY,EAAE,CAAC;QACzF,MAAM,IAAI,KAAK,CAAC,0CAA0C,MAAM,GAAG,CAAC,CAAC;IACzE,CAAC;IAED,OAAO,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AAClD,CAAC"}

package/dist/utils/textureLoaders.d.ts

@@ -0,0 +1,14 @@
+import { ThinTexture } from "@babylonjs/core/Materials/Textures/thinTexture.js";
+import { type ThinEngine } from "@babylonjs/core/Engines/thinEngine.js";
+/**
+ * Helper that takes in a URL to an image and returns a ThinTexture
+ * @param engine - defines the engine to use to create the texture
+ * @param url - defines a value which contains one of the following:
+ * * A conventional http URL, e.g. 'http://...' or 'file://...'
+ * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
+ * @param flipY - Indicates if the Y axis should be flipped
+ * @param samplingMode - The sampling mode to use
+ * @returns A ThinTexture of the image
+ */
+export declare function createImageTexture(engine: ThinEngine, url: string, flipY?: boolean, samplingMode?: number | undefined): ThinTexture;
+//# sourceMappingURL=textureLoaders.d.ts.map

package/dist/utils/textureLoaders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"textureLoaders.d.ts","sourceRoot":"","sources":["../../src/utils/textureLoaders.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mDAAmD,CAAC;AAChF,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,uCAAuC,CAAC;AAExE;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAC9B,MAAM,EAAE,UAAU,EAClB,GAAG,EAAE,MAAM,EACX,KAAK,GAAE,OAAc,EACrB,YAAY,GAAE,MAAM,GAAG,SAAqB,GAC7C,WAAW,CAGb"}

package/dist/utils/textureLoaders.js

@@ -0,0 +1,22 @@
+import { ThinTexture } from "@babylonjs/core/Materials/Textures/thinTexture.js";
+import {} from "@babylonjs/core/Engines/thinEngine.js";
+/**
+ * Helper that takes in a URL to an image and returns a ThinTexture
+ * @param engine - defines the engine to use to create the texture
+ * @param url - defines a value which contains one of the following:
+ * * A conventional http URL, e.g. 'http://...' or 'file://...'
+ * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
+ * @param flipY - Indicates if the Y axis should be flipped
+ * @param samplingMode - The sampling mode to use
+ * @returns A ThinTexture of the image
+ */
+export function createImageTexture(engine, url, flipY = true, samplingMode = undefined) {
+    const internalTexture = engine.createTexture(url, true, flipY, null, samplingMode);
+    return new ThinTexture(internalTexture);
+}
+/*
+    Future util ideas:
+        HtmlElementTexture
+        WebCamTexture
+*/
+//# sourceMappingURL=textureLoaders.js.map

package/dist/utils/textureLoaders.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"textureLoaders.js","sourceRoot":"","sources":["../../src/utils/textureLoaders.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mDAAmD,CAAC;AAChF,OAAO,EAAmB,MAAM,uCAAuC,CAAC;AAExE;;;;;;;;;GASG;AACH,MAAM,UAAU,kBAAkB,CAC9B,MAAkB,EAClB,GAAW,EACX,QAAiB,IAAI,EACrB,eAAmC,SAAS;IAE5C,MAAM,eAAe,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IACnF,OAAO,IAAI,WAAW,CAAC,eAAe,CAAC,CAAC;AAC5C,CAAC;AAED;;;;EAIE"}

package/license.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Babylon.js
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -0,0 +1,47 @@
+{
+    "name": "@babylonjs/smart-filters",
+    "version": "0.1.0-alpha",
+    "description": "Babylon.js Smart Filter core and common block library",
+    "author": {
+        "name": "Sebastien VANDENBERGHE"
+    },
+    "keywords": [
+        "video",
+        "composition",
+        "3D",
+        "2D",
+        "javascript",
+        "html5",
+        "webgl",
+        "webgl2",
+        "webgpu",
+        "babylon"
+    ],
+    "license": "MIT",
+    "readme": "README.md",
+    "main": "dist/index",
+    "module": "dist/index",
+    "esnext": "dist/index",
+    "types": "dist/index",
+    "type": "module",
+    "sideEffects": false,
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/BabylonJS/SmartFilters.git"
+    },
+    "files": [
+        "dist",
+        "src",
+        "license.md",
+        "readme.md"
+    ],
+    "scripts": {
+        "clean": "rimraf dist && rimraf tsconfig.build.tsbuildinfo",
+        "versionUp": "node tools/versionUp.js",
+        "build": "tsc -p ./tsconfig.build.json",
+        "test": "echo \"Error: run test from the root of the monorepo\" && exit 1"
+    },
+    "peerDependencies": {
+        "@babylonjs/core": "^7.11.2"
+    }
+}