From 23613b80a7be01fadf92a6be6868da9f56f8b519 Mon Sep 17 00:00:00 2001 From: Boris Ghidaglia Date: Fri, 13 Dec 2024 19:15:03 +0100 Subject: [PATCH 1/2] Docs: Add TSL example for the onBeforeCompile method in Material --- docs/api/en/materials/Material.html | 4 +++- docs/api/fr/materials/Material.html | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/api/en/materials/Material.html b/docs/api/en/materials/Material.html index 85d5c38b8146cf..0f63c5133fdfb1 100644 --- a/docs/api/en/materials/Material.html +++ b/docs/api/en/materials/Material.html @@ -417,7 +417,9 @@

An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code - as a parameter. Useful for the modification of built-in materials. + as a parameter. Useful for the modification of built-in materials, but the recommended + approach moving forward is to use [link:https://github.com/mrdoob/three.js/wiki/Three.js-Shading-Language TSL]. + See the before/after example [link:https://github.com/mrdoob/three.js/wiki/Three.js-Shading-Language#example here].

Unlike properties, the callback is not supported by [page:Material.clone .clone](), diff --git a/docs/api/fr/materials/Material.html b/docs/api/fr/materials/Material.html index 18bc1ac1135b04..c5c1eb1132cb50 100644 --- a/docs/api/fr/materials/Material.html +++ b/docs/api/fr/materials/Material.html @@ -350,7 +350,9 @@

[method:undefined dispose]()

[method:undefined onBeforeCompile]( [param:Shader shader], [param:WebGLRenderer renderer] )

Un callback facultatif qui est exécuté immédiatement avant la compilation du programme shader. - Cette fonction est appelée avec le code source du shader comme paramètre. Utile pour la modification des matériaux intégrés. + Cette fonction est appelée avec le code source du shader comme paramètre. Utile pour la modification des matériaux intégrés, + bien que la nouvelle méthode recommandée soit d'utiliser [link:https://github.com/mrdoob/three.js/wiki/Three.js-Shading-Language TSL]. + Voir l'exemple avant/après [link:https://github.com/mrdoob/three.js/wiki/Three.js-Shading-Language#example ici].

Contrairement aux propriétés, le callback n'est pas pris en charge par [page:Material.clone .clone](), [page:Material.copy .copy]() et [page:Material.toJSON .toJSON](). From e858c5da2bfdbbdeaefe64c37d92f7241c3a48a9 Mon Sep 17 00:00:00 2001 From: Boris Ghidaglia Date: Thu, 19 Dec 2024 20:14:37 +0100 Subject: [PATCH 2/2] Implements review feedbacks --- docs/api/en/materials/Material.html | 6 +++--- docs/api/fr/materials/Material.html | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/api/en/materials/Material.html b/docs/api/en/materials/Material.html index 0f63c5133fdfb1..d84a2556af27a1 100644 --- a/docs/api/en/materials/Material.html +++ b/docs/api/en/materials/Material.html @@ -417,9 +417,9 @@

An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code - as a parameter. Useful for the modification of built-in materials, but the recommended - approach moving forward is to use [link:https://github.com/mrdoob/three.js/wiki/Three.js-Shading-Language TSL]. - See the before/after example [link:https://github.com/mrdoob/three.js/wiki/Three.js-Shading-Language#example here]. + as a parameter. Useful for the modification of built-in materials, but the + recommended approach moving forward is to use `WebGPURenderer` with the new + Node Material system and [link:https://github.com/mrdoob/three.js/wiki/Three.js-Shading-Language TSL].

Unlike properties, the callback is not supported by [page:Material.clone .clone](), diff --git a/docs/api/fr/materials/Material.html b/docs/api/fr/materials/Material.html index c5c1eb1132cb50..a1ca23496e8de3 100644 --- a/docs/api/fr/materials/Material.html +++ b/docs/api/fr/materials/Material.html @@ -351,8 +351,8 @@

[method:undefined onBeforeCompile]( [param:Shader shader], [param:WebGLRende

Un callback facultatif qui est exécuté immédiatement avant la compilation du programme shader. Cette fonction est appelée avec le code source du shader comme paramètre. Utile pour la modification des matériaux intégrés, - bien que la nouvelle méthode recommandée soit d'utiliser [link:https://github.com/mrdoob/three.js/wiki/Three.js-Shading-Language TSL]. - Voir l'exemple avant/après [link:https://github.com/mrdoob/three.js/wiki/Three.js-Shading-Language#example ici]. + bien que la nouvelle méthode recommandée soit d'utiliser `WebGPURenderer` avec le nouveau système de Node Material et + [link:https://github.com/mrdoob/three.js/wiki/Three.js-Shading-Language TSL].

Contrairement aux propriétés, le callback n'est pas pris en charge par [page:Material.clone .clone](), [page:Material.copy .copy]() et [page:Material.toJSON .toJSON]().