Tweak shader compilation error messages #95495

Calinou · 2024-08-13T18:11:24Z

Mention the shader type that failed compilation.
Mention the most common cause for this error (which are syntax errors).
Mention that the shader code is printed nearby for troubleshooting.

This partially addresses [TRACKER] Error macros with cryptic messages due to not having proper custom messages defined #42719 (comment)
and Visual shader plugin complains about missing version and category #95443.

Testing project: test_shader_error.zip

Preview

Note

ERROR: not enough arguments for format string is not introduced by this PR; it also occurs in master with the MRP
and is likely due to a script error in that MRP (check line 142 of VSSimplexNoise3D.gd, % arguments are missing).

Forward+

--Main Shader--
    1 | shader_type spatial;
    2 | render_mode blend_mix, depth_draw_opaque, cull_back, diffuse_lambert, specular_schlick_ggx;
    3 |
  ... | [...omitted from this preview to shorten the log...]
  107 |
  108 | }
  109 |
SHADER ERROR: Expected a ';'.
          at: (null) (:101)
ERROR: Spatial shader compilation failed (most likely due to a syntax error). Shader code has been printed nearby for troubleshooting.
   at: set_code (servers/rendering/renderer_rd/forward_clustered/scene_shader_forward_clustered.cpp:146)
ERROR: not enough arguments for format string
   at: validated_evaluate (./core/variant/variant_op.h:951)
--res://node_3d.tres--
    1 | shader_type spatial;
    2 | render_mode blend_mix, depth_draw_opaque, cull_back, diffuse_lambert, specular_schlick_ggx;
    3 |
  ... | [...omitted from this preview to shorten the log...]
  107 |
  108 | }
  109 |
SHADER ERROR: Expected a ';'.
          at: (null) (res://node_3d.tres:101)
ERROR: Spatial shader compilation failed (most likely due to a syntax error). Shader code has been printed nearby for troubleshooting.
   at: set_code (servers/rendering/renderer_rd/forward_clustered/scene_shader_forward_clustered.cpp:146)
ERROR: Shader compilation failed (most likely due to a syntax error). Shader code has been printed nearby for troubleshooting.
   at: version_get_shader (./servers/rendering/renderer_rd/shader_rd.h:166)

Mobile

--Main Shader--
    1 | shader_type spatial;
    2 | render_mode blend_mix, depth_draw_opaque, cull_back, diffuse_lambert, specular_schlick_ggx;
    3 |
  ... | [...omitted from this preview to shorten the log...]
  107 |
  108 | }
  109 |
SHADER ERROR: Expected a ';'.
          at: (null) (:101)
ERROR: Spatial shader compilation failed (most likely due to a syntax error). Shader code has been printed nearby for troubleshooting.
   at: set_code (servers/rendering/renderer_rd/forward_mobile/scene_shader_forward_mobile.cpp:147)
ERROR: not enough arguments for format string
   at: validated_evaluate (./core/variant/variant_op.h:951)
--res://node_3d.tres--
    1 | shader_type spatial;
    2 | render_mode blend_mix, depth_draw_opaque, cull_back, diffuse_lambert, specular_schlick_ggx;
    3 |
  ... | [...omitted from this preview to shorten the log...]
  107 |
  108 | }
  109 |
SHADER ERROR: Expected a ';'.
          at: (null) (res://node_3d.tres:101)
ERROR: Spatial shader compilation failed (most likely due to a syntax error). Shader code has been printed nearby for troubleshooting.
   at: set_code (servers/rendering/renderer_rd/forward_mobile/scene_shader_forward_mobile.cpp:147)
ERROR: Shader compilation failed (most likely due to a syntax error). Shader code has been printed nearby for troubleshooting.
   at: version_get_shader (./servers/rendering/renderer_rd/shader_rd.h:166)

Compatibility

--Main Shader--
    1 | shader_type spatial;
    2 | render_mode blend_mix, depth_draw_opaque, cull_back, diffuse_lambert, specular_schlick_ggx;
    3 |
  ... | [...omitted from this preview to shorten the log...]
  107 |
  108 | }
  109 |
SHADER ERROR: Expected a ';'.
          at: (null) (:101)
ERROR: Spatial shader compilation failed (most likely due to a syntax error). Shader code has been printed nearby for troubleshooting.
   at: set_code (drivers/gles3/storage/material_storage.cpp:2972)
ERROR: not enough arguments for format string
   at: validated_evaluate (./core/variant/variant_op.h:951)
--res://node_3d.tres--
    1 | shader_type spatial;
    2 | render_mode blend_mix, depth_draw_opaque, cull_back, diffuse_lambert, specular_schlick_ggx;
    3 |
  ... | [...omitted from this preview to shorten the log...]
  107 |
  108 | }
  109 |
SHADER ERROR: Expected a ';'.
          at: (null) (res://node_3d.tres:101)
ERROR: Spatial shader compilation failed (most likely due to a syntax error). Shader code has been printed nearby for troubleshooting.
   at: set_code (drivers/gles3/storage/material_storage.cpp:2972)

clayjohn · 2024-08-13T18:41:03Z

drivers/gles3/shader_gles3.cpp

@@ -716,7 +716,7 @@ void ShaderGLES3::_initialize_version(Version *p_version) {

 void ShaderGLES3::version_set_code(RID p_version, const HashMap<String, String> &p_code, const String &p_uniforms, const String &p_vertex_globals, const String &p_fragment_globals, const Vector<String> &p_custom_defines, const LocalVector<ShaderGLES3::TextureUniformData> &p_texture_uniforms, bool p_initialize) {
 	Version *version = version_owner.get_or_null(p_version);
-	ERR_FAIL_NULL(version);
+	ERR_FAIL_NULL_MSG(version, "Shader compilation failed (most likely due to a syntax error). Shader code has been printed above for troubleshooting.");


I don't think this is correct. I can't find any code path where this would be reached with a null version due to failing to compile. If compilation fails, the engine won't attempt to set the code on the version.

The error in the bug report comes from version_get_shader()

godot/servers/rendering/renderer_rd/shader_rd.h

Line 166 in 06fbc83

ERR_FAIL_NULL_V(version, RID());

It happens when you try to use a shader that previously failed compilation

I've changed the message accordingly for version_set_code() in all rendering methods. Not sure if we can make it much more specific than what I put:

Can't use a shader that previously failed compilation.

clayjohn · 2025-01-10T17:54:45Z

servers/rendering/renderer_rd/shader_rd.h

@@ -167,7 +167,7 @@ class ShaderRD {
 		ERR_FAIL_COND_V(!variants_enabled[p_variant], RID());

 		Version *version = version_owner.get_or_null(p_version);
-		ERR_FAIL_NULL_V(version, RID());
+		ERR_FAIL_NULL_V_MSG(version, RID(), "Shader compilation failed (most likely due to a syntax error). Shader code has been printed nearby for troubleshooting.");


This has the same problem as before. This isn't a shader compilation error.

clayjohn · 2025-01-10T17:55:05Z

servers/rendering/renderer_rd/shader_rd.cpp

@@ -651,7 +651,7 @@ void ShaderRD::version_set_compute_code(RID p_version, const HashMap<String, Str
 	ERR_FAIL_COND(!is_compute);

 	Version *version = version_owner.get_or_null(p_version);
-	ERR_FAIL_NULL(version);
+	ERR_FAIL_NULL_MSG(version, "Compute shader compilation failed (most likely due to a syntax error). Shader code has been printed nearby for troubleshooting.");


Same as above. This isn't a compilation error

clayjohn · 2025-01-10T17:56:04Z

servers/rendering/renderer_rd/shader_rd.cpp

@@ -616,7 +616,7 @@ void ShaderRD::version_set_code(RID p_version, const HashMap<String, String> &p_
 	ERR_FAIL_COND(is_compute);

 	Version *version = version_owner.get_or_null(p_version);
-	ERR_FAIL_NULL(version);
+	ERR_FAIL_NULL_MSG(version, "Can't use a shader that previously failed compilation.");


As per my last review, this isn't a compile error. Failing to compile is just one reason why this case may be hit. The message is misleading

I've reworded all 3 messages somewhat. The concept of "shader version" isn't something that is obvious to most users though (unless you look at the native shader source inspector), so I'm not sure how we could clarify it.

Ideally this is an error that users would never see. It's meant to be totally internal

drivers/gles3/storage/material_storage.cpp

- Mention the shader type that failed compilation. - Mention the most common cause for this error (which are syntax errors). - Mention that the shader code is printed nearby for troubleshooting.

Calinou requested a review from a team as a code owner August 13, 2024 18:11

Calinou added enhancement topic:shaders labels Aug 13, 2024

Calinou added this to the 4.4 milestone Aug 13, 2024

clayjohn reviewed Aug 13, 2024

View reviewed changes

Calinou force-pushed the tweak-shader-compilation-error-messages branch from 6c6a7d5 to 7ee15df Compare August 13, 2024 19:11

Calinou mentioned this pull request Dec 6, 2024

Use colors and formatting for printing shader errors to console #100111

Open

Calinou force-pushed the tweak-shader-compilation-error-messages branch from 7ee15df to 4b6fded Compare January 10, 2025 17:41

clayjohn reviewed Jan 10, 2025

View reviewed changes

Calinou force-pushed the tweak-shader-compilation-error-messages branch 2 times, most recently from 7eef8a9 to a3e1672 Compare January 10, 2025 19:20

Ansraer suggested changes Jan 10, 2025

View reviewed changes

drivers/gles3/storage/material_storage.cpp Outdated Show resolved Hide resolved

Tweak shader compilation error messages

90d6b1c

- Mention the shader type that failed compilation. - Mention the most common cause for this error (which are syntax errors). - Mention that the shader code is printed nearby for troubleshooting.

Calinou force-pushed the tweak-shader-compilation-error-messages branch from a3e1672 to 90d6b1c Compare January 10, 2025 22:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tweak shader compilation error messages #95495

Tweak shader compilation error messages #95495

Calinou commented Aug 13, 2024 •

edited

Loading

clayjohn Aug 13, 2024

Calinou Aug 13, 2024 •

edited

Loading

clayjohn Jan 10, 2025

clayjohn Jan 10, 2025

clayjohn Jan 10, 2025

Calinou Jan 10, 2025

clayjohn Jan 11, 2025

Tweak shader compilation error messages #95495

Are you sure you want to change the base?

Tweak shader compilation error messages #95495

Conversation

Calinou commented Aug 13, 2024 • edited Loading

Preview

Forward+

Mobile

Compatibility

clayjohn Aug 13, 2024

Choose a reason for hiding this comment

Calinou Aug 13, 2024 • edited Loading

Choose a reason for hiding this comment

clayjohn Jan 10, 2025

Choose a reason for hiding this comment

clayjohn Jan 10, 2025

Choose a reason for hiding this comment

clayjohn Jan 10, 2025

Choose a reason for hiding this comment

Calinou Jan 10, 2025

Choose a reason for hiding this comment

clayjohn Jan 11, 2025

Choose a reason for hiding this comment

Calinou commented Aug 13, 2024 •

edited

Loading

Calinou Aug 13, 2024 •

edited

Loading