@babylonjs/smart-filters 1.0.13 → 8.19.0

package/src/serialization/importCustomBlockDefinition.ts

@@ -1,86 +1,86 @@
-import { ConnectionPointType } from "../connection/connectionPointType.js";
-import { hasGlslHeader, parseFragmentShader } from "../utils/buildTools/shaderConverter.js";
-import type { SerializedBlockDefinition } from "./serializedBlockDefinition.js";
-import type { SerializedShaderBlockDefinition } from "./serializedShaderBlockDefinition.js";
-import type { InputAutoBindV1, SerializedInputConnectionPointV1 } from "./v1/shaderBlockSerialization.types.js";
-
-/**
- * Imports a serialized custom block definition. Supports either serialized CustomShaderBlock definitions or
- * CustomAggregateBlock definitions. Can throw an exception if the serialized data is invalid.
- *
- * CustomShaderBlock definitions can be supplied either as serialized SerializedBlockDefinition object
- * or a glsl shader with the required annotations (see readme.md for details).
- *
- * CustomAggregateBlock definitions must be supplied as serialized SerializedBlockDefinition object.
- *
- * @param serializedData - The serialized data
- * @returns The serialized block definition
- */
-export function importCustomBlockDefinition(serializedData: string): SerializedBlockDefinition {
-    if (hasGlslHeader(serializedData)) {
-        return importAnnotatedGlsl(serializedData);
-    } else {
-        // Assume this is a serialized JSON object
-        const blockDefinition = JSON.parse(serializedData);
-
-        // Some old SmartFilters didn't have a format property - default to smartFilter if missing
-        if (blockDefinition.format === undefined) {
-            blockDefinition.format = "smartFilter";
-        }
-
-        // SmartFilters can be serialized without a blockType
-        // By convention, we use the SmartFilter name as the blockType when importing them as SerializedBlockDefinitions
-        if (blockDefinition.format === "smartFilter" && blockDefinition.name && !blockDefinition.blockType) {
-            blockDefinition.blockType = blockDefinition.name;
-        }
-
-        // Validation
-        if (!blockDefinition.blockType) {
-            throw new Error("Could not find a blockType");
-        }
-
-        return blockDefinition;
-    }
-}
-
-/**
- * Converts a fragment shader .glsl file to an SerializedBlockDefinition instance for use
- * as a CustomShaderBlock. The .glsl file must contain certain annotations to be imported.
- * See readme.md for more information.
- * @param fragmentShader - The contents of the .glsl fragment shader file
- * @returns The serialized block definition
- */
-function importAnnotatedGlsl(fragmentShader: string): SerializedShaderBlockDefinition {
-    const fragmentShaderInfo = parseFragmentShader(fragmentShader);
-
-    if (!fragmentShaderInfo.blockType) {
-        throw new Error("blockType must be defined");
-    }
-
-    // Calculate the input connection points
-    const inputConnectionPoints: SerializedInputConnectionPointV1[] = [];
-    for (const uniform of fragmentShaderInfo.uniforms) {
-        // Add to input connection point list
-        const inputConnectionPoint: SerializedInputConnectionPointV1 = {
-            name: uniform.name,
-            type: uniform.type,
-            autoBind: uniform.properties?.autoBind as InputAutoBindV1,
-        };
-        if (inputConnectionPoint.type !== ConnectionPointType.Texture && uniform.properties?.default !== undefined) {
-            inputConnectionPoint.defaultValue = uniform.properties.default;
-        }
-        inputConnectionPoints.push(inputConnectionPoint);
-    }
-
-    return {
-        format: "shaderBlockDefinition",
-        formatVersion: 1,
-        blockType: fragmentShaderInfo.blockType,
-        namespace: fragmentShaderInfo.namespace,
-        shaderProgram: {
-            fragment: fragmentShaderInfo.shaderCode,
-        },
-        inputConnectionPoints,
-        disableOptimization: !!fragmentShaderInfo.disableOptimization,
-    };
-}
+import { ConnectionPointType } from "../connection/connectionPointType.js";
+import { HasGlslHeader, ParseFragmentShader } from "../utils/buildTools/shaderConverter.js";
+import type { SerializedBlockDefinition } from "./serializedBlockDefinition.js";
+import type { SerializedShaderBlockDefinition } from "./serializedShaderBlockDefinition.js";
+import type { InputAutoBindV1, SerializedInputConnectionPointV1 } from "./v1/shaderBlockSerialization.types.js";
+
+/**
+ * Imports a serialized custom block definition. Supports either serialized CustomShaderBlock definitions or
+ * CustomAggregateBlock definitions. Can throw an exception if the serialized data is invalid.
+ *
+ * CustomShaderBlock definitions can be supplied either as serialized SerializedBlockDefinition object
+ * or a glsl shader with the required annotations (see readme.md for details).
+ *
+ * CustomAggregateBlock definitions must be supplied as serialized SerializedBlockDefinition object.
+ *
+ * @param serializedData - The serialized data
+ * @returns The serialized block definition
+ */
+export function ImportCustomBlockDefinition(serializedData: string): SerializedBlockDefinition {
+    if (HasGlslHeader(serializedData)) {
+        return ImportAnnotatedGlsl(serializedData);
+    } else {
+        // Assume this is a serialized JSON object
+        const blockDefinition = JSON.parse(serializedData);
+
+        // Some old SmartFilters didn't have a format property - default to smartFilter if missing
+        if (blockDefinition.format === undefined) {
+            blockDefinition.format = "smartFilter";
+        }
+
+        // SmartFilters can be serialized without a blockType
+        // By convention, we use the SmartFilter name as the blockType when importing them as SerializedBlockDefinitions
+        if (blockDefinition.format === "smartFilter" && blockDefinition.name && !blockDefinition.blockType) {
+            blockDefinition.blockType = blockDefinition.name;
+        }
+
+        // Validation
+        if (!blockDefinition.blockType) {
+            throw new Error("Could not find a blockType");
+        }
+
+        return blockDefinition;
+    }
+}
+
+/**
+ * Converts a fragment shader .glsl file to an SerializedBlockDefinition instance for use
+ * as a CustomShaderBlock. The .glsl file must contain certain annotations to be imported.
+ * See readme.md for more information.
+ * @param fragmentShader - The contents of the .glsl fragment shader file
+ * @returns The serialized block definition
+ */
+function ImportAnnotatedGlsl(fragmentShader: string): SerializedShaderBlockDefinition {
+    const fragmentShaderInfo = ParseFragmentShader(fragmentShader);
+
+    if (!fragmentShaderInfo.blockType) {
+        throw new Error("blockType must be defined");
+    }
+
+    // Calculate the input connection points
+    const inputConnectionPoints: SerializedInputConnectionPointV1[] = [];
+    for (const uniform of fragmentShaderInfo.uniforms) {
+        // Add to input connection point list
+        const inputConnectionPoint: SerializedInputConnectionPointV1 = {
+            name: uniform.name,
+            type: uniform.type,
+            autoBind: uniform.properties?.autoBind as InputAutoBindV1,
+        };
+        if (inputConnectionPoint.type !== ConnectionPointType.Texture && uniform.properties?.default !== undefined) {
+            inputConnectionPoint.defaultValue = uniform.properties.default;
+        }
+        inputConnectionPoints.push(inputConnectionPoint);
+    }
+
+    return {
+        format: "shaderBlockDefinition",
+        formatVersion: 1,
+        blockType: fragmentShaderInfo.blockType,
+        namespace: fragmentShaderInfo.namespace,
+        shaderProgram: {
+            fragment: fragmentShaderInfo.shaderCode,
+        },
+        inputConnectionPoints,
+        disableOptimization: !!fragmentShaderInfo.disableOptimization,
+    };
+}

package/src/serialization/index.ts

@@ -1,7 +1,10 @@
-export * from "./v1/index.js";
-export * from "./serializedSmartFilter.js";
-export * from "./smartFilterDeserializer.js";
-export * from "./smartFilterSerializer.js";
-export * from "./serializedShaderBlockDefinition.js";
-export * from "./serializedBlockDefinition.js";
-export * from "./importCustomBlockDefinition.js";
+/* eslint-disable import/no-internal-modules */
+export * from "./v1/index.js";
+export * from "./serializedSmartFilter.js";
+export * from "./smartFilterDeserializer.js";
+export * from "./smartFilterSerializer.js";
+export * from "./serializedShaderBlockDefinition.js";
+export * from "./serializedBlockDefinition.js";
+export * from "./importCustomBlockDefinition.js";
+// Back compat for when camelCase was used
+export { ImportCustomBlockDefinition as importCustomBlockDefinition } from "./importCustomBlockDefinition.js";

package/src/serialization/serializedBlockDefinition.ts

@@ -1,12 +1,12 @@
-import type { SerializedShaderBlockDefinition } from "./serializedShaderBlockDefinition";
-import type { SerializedSmartFilter } from "./serializedSmartFilter";
-
-/**
- * Type that represents any type of serialized block definition - shader or aggregate.
- */
-export type SerializedBlockDefinition = (SerializedShaderBlockDefinition | SerializedSmartFilter) & {
-    /**
-     * The type of block this is.
-     */
-    blockType: string;
-};
+import type { SerializedShaderBlockDefinition } from "./serializedShaderBlockDefinition.js";
+import type { SerializedSmartFilter } from "./serializedSmartFilter.js";
+
+/**
+ * Type that represents any type of serialized block definition - shader or aggregate.
+ */
+export type SerializedBlockDefinition = (SerializedShaderBlockDefinition | SerializedSmartFilter) & {
+    /**
+     * The type of block this is.
+     */
+    blockType: string;
+};

package/src/serialization/serializedShaderBlockDefinition.ts

@@ -1,7 +1,7 @@
-import type { SerializedShaderBlockDefinitionV1 } from "./v1/shaderBlockSerialization.types";
-
-/**
- * Type union of all versions of serialized SmartFilter block definitions
- * A block definition is an object which is used to create a CustomShaderBlock instance.
- */
-export type SerializedShaderBlockDefinition = SerializedShaderBlockDefinitionV1;
+import type { SerializedShaderBlockDefinitionV1 } from "./v1/shaderBlockSerialization.types.js";
+
+/**
+ * Type union of all versions of serialized SmartFilter block definitions
+ * A block definition is an object which is used to create a CustomShaderBlock instance.
+ */
+export type SerializedShaderBlockDefinition = SerializedShaderBlockDefinitionV1;

package/src/serialization/serializedSmartFilter.ts

@@ -1,6 +1,6 @@
-import type { SerializedSmartFilterV1 } from "./v1/smartFilterSerialization.types";
-
-/**
- * Type union of all versions of serialized SmartFilters
- */
-export type SerializedSmartFilter = SerializedSmartFilterV1;
+import type { SerializedSmartFilterV1 } from "./v1/smartFilterSerialization.types.js";
+
+/**
+ * Type union of all versions of serialized SmartFilters
+ */
+export type SerializedSmartFilter = SerializedSmartFilterV1;