Merge pull request #19156 from marcofugaro/translucency-update

Clean up Translucency.js

examples/jsm/shaders/TranslucentShader.js

@@ -3,7 +3,7 @@
  *
  * ------------------------------------------------------------------------------------------
  * Subsurface Scattering shader
- * Base on GDC 2011 – Approximating Translucency for a Fast, Cheap and Convincing Subsurface Scattering Look
+ * Based on GDC 2011 – Approximating Translucency for a Fast, Cheap and Convincing Subsurface Scattering Look
  * https://colinbarrebrisebois.com/2011/03/07/gdc-2011-approximating-translucency-for-a-fast-cheap-and-convincing-subsurface-scattering-look/
  *------------------------------------------------------------------------------------------
  */
@@ -11,24 +11,24 @@
 import {
 	Color,
 	ShaderChunk,
-	UniformsLib,
-	UniformsUtils
+	UniformsUtils,
+	ShaderLib
 } from "../../../build/three.module.js";
 
+function replaceAll( string, find, replace ) {
+
+	return string.split( find ).join( replace );
+
+}
+
+var meshphong_frag_head = ShaderChunk[ "meshphong_frag" ].slice( 0, ShaderChunk[ "meshphong_frag" ].indexOf( 'void main() {' ) );
+var meshphong_frag_body = ShaderChunk[ "meshphong_frag" ].slice( ShaderChunk[ "meshphong_frag" ].indexOf( 'void main() {' ) );
+
 var TranslucentShader = {
 
 	uniforms: UniformsUtils.merge( [
-
-		UniformsLib[ "common" ],
-		UniformsLib[ "lights" ],
+		ShaderLib[ "phong" ].uniforms,
 		{
-			"color": { value: new Color( 0xffffff ) },
-			"diffuse": { value: new Color( 0xffffff ) },
-			"specular": { value: new Color( 0xffffff ) },
-			"emissive": { value: new Color( 0x000000 ) },
-			"opacity": { value: 1 },
-			"shininess": { value: 1 },
-
 			"thicknessMap": { value: null },
 			"thicknessColor": { value: new Color( 0xffffff ) },
 			"thicknessDistortion": { value: 0.1 },
@@ -41,52 +41,16 @@ var TranslucentShader = {
 	] ),
 
 	vertexShader: [
-
-		"varying vec3 vNormal;",
-		"varying vec2 vUv;",
-
-		"varying vec3 vViewPosition;",
-
-		ShaderChunk[ "common" ],
-
-		"void main() {",
-
-		"	vec4 worldPosition = modelMatrix * vec4( position, 1.0 );",
-
-		"	vec4 mvPosition = modelViewMatrix * vec4( position, 1.0 );",
-
-		"	vViewPosition = -mvPosition.xyz;",
-
-		"	vNormal = normalize( normalMatrix * normal );",
-
-		"	vUv = uv;",
-
-		"	gl_Position = projectionMatrix * mvPosition;",
-
-		"}",
-
+		"#define USE_UV",
+		ShaderChunk[ "meshphong_vert" ],
 	].join( "\n" ),
 
 	fragmentShader: [
 		"#define USE_UV",
-		"#define USE_MAP",
-		"#define PHONG",
 		"#define TRANSLUCENT",
-		"#include <common>",
-		"#include <bsdfs>",
-		"#include <uv_pars_fragment>",
-		"#include <map_pars_fragment>",
-		"#include <lights_phong_pars_fragment>",
-
-		"varying vec3 vColor;",
 
-		"uniform vec3 diffuse;",
-		"uniform vec3 specular;",
-		"uniform vec3 emissive;",
-		"uniform float opacity;",
-		"uniform float shininess;",
+		meshphong_frag_head,
 
-		// Translucency
 		"uniform sampler2D thicknessMap;",
 		"uniform float thicknessPower;",
 		"uniform float thicknessScale;",
@@ -95,8 +59,6 @@ var TranslucentShader = {
 		"uniform float thicknessAttenuation;",
 		"uniform vec3 thicknessColor;",
 
-		ShaderChunk[ "lights_pars_begin" ],
-
 		"void RE_Direct_Scattering(const in IncidentLight directLight, const in vec2 uv, const in GeometricContext geometry, inout ReflectedLight reflectedLight) {",
 		"	vec3 thickness = thicknessColor * texture2D(thicknessMap, uv).r;",
 		"	vec3 scatteringHalf = normalize(directLight.direction + (geometry.normal * thicknessDistortion));",
@@ -105,109 +67,21 @@ var TranslucentShader = {
 		"	reflectedLight.directDiffuse += scatteringIllu * thicknessAttenuation * directLight.color;",
 		"}",
 
-		"void main() {",
-
-		"	vec3 normal = normalize( vNormal );",
-
-		"	vec3 viewerDirection = normalize( vViewPosition );",
-
-		"	vec4 diffuseColor = vec4( diffuse, opacity );",
-		"	ReflectedLight reflectedLight = ReflectedLight( vec3( 0.0 ), vec3( 0.0 ), vec3( 0.0 ), vec3( 0.0 ) );",
-
-		ShaderChunk[ "map_fragment" ],
-		ShaderChunk[ "color_fragment" ],
-		ShaderChunk[ "specularmap_fragment" ],
-
-		"	vec3 totalEmissiveRadiance = emissive;",
-
-		ShaderChunk[ "lights_phong_fragment" ],
-
-		// Doing lights fragment begin.
-		"	GeometricContext geometry;",
-		"	geometry.position = - vViewPosition;",
-		"	geometry.normal = normal;",
-		"	geometry.viewDir = normalize( vViewPosition );",
-
-		"	IncidentLight directLight;",
-
-		"	#if ( NUM_POINT_LIGHTS > 0 ) && defined( RE_Direct )",
-
-		"		PointLight pointLight;",
-
-		"		#pragma unroll_loop_start",
-		"		for ( int i = 0; i < NUM_POINT_LIGHTS; i ++ ) {",
-		"		 	pointLight = pointLights[ i ];",
-		"		 	getPointDirectLightIrradiance( pointLight, geometry, directLight );",
-
-		"			#ifdef USE_SHADOWMAP",
-		"			directLight.color *= all( bvec2( pointLight.shadow, directLight.visible ) ) ? getPointShadow( pointShadowMap[ i ], pointLight.shadowMapSize, pointLight.shadowBias, pointLight.shadowRadius, vPointShadowCoord[ i ], pointLight.shadowCameraNear, pointLight.shadowCameraFar ) : 1.0;",
-		"			#endif",
-
-		"			RE_Direct( directLight, geometry, material, reflectedLight );",
-
-		"			#if defined( TRANSLUCENT ) && defined( USE_UV )",
-		"			RE_Direct_Scattering(directLight, vUv, geometry, reflectedLight);",
-		"			#endif",
-		"		}",
-		"		#pragma unroll_loop_end",
-
-		"		#endif",
-
-		"	#if ( NUM_DIR_LIGHTS > 0 ) && defined( RE_Direct )",
-
-		"		DirectionalLight directionalLight;",
-
-		"		#pragma unroll_loop_start",
-		"		for ( int i = 0; i < NUM_DIR_LIGHTS; i ++ ) {",
-		"			directionalLight = directionalLights[ i ];",
-		"			getDirectionalDirectLightIrradiance( directionalLight, geometry, directLight );",
-
-		"			#ifdef USE_SHADOWMAP",
-		"			directLight.color *= all( bvec2( directionalLight.shadow, directLight.visible ) ) ? getShadow( directionalShadowMap[ i ], directionalLight.shadowMapSize, directionalLight.shadowBias, directionalLight.shadowRadius, vDirectionalShadowCoord[ i ] ) : 1.0;",
-		"			#endif",
-
-		"			RE_Direct( directLight, geometry, material, reflectedLight );",
-
-		"			#if defined( TRANSLUCENT ) && defined( USE_UV )",
-		"			RE_Direct_Scattering(directLight, vUv, geometry, reflectedLight);",
-		"			#endif",
-		"		}",
-		"		#pragma unroll_loop_end",
-
-		"	#endif",
-
-		"	#if defined( RE_IndirectDiffuse )",
-
-		"		vec3 irradiance = getAmbientLightIrradiance( ambientLightColor );",
-
-		"		#if ( NUM_HEMI_LIGHTS > 0 )",
-
-		"			#pragma unroll_loop_start",
-		"			for ( int i = 0; i < NUM_HEMI_LIGHTS; i ++ ) {",
-
-		"				irradiance += getHemisphereLightIrradiance( hemisphereLights[ i ], geometry );",
-
-		"			}",
-		"			#pragma unroll_loop_end",
-
-		"		#endif",
-
-		"	#endif",
-
-		"	#if defined( RE_IndirectSpecular )",
-
-		"		vec3 radiance = vec3( 0.0 );",
-		"		vec3 clearcoatRadiance = vec3( 0.0 );",
-
-		"	#endif",
-		ShaderChunk[ "lights_fragment_end" ],
+		meshphong_frag_body.replace( "#include <lights_fragment_begin>",
 
-		"	vec3 outgoingLight = reflectedLight.directDiffuse + reflectedLight.indirectDiffuse + reflectedLight.directSpecular + reflectedLight.indirectSpecular + totalEmissiveRadiance;",
-		"	gl_FragColor = vec4( outgoingLight, diffuseColor.a );",	// TODO, this should be pre-multiplied to allow for bright highlights on very transparent objects
+			replaceAll(
+				ShaderChunk[ 'lights_fragment_begin' ],
+				'RE_Direct( directLight, geometry, material, reflectedLight );',
+				[
+					"RE_Direct( directLight, geometry, material, reflectedLight );",
 
-		ShaderChunk[ "encodings_fragment" ],
+					"#if defined( TRANSLUCENT ) && defined( USE_UV )",
+					" RE_Direct_Scattering(directLight, vUv, geometry, reflectedLight);",
+					"#endif",
+				].join( "\n" )
+			),
 
-		"}"
+		),
 
 	].join( "\n" ),
 

examples/webgl_materials_translucency.html

@@ -138,7 +138,7 @@
 
 			var ThicknessControls = function () {
 
-				this.distoration = uniforms[ 'thicknessDistortion' ].value;
+				this.distortion = uniforms[ 'thicknessDistortion' ].value;
 				this.ambient = uniforms[ 'thicknessAmbient' ].value;
 				this.attenuation = uniforms[ 'thicknessAttenuation' ].value;
 				this.power = uniforms[ 'thicknessPower' ].value;
@@ -149,9 +149,9 @@
 			var thicknessControls = new ThicknessControls();
 			var thicknessFolder = gui.addFolder( 'Thickness Control' );
 
-			thicknessFolder.add( thicknessControls, 'distoration' ).min( 0.01 ).max( 1 ).step( 0.01 ).onChange( function () {
+			thicknessFolder.add( thicknessControls, 'distortion' ).min( 0.01 ).max( 1 ).step( 0.01 ).onChange( function () {
 
-				uniforms[ 'thicknessDistortion' ].value = thicknessControls.distoration;
+				uniforms[ 'thicknessDistortion' ].value = thicknessControls.distortion;
 
 			} );