awsm-renderer 0.4.2

awsm-renderer
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

//! Shader templates for the effects pass.

use askama::Template;

use crate::{
    render_passes::effects::shader::cache_key::{BloomPhase, ShaderCacheKeyEffects},
    shaders::{AwsmShaderError, Result},
};

/// Effects pass shader template components.
#[derive(Debug)]
pub struct ShaderTemplateEffects {
    pub bind_groups: ShaderTemplateEffectsBindGroups,
    pub compute: ShaderTemplateEffectsCompute,
}

/// Bind group template for the effects pass.
#[derive(Template, Debug)]
#[template(path = "effects_wgsl/bind_groups.wgsl", whitespace = "minimize")]
pub struct ShaderTemplateEffectsBindGroups {
    pub smaa_anti_alias: bool,
    pub multisampled_geometry: bool,
    pub dof: bool,
    pub ping_pong: bool,
    pub debug: ShaderTemplateEffectsDebug,
}

impl ShaderTemplateEffectsBindGroups {
    /// Creates a bind group template from the cache key.
    pub fn new(cache_key: &ShaderCacheKeyEffects) -> Self {
        Self {
            smaa_anti_alias: cache_key.smaa_anti_alias,
            multisampled_geometry: cache_key.multisampled_geometry,
            dof: cache_key.dof,
            ping_pong: cache_key.ping_pong,
            debug: ShaderTemplateEffectsDebug::new(),
        }
    }
}

/// Compute shader template for the effects pass.
#[derive(Template, Debug)]
#[template(path = "effects_wgsl/compute.wgsl", whitespace = "minimize")]
pub struct ShaderTemplateEffectsCompute {
    pub smaa_anti_alias: bool,
    pub multisampled_geometry: bool,
    /// Bloom is enabled (any phase other than None)
    pub bloom: bool,
    /// First pass: extract bright pixels from composite
    pub bloom_extract: bool,
    /// Final pass: blend bloom result with original
    pub bloom_blend: bool,
    pub dof: bool,
    pub ping_pong: bool,
    pub debug: ShaderTemplateEffectsDebug,
}

impl ShaderTemplateEffectsCompute {
    /// Creates a compute shader template from the cache key.
    pub fn new(cache_key: &ShaderCacheKeyEffects) -> Self {
        let bloom = cache_key.bloom_phase != BloomPhase::None;
        let bloom_extract = cache_key.bloom_phase == BloomPhase::Extract;
        let bloom_blend = cache_key.bloom_phase == BloomPhase::Blend;

        Self {
            smaa_anti_alias: cache_key.smaa_anti_alias,
            multisampled_geometry: cache_key.multisampled_geometry,
            bloom,
            bloom_extract,
            bloom_blend,
            dof: cache_key.dof,
            ping_pong: cache_key.ping_pong,
            debug: ShaderTemplateEffectsDebug::new(),
        }
    }
}

impl TryFrom<&ShaderCacheKeyEffects> for ShaderTemplateEffects {
    type Error = AwsmShaderError;

    fn try_from(value: &ShaderCacheKeyEffects) -> Result<Self> {
        Ok(Self {
            bind_groups: ShaderTemplateEffectsBindGroups::new(value),
            compute: ShaderTemplateEffectsCompute::new(value),
        })
    }
}

impl ShaderTemplateEffects {
    /// Renders the effects shader template into WGSL.
    pub fn into_source(self) -> Result<String> {
        let bind_groups_source = self.bind_groups.render()?;
        let compute_source = self.compute.render()?;
        Ok(format!("{}\n{}", bind_groups_source, compute_source))
    }

    /// Returns an optional debug label for shader compilation.
    pub fn debug_label(&self) -> Option<&str> {
        Some("Effects")
    }
}

/// Debug toggles for effects shaders.
#[derive(Default, Debug, Clone)]
pub struct ShaderTemplateEffectsDebug {
    pub smaa_edges: bool,
}

impl ShaderTemplateEffectsDebug {
    /// Creates a default debug config.
    pub fn new() -> Self {
        Self { smaa_edges: false }
    }
}