@onerjs/smart-filters 8.25.2 → 8.25.3

package/dist/serialization/v1/defaultBlockSerializer.d.ts

@@ -0,0 +1,9 @@
+import type { SerializeBlockV1 } from "./smartFilterSerialization.types.js";
+/**
+ * The default V1 block serializer which can be used for any block that relies only on ConnectionPoints
+ * and does not have any constructor parameters or class properties that need to be serialized.
+ * @param block - The block to serialize
+ * @returns The serialized block
+ */
+export declare const DefaultBlockSerializer: SerializeBlockV1;
+//# sourceMappingURL=defaultBlockSerializer.d.ts.map

package/dist/serialization/v1/defaultBlockSerializer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultBlockSerializer.d.ts","sourceRoot":"","sources":["../../../src/serialization/v1/defaultBlockSerializer.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAsB,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AAEhG;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,EAAE,gBAUpC,CAAC"}

package/dist/serialization/v1/defaultBlockSerializer.js

@@ -0,0 +1,19 @@
+import { ShaderBlock } from "../../blockFoundation/shaderBlock.js";
+/**
+ * The default V1 block serializer which can be used for any block that relies only on ConnectionPoints
+ * and does not have any constructor parameters or class properties that need to be serialized.
+ * @param block - The block to serialize
+ * @returns The serialized block
+ */
+export const DefaultBlockSerializer = (block) => {
+    return {
+        name: block.name,
+        uniqueId: block.uniqueId,
+        blockType: block.blockType,
+        namespace: block.namespace,
+        comments: block.comments,
+        data: undefined,
+        outputTextureOptions: block instanceof ShaderBlock ? block.outputTextureOptions : undefined,
+    };
+};
+//# sourceMappingURL=defaultBlockSerializer.js.map

package/dist/serialization/v1/defaultBlockSerializer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultBlockSerializer.js","sourceRoot":"","sources":["../../../src/serialization/v1/defaultBlockSerializer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAC;AAInE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAqB,CAAC,KAAgB,EAAsB,EAAE;IAC7F,OAAO;QACH,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,IAAI,EAAE,SAAS;QACf,oBAAoB,EAAE,KAAK,YAAY,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS;KAC9F,CAAC;AACN,CAAC,CAAC"}

package/dist/serialization/v1/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./defaultBlockSerializer.js";
+export { DefaultBlockSerializer as defaultBlockSerializer } from "./defaultBlockSerializer.js";
+export * from "./smartFilterSerialization.types.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/serialization/v1/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/serialization/v1/index.ts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAC;AAE5C,OAAO,EAAE,sBAAsB,IAAI,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAC/F,cAAc,qCAAqC,CAAC"}

package/dist/serialization/v1/index.js

@@ -0,0 +1,5 @@
+export * from "./defaultBlockSerializer.js";
+// Back compat for when camelCase was used
+export { DefaultBlockSerializer as defaultBlockSerializer } from "./defaultBlockSerializer.js";
+export * from "./smartFilterSerialization.types.js";
+//# sourceMappingURL=index.js.map

package/dist/serialization/v1/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/serialization/v1/index.ts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAC;AAC5C,0CAA0C;AAC1C,OAAO,EAAE,sBAAsB,IAAI,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAC/F,cAAc,qCAAqC,CAAC"}

package/dist/serialization/v1/shaderBlockSerialization.types.d.ts

@@ -0,0 +1,73 @@
+/**
+ * ----------------------------------------------------------------------------
+ * Data Types Used For Block Serialization
+ * ----------------------------------------------------------------------------
+ */
+import type { Nullable } from "@onerjs/core/types.js";
+import type { AllConnectionPointTypes, ConnectionPointValue } from "../../connection/connectionPointType.js";
+import type { ShaderProgram } from "../../utils/shaderCodeUtils.js";
+/**
+ * The V1 definition of a serialized shader block. This block definition is loaded by a CustomShaderBlock and defines how a
+ * blockType works. This should not be confused with an ISerializedBockV1, which is a serialized instance of a block in a
+ * serialized SmartFilter graph. It is referenced by blockType in a serialized SmartFilter.
+ */
+export type SerializedShaderBlockDefinitionV1 = {
+    /**
+     * Which type of serialized data this is.
+     */
+    format: "shaderBlockDefinition";
+    /**
+     * The version of the block definition format (format of the serialized data, not the version of the block definition itself).
+     */
+    formatVersion: 1;
+    /**
+     * The type used to refer to the block in serialized SmartFilters and in the editor UI.
+     * The application doing the deserialization will use this to instantiate the correct block definition.
+     * Block types are expected to be unique and their behavior should be semantically equivalent across implementations
+     * (their results must be similar enough that the differences are not perceivable).
+     */
+    blockType: string;
+    /**
+     * The namespace of the block, which is used to reduce name collisions between blocks and also to group blocks in the editor UI.
+     * By convention, sub namespaces are separated by a period (e.g. "Babylon.Demo.Effects").
+     */
+    namespace: Nullable<string>;
+    /**
+     * The shader program for the block.
+     */
+    shaderProgram: ShaderProgram;
+    /**
+     * The input connection points of the block.
+     */
+    inputConnectionPoints: SerializedInputConnectionPointV1[];
+    /**
+     * If true, the optimizer will not attempt to optimize this block.
+     */
+    disableOptimization: boolean;
+};
+/**
+ * Possible V1 auto bind values for input connection points.
+ */
+export type InputAutoBindV1 = "outputResolution" | "outputAspectRatio";
+/**
+ * A V1 input connection point of a serialized block definition.
+ */
+export type SerializedInputConnectionPointV1<U extends AllConnectionPointTypes = AllConnectionPointTypes> = {
+    /**
+     * The name of the connection point.
+     */
+    name: string;
+    /**
+     * The type of the connection point.
+     */
+    type: U;
+    /**
+     * The optional default value of the connection point.
+     */
+    defaultValue?: ConnectionPointValue<U>;
+    /**
+     * If supplied, the input will be automatically bound to this value, instead of creating an input connection point.
+     */
+    autoBind?: InputAutoBindV1;
+};
+//# sourceMappingURL=shaderBlockSerialization.types.d.ts.map

package/dist/serialization/v1/shaderBlockSerialization.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shaderBlockSerialization.types.d.ts","sourceRoot":"","sources":["../../../src/serialization/v1/shaderBlockSerialization.types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,8BAAsB;AAC9C,OAAO,KAAK,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAC;AAC7G,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAEpE;;;;GAIG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC5C;;OAEG;IACH,MAAM,EAAE,uBAAuB,CAAC;IAEhC;;OAEG;IACH,aAAa,EAAE,CAAC,CAAC;IAEjB;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAE5B;;OAEG;IACH,aAAa,EAAE,aAAa,CAAC;IAE7B;;OAEG;IACH,qBAAqB,EAAE,gCAAgC,EAAE,CAAC;IAE1D;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,kBAAkB,GAAG,mBAAmB,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,gCAAgC,CAAC,CAAC,SAAS,uBAAuB,GAAG,uBAAuB,IAAI;IACxG;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC;IAER;;OAEG;IACH,YAAY,CAAC,EAAE,oBAAoB,CAAC,CAAC,CAAC,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,EAAE,eAAe,CAAC;CAC9B,CAAC"}

package/dist/serialization/v1/shaderBlockSerialization.types.js

@@ -0,0 +1,7 @@
+/**
+ * ----------------------------------------------------------------------------
+ * Data Types Used For Block Serialization
+ * ----------------------------------------------------------------------------
+ */
+export {};
+//# sourceMappingURL=shaderBlockSerialization.types.js.map

package/dist/serialization/v1/shaderBlockSerialization.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shaderBlockSerialization.types.js","sourceRoot":"","sources":["../../../src/serialization/v1/shaderBlockSerialization.types.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}

package/dist/serialization/v1/smartFilterSerialization.types.d.ts

@@ -0,0 +1,98 @@
+import type { Nullable } from "@onerjs/core/types.js";
+import type { BaseBlock } from "../../blockFoundation/baseBlock.js";
+import type { SmartFilter } from "../../smartFilter.js";
+import type { ThinEngine } from "@onerjs/core/Engines/thinEngine.js";
+import type { IEditorData } from "shared-ui-components/nodeGraphSystem/interfaces/nodeLocationInfo.js";
+import type { SmartFilterDeserializer } from "../smartFilterDeserializer.js";
+import type { OutputTextureOptions } from "../../blockFoundation/textureOptions.js";
+/**
+ * ----------------------------------------------------------------------------
+ * Serialized Data Types
+ * ----------------------------------------------------------------------------
+ */
+/**
+ * V1 Serialized Smart Filter
+ */
+export type SerializedSmartFilterV1 = {
+    /** Which type of serialized data this is. */
+    format: "smartFilter";
+    /** The format version of the serialized data (not the version of the SmartFilter itself).*/
+    formatVersion: 1;
+    /** The SmartFilter name */
+    name: string;
+    /** The namespace of the SmartFilter */
+    namespace: Nullable<string>;
+    /** The SmartFilter comments */
+    comments: Nullable<string>;
+    /** The editor data for the SmartFilter */
+    editorData: Nullable<IEditorData>;
+    /** The serialized blocks */
+    blocks: ISerializedBlockV1[];
+    /** The serialized connections */
+    connections: ISerializedConnectionV1[];
+};
+/**
+ * V1 format of a block in a serialized Smart Filter.
+ * Not to be confused with a SerializedBlockDefinitionV1 which serializes the definition of a CustomShaderBlock.
+ */
+export interface ISerializedBlockV1 {
+    /** The name of the block */
+    name: string;
+    /** The namespace of the block */
+    namespace: Nullable<string>;
+    /** The unique ID of the block - correlates with the ID in the editorData for block position, etc. */
+    uniqueId: number;
+    /** The blockType of the block - used to determine how to instantiate the block during deserialization */
+    blockType: string;
+    /** The comments for the block */
+    comments: Nullable<string>;
+    /** The OutputTextureOptions for serialized ShaderBlocks */
+    outputTextureOptions?: OutputTextureOptions;
+    /** Block specific serialized data */
+    data: any;
+}
+/**
+ * V1 Serialized Connection
+ */
+export interface ISerializedConnectionV1 {
+    /** The uniqueId of the block that the connection is to */
+    outputBlock: number;
+    /** The name of the connectionPoint on the outputBlock */
+    outputConnectionPoint: string;
+    /** The uniqueId of the block that the connection is from */
+    inputBlock: number;
+    /** The name of the connectionPoint on the inputBlock */
+    inputConnectionPoint: string;
+}
+/**
+ * ----------------------------------------------------------------------------
+ * Serializer Types
+ * ----------------------------------------------------------------------------
+ */
+/**
+ * A function that serializes a block to a V1 serialized block object
+ */
+export type SerializeBlockV1 = (block: BaseBlock) => ISerializedBlockV1;
+/**
+ * A V1 serializer for blocks in a SmartFilter
+ */
+export interface IBlockSerializerV1 {
+    /** The blockType of the block that this serializer can serialize */
+    blockType: string;
+    /** The function that serializes the block in the Smart Filter */
+    serialize: SerializeBlockV1;
+}
+/**
+ * ----------------------------------------------------------------------------
+ * Deserializer Types
+ * ----------------------------------------------------------------------------
+ */
+/**
+ * A function that deserializes a V1 block in a SmartFilter
+ */
+export type DeserializeBlockV1 = (smartFilter: SmartFilter, serializedBlock: ISerializedBlockV1, engine: ThinEngine, smartFilterDeserializer: SmartFilterDeserializer) => Promise<BaseBlock>;
+/**
+ * A function that optionally deserializes a block from a V1 serialized block object, returning null if it cannot
+ */
+export type OptionalBlockDeserializerV1 = (smartFilter: SmartFilter, serializedBlock: ISerializedBlockV1, engine: ThinEngine) => Promise<Nullable<BaseBlock>>;
+//# sourceMappingURL=smartFilterSerialization.types.d.ts.map

package/dist/serialization/v1/smartFilterSerialization.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"smartFilterSerialization.types.d.ts","sourceRoot":"","sources":["../../../src/serialization/v1/smartFilterSerialization.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,8BAAsB;AAC9C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oCAAoC,CAAC;AACpE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,KAAK,EAAE,UAAU,EAAE,2CAAmC;AAC7D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qEAAqE,CAAC;AACvG,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AAC7E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAC;AAEpF;;;;GAIG;AAEH;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IAClC,6CAA6C;IAC7C,MAAM,EAAE,aAAa,CAAC;IAEtB,4FAA4F;IAC5F,aAAa,EAAE,CAAC,CAAC;IAEjB,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAC;IAEb,uCAAuC;IACvC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAE5B,+BAA+B;IAC/B,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAE3B,0CAA0C;IAC1C,UAAU,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;IAElC,4BAA4B;IAC5B,MAAM,EAAE,kBAAkB,EAAE,CAAC;IAE7B,iCAAiC;IACjC,WAAW,EAAE,uBAAuB,EAAE,CAAC;CAC1C,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAC/B,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAC;IAEb,iCAAiC;IACjC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAE5B,qGAAqG;IACrG,QAAQ,EAAE,MAAM,CAAC;IAEjB,yGAAyG;IACzG,SAAS,EAAE,MAAM,CAAC;IAElB,iCAAiC;IACjC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAE3B,2DAA2D;IAC3D,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAE5C,qCAAqC;IACrC,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC,0DAA0D;IAC1D,WAAW,EAAE,MAAM,CAAC;IAEpB,yDAAyD;IACzD,qBAAqB,EAAE,MAAM,CAAC;IAE9B,4DAA4D;IAC5D,UAAU,EAAE,MAAM,CAAC;IAEnB,wDAAwD;IACxD,oBAAoB,EAAE,MAAM,CAAC;CAChC;AAED;;;;GAIG;AAEH;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,KAAK,EAAE,SAAS,KAAK,kBAAkB,CAAC;AAExE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,oEAAoE;IACpE,SAAS,EAAE,MAAM,CAAC;IAElB,iEAAiE;IACjE,SAAS,EAAE,gBAAgB,CAAC;CAC/B;AAED;;;;GAIG;AAEH;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAC7B,WAAW,EAAE,WAAW,EACxB,eAAe,EAAE,kBAAkB,EACnC,MAAM,EAAE,UAAU,EAClB,uBAAuB,EAAE,uBAAuB,KAC/C,OAAO,CAAC,SAAS,CAAC,CAAC;AAExB;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC"}

package/dist/serialization/v1/smartFilterSerialization.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=smartFilterSerialization.types.js.map

package/dist/serialization/v1/smartFilterSerialization.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"smartFilterSerialization.types.js","sourceRoot":"","sources":["../../../src/serialization/v1/smartFilterSerialization.types.ts"],"names":[],"mappings":""}

package/dist/smartFilter.d.ts

@@ -0,0 +1,118 @@
+import type { ThinEngine } from "@onerjs/core/Engines/thinEngine.js";
+import type { Nullable } from "@onerjs/core/types.js";
+import type { SmartFilterRuntime } from "./runtime/smartFilterRuntime.js";
+import type { BaseBlock } from "./blockFoundation/baseBlock.js";
+import type { ConnectionPointType } from "./connection/connectionPointType.js";
+import type { ConnectionPoint } from "./connection/connectionPoint.js";
+import { OutputBlock } from "./blockFoundation/outputBlock.js";
+import { InternalSmartFilterRuntime } from "./runtime/smartFilterRuntime.js";
+import { RenderTargetGenerator } from "./runtime/renderTargetGenerator.js";
+import type { IEditorData } from "shared-ui-components/nodeGraphSystem/interfaces/nodeLocationInfo.js";
+import type { IDisposable } from "./IDisposable.js";
+/**
+ * Data passed to the initialize function of the blocks.
+ */
+export type InitializationData = {
+    /**
+     * The current smart filter runtime the block is being initialized for.
+     */
+    readonly runtime: InternalSmartFilterRuntime;
+    /**
+     * The output block of the smart filter.
+     * This is used to determine if a block is linked to the output block so that we can prevent an
+     * extra render pass.
+     */
+    readonly outputBlock: OutputBlock;
+    /**
+     * The list of promises to wait for during the initialization step.
+     */
+    readonly initializationPromises: Promise<void>[];
+    /**
+     * Resources that need to be disposed when the runtime is disposed.
+     */
+    readonly disposableResources: IDisposable[];
+};
+/**
+ * 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 declare class SmartFilter {
+    /**
+     * The friendly name of the smart filter.
+     */
+    readonly name: string;
+    /**
+     * The namespace of the smart filter.
+     */
+    readonly namespace: Nullable<string>;
+    /**
+     * The smart filter output (input connection point of the output block...).
+     *
+     * This is where the smart filter final block should be connected to in order to be visible on screen.
+     */
+    readonly output: ConnectionPoint<ConnectionPointType.Texture>;
+    /**
+     * The output block of the smart filter.
+     */
+    readonly outputBlock: OutputBlock;
+    /**
+     * User defined comments to describe the current smart filter.
+     */
+    comments: Nullable<string>;
+    /**
+     * Data used by the smart filter editor.
+     */
+    editorData: Nullable<IEditorData>;
+    private readonly _attachedBlocks;
+    /**
+     * Creates a new instance of a @see SmartFilter.
+     * @param name - The friendly name of the smart filter
+     * @param namespace - The namespace of the smart filter
+     */
+    constructor(name: string, namespace?: Nullable<string>);
+    /**
+     * @returns the list of blocks attached to the smart filter.
+     */
+    get attachedBlocks(): ReadonlyArray<BaseBlock>;
+    /**
+     * @returns The current class name of the smart filter.
+     */
+    getClassName(): string;
+    /**
+     * 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: BaseBlock): void;
+    /**
+     * 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: BaseBlock): void;
+    private _generateCommandsAndGatherInitPromises;
+    /**
+     * 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
+     */
+    createRuntimeAsync(engine: ThinEngine, renderTargetGenerator?: RenderTargetGenerator): Promise<SmartFilterRuntime>;
+    /**
+     * Resizes any intermediate textures according to the new size of the render target
+     * @param engine - The engine used to render the smart filter
+     */
+    resize(engine: ThinEngine): void;
+    /**
+     * @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: () => void): void;
+}
+//# sourceMappingURL=smartFilter.d.ts.map

package/dist/smartFilter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"smartFilter.d.ts","sourceRoot":"","sources":["../src/smartFilter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,2CAAmC;AAC7D,OAAO,KAAK,EAAE,QAAQ,EAAE,8BAAsB;AAC9C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gCAAgC,CAAC;AAChE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC/E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAC/D,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAE3E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qEAAqE,CAAC;AACvG,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAUpD;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC7B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,0BAA0B,CAAC;IAE7C;;;;OAIG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,sBAAsB,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;IAEjD;;OAEG;IACH,QAAQ,CAAC,mBAAmB,EAAE,WAAW,EAAE,CAAC;CAC/C,CAAC;AAEF;;;;;;GAMG;AACH,qBAAa,WAAW;IACpB;;OAEG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,SAAgB,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAE5C;;;;OAIG;IACH,SAAgB,MAAM,EAAE,eAAe,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAErE;;OAEG;IACH,SAAgB,WAAW,EAAE,WAAW,CAAC;IAEzC;;OAEG;IACI,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAQ;IAEzC;;OAEG;IACI,UAAU,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAQ;IAEhD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAmB;IACnD;;;;OAIG;gBACS,IAAI,EAAE,MAAM,EAAE,SAAS,GAAE,QAAQ,CAAC,MAAM,CAAQ;IAS5D;;OAEG;IACH,IAAW,cAAc,IAAI,aAAa,CAAC,SAAS,CAAC,CAEpD;IAED;;OAEG;IACI,YAAY,IAAI,MAAM;IAI7B;;;;;OAKG;IACI,aAAa,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;IAe5C;;;;;OAKG;IACI,WAAW,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;IAc1C,OAAO,CAAC,sCAAsC;IAQ9C;;;;;OAKG;IACU,kBAAkB,CAAC,MAAM,EAAE,UAAU,EAAE,qBAAqB,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAsC/H;;;OAGG;IACI,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI;IAevC;;;;OAIG;IACI,2BAA2B,CAAC,IAAI,EAAE,MAAM,IAAI,GAAG,IAAI;CAoB7D"}

package/dist/smartFilter.js

@@ -0,0 +1,169 @@
+import { OutputBlock } from "./blockFoundation/outputBlock.js";
+import { InternalSmartFilterRuntime } from "./runtime/smartFilterRuntime.js";
+import { RenderTargetGenerator } from "./runtime/renderTargetGenerator.js";
+import { AggregateBlock } from "./blockFoundation/aggregateBlock.js";
+import { ShaderBlock } from "./blockFoundation/shaderBlock.js";
+import { GetBlockOutputTextureSize } from "./utils/textureUtils.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
+     * @param namespace - The namespace of the smart filter
+     */
+    constructor(name, namespace = null) {
+        /**
+         * User defined comments to describe the current smart filter.
+         */
+        this.comments = null;
+        /**
+         * Data used by the smart filter editor.
+         */
+        this.editorData = null;
+        this.name = name;
+        this.namespace = namespace;
+        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) => {
+            block.generateCommandsAndGatherInitPromises(initializationData, outputBlock.input.connectedTo?.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: [],
+            disposableResources: [],
+        };
+        this._workWithAggregateFreeGraph(() => {
+            this.outputBlock.prepareForRuntime();
+            renderTargetGenerator = 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));
+            // eslint-disable-next-line github/no-then
+            const initializationPromises = Promise.all(initializationData.initializationPromises).then(() => false);
+            const timedOut = await Promise.race([initializationPromises, timeoutPromise]);
+            if (timedOut) {
+                throw new Error("Initialization promises timed out");
+            }
+        }
+        // Register the resources to dispose when the runtime is disposed
+        initializationData.disposableResources.forEach((resource) => runtime.registerResource(resource));
+        return runtime;
+    }
+    /**
+     * Resizes any intermediate textures according to the new size of the render target
+     * @param engine - The engine used to render the smart filter
+     */
+    resize(engine) {
+        this._workWithAggregateFreeGraph(() => {
+            this.outputBlock.visit({}, (block) => {
+                if (!(block instanceof ShaderBlock)) {
+                    return;
+                }
+                if (block.output.runtimeData?.value) {
+                    const size = GetBlockOutputTextureSize(this, engine, block.outputTextureOptions);
+                    block.output.runtimeData.value.resize(size);
+                }
+            });
+        });
+    }
+    /**
+     * @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);
+            }
+        });
+        try {
+            // Do the passed in work
+            work();
+        }
+        finally {
+            // Restore all aggregate blocks, even if work throws
+            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,kCAAkC,CAAC;AAC/D,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,OAAO,EAAE,cAAc,EAAE,MAAM,qCAAqC,CAAC;AAGrE,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAE/D,OAAO,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAC;AAEpE;;GAEG;AACH,MAAM,qBAAqB,GAAG,KAAK,CAAC;AA6BpC;;;;;;GAMG;AACH,MAAM,OAAO,WAAW;IAkCpB;;;;OAIG;IACH,YAAY,IAAY,EAAE,YAA8B,IAAI;QAhB5D;;WAEG;QACI,aAAQ,GAAqB,IAAI,CAAC;QAEzC;;WAEG;QACI,eAAU,GAA0B,IAAI,CAAC;QAS5C,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,IAAI,CAAC,eAAe,GAAG,IAAI,KAAK,EAAa,CAAC;QAC9C,IAAI,CAAC,WAAW,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;IACzC,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,WAAW,CAAC;QAErC,WAAW,CAAC,KAAK,CAAC,kBAAkB,EAAE,CAAC,KAAgB,EAAE,kBAAsC,EAAE,EAAE;YAC/F,KAAK,CAAC,qCAAqC,CAAC,kBAAkB,EAAE,WAAW,CAAC,KAAK,CAAC,WAAW,EAAE,UAAU,KAAK,KAAK,CAAC,CAAC;QACzH,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,kBAAkB,CAAC,MAAkB,EAAE,qBAA6C;QAC7F,MAAM,OAAO,GAAG,IAAI,0BAA0B,CAAC,MAAM,CAAC,CAAC;QAEvD,MAAM,kBAAkB,GAAuB;YAC3C,OAAO;YACP,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,sBAAsB,EAAE,EAAE;YAC1B,mBAAmB,EAAE,EAAE;SAC1B,CAAC;QAEF,IAAI,CAAC,2BAA2B,CAAC,GAAG,EAAE;YAClC,IAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC;YAErC,qBAAqB,GAAG,qBAAqB,IAAI,IAAI,qBAAqB,CAAC,KAAK,CAAC,CAAC;YAClF,qBAAqB,CAAC,iBAAiB,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;YAElE,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE,CAAC;YAExC,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,0CAA0C;YAC1C,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,iEAAiE;QACjE,kBAAkB,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC;QAEjG,OAAO,OAAO,CAAC;IACnB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAkB;QAC5B,IAAI,CAAC,2BAA2B,CAAC,GAAG,EAAE;YAClC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,KAAgB,EAAE,EAAE;gBAC5C,IAAI,CAAC,CAAC,KAAK,YAAY,WAAW,CAAC,EAAE,CAAC;oBAClC,OAAO;gBACX,CAAC;gBAED,IAAI,KAAK,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,EAAE,CAAC;oBAClC,MAAM,IAAI,GAAG,yBAAyB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;oBAChF,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,KAAiC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC7E,CAAC;YACL,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACI,2BAA2B,CAAC,IAAgB;QAC/C,MAAM,qBAAqB,GAAqB,EAAE,CAAC;QAEnD,6BAA6B;QAC7B,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,KAAgB,EAAE,UAAkB,EAAE,EAAE;YAChE,IAAI,KAAK,YAAY,cAAc,EAAE,CAAC;gBAClC,KAAK,CAAC,qBAAqB,CAAC,qBAAqB,CAAC,CAAC;YACvD,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC;YACD,wBAAwB;YACxB,IAAI,EAAE,CAAC;QACX,CAAC;gBAAS,CAAC;YACP,oDAAoD;YACpD,KAAK,MAAM,KAAK,IAAI,qBAAqB,EAAE,CAAC;gBACxC,KAAK,CAAC,uBAAuB,EAAE,CAAC;YACpC,CAAC;QACL,CAAC;IACL,CAAC;CACJ"}

package/dist/utils/buildTools/buildShaders.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Builds all .glsl files under <shaderPath>.
+ * @param shaderPath - The path to the shaders to watch
+ * @param smartFiltersCorePath - The path to import the Smart Filters core from
+ * @param babylonCorePath - The path to import the Babylon core from (optional)
+ * @example node buildShaders.js <shaderPath> @babylonjs/smart-filters
+ */
+export {};
+//# sourceMappingURL=buildShaders.d.ts.map

package/dist/utils/buildTools/buildShaders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildShaders.d.ts","sourceRoot":"","sources":["../../../src/utils/buildTools/buildShaders.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}

package/dist/utils/buildTools/buildShaders.js

@@ -0,0 +1,13 @@
+/**
+ * Builds all .glsl files under <shaderPath>.
+ * @param shaderPath - The path to the shaders to watch
+ * @param smartFiltersCorePath - The path to import the Smart Filters core from
+ * @param babylonCorePath - The path to import the Babylon core from (optional)
+ * @example node buildShaders.js <shaderPath> @babylonjs/smart-filters
+ */
+import { ConvertShaders } from "./convertShaders.js";
+const ExternalArguments = process.argv.slice(2);
+if (ExternalArguments.length >= 2 && ExternalArguments[0] && ExternalArguments[1]) {
+    ConvertShaders(ExternalArguments[0], ExternalArguments[1], ExternalArguments[2]);
+}
+//# sourceMappingURL=buildShaders.js.map

package/dist/utils/buildTools/buildShaders.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildShaders.js","sourceRoot":"","sources":["../../../src/utils/buildTools/buildShaders.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,MAAM,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAChD,IAAI,iBAAiB,CAAC,MAAM,IAAI,CAAC,IAAI,iBAAiB,CAAC,CAAC,CAAC,IAAI,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC;IAChF,cAAc,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;AACrF,CAAC"}

package/dist/utils/buildTools/convertGlslIntoBlock.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Converts a single shader to a .ts file which exports a Smart Filter block
+ * @param fragmentShaderPath - The path to the fragment file for the shader
+ * @param smartFiltersCorePath - The path to import the Smart Filters core from
+ * @param babylonCorePath - The path to import the Babylon core from (optional)
+
+ */
+export declare function ConvertGlslIntoBlock(fragmentShaderPath: string, smartFiltersCorePath: string, babylonCorePath?: string): void;
+//# sourceMappingURL=convertGlslIntoBlock.d.ts.map

package/dist/utils/buildTools/convertGlslIntoBlock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"convertGlslIntoBlock.d.ts","sourceRoot":"","sources":["../../../src/utils/buildTools/convertGlslIntoBlock.ts"],"names":[],"mappings":"AAsJA;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,kBAAkB,EAAE,MAAM,EAAE,oBAAoB,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAwK7H"}