Src: encodings_fragment -> colorspace_fragment

[WestLangley]

... plus related changes.

[github-actions]

📦 Bundle size

Full ESM build, minified and gzipped.

Filesize dev	Filesize PR	Diff
640 kB (158.8 kB)	640.3 kB (158.9 kB)	+274 B

🌳 Bundle size after tree-shaking

Minimal build including a renderer, camera, empty scene, and dependencies.

Filesize dev	Filesize PR	Diff
433.4 kB (105 kB)	433.6 kB (105.1 kB)	+274 B

[Mugen87]

I'm a bit worried about this change. The encodings_fragment shader chunk is frequently used in custom shader materials. With this change, all these material definitions will be broken.

So I wonder if the renaming is worth the breakage.

I think it would be best to deprecate the shader chunk first and then log a warning for ten releases. Maybe we can try to implement a small deprecation check in WebGLProgram that checks for outdated chunks and performs a resolution to newer ones. The includeReplacer() function could be the right spot for this. Ideally it would log a warning and then map encodings_fragment to color_space_fragment.

[Mugen87]

This should do it:

const shaderChunkMap = new Map( [
	[ 'encodings_fragment', 'color_space_fragment' ], // @deprecated, r154
	[ 'encodings_pars_fragment', 'color_space_pars_fragment' ] // @deprecated, r154
] );

function includeReplacer( match, include ) {

	let string = ShaderChunk[ include ];

	if ( string === undefined ) {

		const newInclude = shaderChunkMap.get( include );

		if ( newInclude !== undefined ) {

			string = ShaderChunk[ newInclude ];
			console.warn( 'THREE.WebGLRenderer: Shader chunk "%s" has been deprecated. Use "%s" instead.', include, newInclude );

		} else {

			throw new Error( 'Can not resolve #include <' + include + '>' );

		}

	}

	return resolveIncludes( string );

}

[WestLangley]

@Mugen87 Good suggestion, thanks. I implemented it in this PR.

[mrdoob]

I think colorspace_fragment and colorspace_pars_fragment would fit better with the rest of the shaderchunk names.

[WestLangley]

We decided to use the term "color space", not "colorspace".

Hence, the variable name became colorSpace, not colorspace.

Consequently, I chose to use color_space_fragment, not colorspace_fragment.

[mrdoob]

@WestLangley Thanks! 🙏

Also great to finally have a migration helper for these 🥲

[WestLangley]

This PR requires updated build files. Otherwise, the modified examples are out-of-sync with core.

[Mugen87]

e31a6d4 🚀