Add type to shader material constructor

[stefnotch]

Fix https://forum.babylonjs.com/t/shadermaterial-constructor-type-safety/49030

[bjsplat]

Please make sure to label your PR with "bug", "new feature" or "breaking change" label(s).
To prevent this PR from going to the changelog marked it with the "skip changelog" label.

[bjsplat]

Please make sure to label your PR with "bug", "new feature" or "breaking change" label(s).
To prevent this PR from going to the changelog marked it with the "skip changelog" label.

[stefnotch]

One CI failure is from

Babylon.js/packages/dev/core/src/Materials/shadowDepthWrapper.ts

Lines 302 to 307 in c05e7f0

	params.mainDrawWrapper.effect = engine.createEffect(
	{
	vertexSource: vertexCode,
	fragmentSource: fragmentCode,
	vertexToken: params.token,
	fragmentToken: params.token,

. A property named vertexToken is being used there, and I have no idea if that's intentional or if it's a bug.
The property was undocumented.

[bjsplat]

Please make sure to label your PR with "bug", "new feature" or "breaking change" label(s).
To prevent this PR from going to the changelog marked it with the "skip changelog" label.

[Popov72]

A property named vertexToken is being used there, and I have no idea if that's intentional or if it's a bug.
The property was undocumented.

Yes, this is intentional, it's a way of uniquely identifying a vertex+fragment shader regardless of its defines list (normally, a vertex+fragment shader pair is uniquely defined by the defines list it uses). I think you can document it as @internal at this point, users probably won't need it.

[Popov72]

Good job!

You will also have to update the WebGPUEngine.createEffect method.

[bjsplat]

Please make sure to label your PR with "bug", "new feature" or "breaking change" label(s).
To prevent this PR from going to the changelog marked it with the "skip changelog" label.

[bjsplat]

Please make sure to label your PR with "bug", "new feature" or "breaking change" label(s).
To prevent this PR from going to the changelog marked it with the "skip changelog" label.

[bjsplat]

Snapshot stored with reference name:
refs/pull/14908/merge

Test environment:
https://babylonsnapshots.z22.web.core.windows.net/refs/pull/14908/merge/index.html

To test a playground add it to the URL, for example:

https://babylonsnapshots.z22.web.core.windows.net/refs/pull/14908/merge/index.html#WGZLGJ#4600

Links to test babylon tools with this snapshot:

https://playground.babylonjs.com/?snapshot=refs/pull/14908/merge
https://sandbox.babylonjs.com/?snapshot=refs/pull/14908/merge
https://gui.babylonjs.com/?snapshot=refs/pull/14908/merge
https://nme.babylonjs.com/?snapshot=refs/pull/14908/merge

To test the snapshot in the playground with a playground ID add it after the snapshot query string:

https://playground.babylonjs.com/?snapshot=refs/pull/14908/merge#BCU1XR#0

[bjsplat]

Visualization tests for WebGPU (Experimental)
Important - these might fail sporadically. This is an optional test.

https://babylonsnapshots.z22.web.core.windows.net/refs/pull/14908/merge/testResults/webgpuplaywright/index.html

[bjsplat]

WebGL2 visualization test reporter:

https://babylonsnapshots.z22.web.core.windows.net/refs/pull/14908/merge/testResults/webgl2playwright/index.html

[ryantrem]

A property named vertexToken is being used there, and I have no idea if that's intentional or if it's a bug.
The property was undocumented.

Yes, this is intentional, it's a way of uniquely identifying a vertex+fragment shader regardless of its defines list (normally, a vertex+fragment shader pair is uniquely defined by the defines list it uses). I think you can document it as @internal at this point, users probably won't need it.

@Popov72 if vertexToken/fragmentToken are intended to be internal only, would it make sense to leave them out of IShaderPath such that they are not expected to be passed into the Effect constructor, and have the baseName parameter of the createEffect engine functions be IShaderPath & { vertexToken?: string; fragmentToken?: string}? This would be effectively assuming Engine.createEffect is intended to be for internal use, and the Effect constructor is intended to be the public API.

[Popov72]

Good idea @ryantrem!

[stefnotch]

Good idea, I changed it to IShaderPath & { vertexToken?: string; fragmentToken?: string}.

While I was at it, I noticed that the same sort of type could be added to the compute shaders. So I introduced a IComputeShaderPath and did all the changes there as well.

[bjsplat]

Visualization tests for WebGPU (Experimental)
Important - these might fail sporadically. This is an optional test.

https://babylonsnapshots.z22.web.core.windows.net/refs/pull/14908/merge/testResults/webgpuplaywright/index.html