Skip to content

Add VERBOSE_SHADER_ERROR #20448

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 9, 2025
Merged

Add VERBOSE_SHADER_ERROR #20448

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a08177
Add VERBOSE_SHADER_ERROR
atlv24 Aug 7, 2025
1030290
clippy
atlv24 Aug 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 49 additions & 2 deletions crates/bevy_render/src/render_resource/pipeline_cache.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use crate::{
Extract,
};
use alloc::{borrow::Cow, sync::Arc};
use bevy_asset::{AssetEvent, AssetId, Assets};
use bevy_asset::{AssetEvent, AssetId, Assets, Handle};
use bevy_ecs::{
event::EventReader,
resource::Resource,
Expand Down Expand Up @@ -696,7 +696,12 @@ impl PipelineCache {
PipelineCacheError::ProcessShaderError(err) => {
let error_detail =
err.emit_to_string(&self.shader_cache.lock().unwrap().composer);
error!("failed to process shader:\n{}", error_detail);
if std::env::var("VERBOSE_SHADER_ERROR")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this documented anywhere? This otherwise would be a buried feature that would be difficult to know exists, particularly when it's useful for debugging shaders.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

where should it be documented in-repo?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe at the root of bevy_render? We don't really have a great place for that kind of docs right now.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be documented wherever WGPU_FORCE_FALLBACK_ADAPTER, WGPU_ADAPTER_NAME, WGPU_SETTINGS_PRIO, and BEVY_ASSET_ROOT are documented. Which seemingly is nowhere.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With #20469, this LGTM to me now.

.is_ok_and(|v| !(v.is_empty() || v == "0" || v == "false"))
{
error!("{}", pipeline_error_context(cached_pipeline));
}
error!("failed to process shader error:\n{}", error_detail);
return;
}
PipelineCacheError::CreateShaderModule(description) => {
Expand Down Expand Up @@ -746,6 +751,48 @@ impl PipelineCache {
}
}

fn pipeline_error_context(cached_pipeline: &CachedPipeline) -> String {
fn format(
shader: &Handle<Shader>,
entry: &Option<Cow<'static, str>>,
shader_defs: &[ShaderDefVal],
) -> String {
let source = match shader.path() {
Some(path) => path.path().to_string_lossy().to_string(),
None => String::new(),
};
let entry = match entry {
Some(entry) => entry.to_string(),
None => String::new(),
};
let shader_defs = shader_defs
.iter()
.flat_map(|def| match def {
ShaderDefVal::Bool(k, v) if *v => Some(k.to_string()),
ShaderDefVal::Int(k, v) => Some(format!("{k} = {v}")),
ShaderDefVal::UInt(k, v) => Some(format!("{k} = {v}")),
_ => None,
})
.collect::<Vec<_>>()
.join(", ");
format!("{source}:{entry}\nshader defs: {shader_defs}")
}
match &cached_pipeline.descriptor {
PipelineDescriptor::RenderPipelineDescriptor(desc) => {
let vert = &desc.vertex;
let vert_str = format(&vert.shader, &vert.entry_point, &vert.shader_defs);
let Some(frag) = desc.fragment.as_ref() else {
return vert_str;
};
let frag_str = format(&frag.shader, &frag.entry_point, &frag.shader_defs);
format!("vertex {vert_str}\nfragment {frag_str}")
}
PipelineDescriptor::ComputePipelineDescriptor(desc) => {
format(&desc.shader, &desc.entry_point, &desc.shader_defs)
}
}
}

#[cfg(all(
not(target_arch = "wasm32"),
not(target_os = "macos"),
Expand Down
Loading