1653544 - Generate comments with information about the shader during optimization

Status: RESOLVED FIXED

(Core :: Graphics: WebRender, task, P3)

Description

[Nicolas Silva [:nical]]

The shader preprocessing used to emit a comment at the top with the name of the shader at build time, which was very handy when inspecting things in renderdoc or apitrace. It looks like the information got lost, I suspect during the shader optimization. It would be great to get that info back.

Icing on the cake would be to also show the shader feature defines.

Comment 1

[Jeff Muizelaar [:jrmuizel]]

(In reply to Nicolas Silva [:nical] from comment #0)

The shader preprocessing used to emit a comment at the top with the name of the shader at build time, which was very handy when inspecting things in renderdoc or apitrace. It looks like the information got lost, I suspect during the shader optimization. It would be great to get that info back.

Icing on the cake would be to also show the shader feature defines.

Can you just turn off shader optimization when running renderdoc/apitrace?

Comment 2

[Jamie Nicol [:jnicol]]

Here is where we write the optimized shader output to files.

I think basically we just need to
a) write the first line of the optimized shader (because GLSL requires the first line be the '#version' string)
b) write format!("// {}", full_shader_name)
c) write the rest of the optimized shader

Comment 3

[Nicolas Silva [:nical]]

Can you just turn off shader optimization when running renderdoc/apitrace?

Is it something I can do on a distributed nightly build ? In any case if I can help it I'd rather not have to think about fiddling around before capturing something.
The fix looks easy enough.

Comment 4

[Jamie Nicol [:jnicol]]

Setting gfx.webrender.use-optimized-shaders=false will make us use the non-optimized shaders, which might make debugging easier. (The optimized shaders can be quite hard to follow.)

Comment 5

[Nicolas Silva [:nical]]

Attachment: Bug 1653544 - Add usueful information in the generated shaders. r=jnicol

This writes the shader name and list of featrues as a comment at the beginning of optimized shaders.

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/ce86a01c74be
Add usueful information in the generated shaders. r=jnicol

Comment 7

[Narcis Beleuzu [:NarcisB]]

https://hg.mozilla.org/mozilla-central/rev/ce86a01c74be