TSL: Support defined color spaces in ColorSpaceNode (#1349)

* TSL: Support defined color spaces in ColorSpaceNode * Update three.js * Add src * Update patch and delete src * Add src * Update patch and delete src * Update declarations
three-types · Nov 10, 2024 · f868463 · f868463
1 parent 1d1f6cf
commit f868463
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 28 deletions.
diff --git a/src-testing/changes.patch b/src-testing/changes.patch
@@ -6705,10 +6705,10 @@ index 520a3c91..524d188c 100644
              } else {
                  bindings.push(instanceGroup);
 diff --git a/src-testing/src/renderers/common/nodes/NodeLibrary.ts b/src-testing/src/renderers/common/nodes/NodeLibrary.ts
-index 15931016..2128aa79 100644
+index b6738b95..9b23a37b 100644
 --- a/src-testing/src/renderers/common/nodes/NodeLibrary.ts
 +++ b/src-testing/src/renderers/common/nodes/NodeLibrary.ts
-@@ -1,4 +1,21 @@
+@@ -1,12 +1,28 @@
 +import { Material } from '../../../materials/Material.js';
 +import NodeMaterial from '../../../materials/nodes/NodeMaterial.js';
 +import { ToneMapping } from '../../../constants.js';
@@ -6725,13 +6725,11 @@ index 15931016..2128aa79 100644
 +        ToneMapping,
 +        (color: NodeRepresentation, exposure: NodeRepresentation) => ShaderNodeObject<Node>
 +    >;
-+    colorSpaceNodes: Map<ColorSpaceMethod, (color: NodeRepresentation) => ShaderNodeObject<Node>>;
 +
      constructor() {
          this.lightNodes = new WeakMap();
          this.materialNodes = new Map();
-@@ -6,8 +23,8 @@ class NodeLibrary {
-         this.colorSpaceNodes = new Map();
+         this.toneMappingNodes = new Map();
      }
 
 -    fromMaterial(material) {
@@ -6741,20 +6739,10 @@ index 15931016..2128aa79 100644
 
          let nodeMaterial = null;
 
-@@ -24,39 +41,52 @@ class NodeLibrary {
+@@ -23,31 +39,44 @@ class NodeLibrary {
          return nodeMaterial;
      }
 
--    addColorSpace(colorSpaceNode, colorSpace) {
-+    addColorSpace(colorSpaceNode: (color: NodeRepresentation) => ShaderNodeObject<Node>, colorSpace: ColorSpaceMethod) {
-         this.addType(colorSpaceNode, colorSpace, this.colorSpaceNodes);
-     }
-
--    getColorSpaceFunction(colorSpace) {
-+    getColorSpaceFunction(colorSpace: ColorSpaceMethod) {
-         return this.colorSpaceNodes.get(colorSpace) || null;
-     }
-
 -    addToneMapping(toneMappingNode, toneMapping) {
 +    addToneMapping(
 +        toneMappingNode: (color: NodeRepresentation, exposure: NodeRepresentation) => ShaderNodeObject<Node>,
@@ -6804,7 +6792,7 @@ index 15931016..2128aa79 100644
          if (library.has(type)) {
              console.warn(`Redefinition of node ${type}`);
              return;
-@@ -69,7 +99,11 @@ class NodeLibrary {
+@@ -60,7 +89,11 @@ class NodeLibrary {
          library.set(type, nodeClass);
      }
 

diff --git a/three.js b/three.js
diff --git a/types/three/src/nodes/display/ColorSpaceFunctions.d.ts b/types/three/src/nodes/display/ColorSpaceFunctions.d.ts
@@ -1,6 +1,6 @@
 import Node from "../core/Node.js";
 import { NodeRepresentation, ShaderNodeObject } from "../tsl/TSLCore.js";
 
-export const sRGBToLinearSRGB: (color: NodeRepresentation) => ShaderNodeObject<Node>;
+export const sRGBTransferEOTF: (color: NodeRepresentation) => ShaderNodeObject<Node>;
 
-export const linearSRGBTosRGB: (color: NodeRepresentation) => ShaderNodeObject<Node>;
+export const sRGBTransferOETF: (color: NodeRepresentation) => ShaderNodeObject<Node>;
diff --git a/types/three/src/nodes/display/ColorSpaceNode.d.ts b/types/three/src/nodes/display/ColorSpaceNode.d.ts
@@ -24,7 +24,7 @@ export default class ColorSpaceNode extends TempNode {
         target: string,
     );
 
-    getColorSpace(nodeBuilder: NodeBuilder, colorSpace: WorkingOrOutputColorSpace): string;
+    resolveColorSpace(nodeBuilder: NodeBuilder, colorSpace: WorkingOrOutputColorSpace): string;
 }
 
 export const toOutputColorSpace: (
@@ -43,6 +43,12 @@ export const colorSpaceToWorking: (
     colorSpace: string,
 ) => ShaderNodeObject<ColorSpaceNode>;
 
+export const convertColorSpace: (
+    node: NodeRepresentation,
+    sourceColorSpace: string,
+    targetColorSpace: string,
+) => ShaderNodeObject<ColorSpaceNode>;
+
 declare module "../tsl/TSLCore.js" {
     interface NodeElements {
         toOutputColorSpace: typeof toOutputColorSpace;

diff --git a/types/three/src/renderers/common/nodes/NodeLibrary.d.ts b/types/three/src/renderers/common/nodes/NodeLibrary.d.ts
@@ -3,7 +3,6 @@ import { Light } from "../../../lights/Light.js";
 import { Material } from "../../../materials/Material.js";
 import NodeMaterial from "../../../materials/nodes/NodeMaterial.js";
 import Node from "../../../nodes/core/Node.js";
-import { ColorSpaceMethod } from "../../../nodes/display/ColorSpaceNode.js";
 import AnalyticLightNode from "../../../nodes/lighting/AnalyticLightNode.js";
 import { NodeRepresentation, ShaderNodeObject } from "../../../nodes/tsl/TSLCore.js";
 declare class NodeLibrary {
@@ -19,14 +18,8 @@ declare class NodeLibrary {
         ToneMapping,
         (color: NodeRepresentation, exposure: NodeRepresentation) => ShaderNodeObject<Node>
     >;
-    colorSpaceNodes: Map<ColorSpaceMethod, (color: NodeRepresentation) => ShaderNodeObject<Node>>;
     constructor();
     fromMaterial(material: Material): Material | null;
-    addColorSpace(
-        colorSpaceNode: (color: NodeRepresentation) => ShaderNodeObject<Node>,
-        colorSpace: ColorSpaceMethod,
-    ): void;
-    getColorSpaceFunction(colorSpace: ColorSpaceMethod): ((color: NodeRepresentation) => ShaderNodeObject<Node>) | null;
     addToneMapping(
         toneMappingNode: (color: NodeRepresentation, exposure: NodeRepresentation) => ShaderNodeObject<Node>,
         toneMapping: ToneMapping,
+3 −3		.github/workflows/codeql-code-scanning.yml
+407 −311		build/three.cjs
+407 −311		build/three.module.js
+1 −1		build/three.module.min.js
+386 −315		build/three.webgpu.js
+1 −1		build/three.webgpu.min.js
+386 −315		build/three.webgpu.nodes.js
+1 −1		build/three.webgpu.nodes.min.js
+6 −1		docs/api/en/core/BufferGeometry.html
+0 −3		examples/jsm/tsl/display/BloomNode.js
+16 −16		examples/jsm/tsl/display/DenoiseNode.js
+3 −2		examples/jsm/tsl/display/GTAONode.js
+29 −6		src/core/BufferGeometry.js
+0 −1		src/math/ColorManagement.js
+5 −5		src/nodes/display/ColorSpaceFunctions.js
+27 −39		src/nodes/display/ColorSpaceNode.js
+43 −2		src/nodes/utils/PostProcessingUtils.js
+0 −13		src/renderers/common/nodes/NodeLibrary.js
+0 −8		src/renderers/webgpu/nodes/BasicNodeLibrary.js
+0 −8		src/renderers/webgpu/nodes/StandardNodeLibrary.js