awsm-renderer 0.3.1

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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

//! Shader template variants for render passes.

use crate::{
    render_passes::{
        coverage::shader::template::ShaderTemplateCoverage,
        display::shader::template::ShaderTemplateDisplay,
        effects::shader::template::ShaderTemplateEffects,
        geometry::shader::masked_template::ShaderTemplateGeometryMasked,
        geometry::shader::template::ShaderTemplateGeometry,
        hzb::shader::template::{ShaderTemplateHzbReduce, ShaderTemplateHzbSeed},
        light_culling::shader::template::ShaderTemplateLightCulling,
        material_classify::shader::template::ShaderTemplateMaterialClassify,
        material_decal::classify::shader::template::ShaderTemplateDecalClassify,
        material_decal::shader::template::ShaderTemplateMaterialDecal,
        material_opaque::shader::edge_template::ShaderTemplateMaterialFinalBlend,
        material_opaque::shader::template::ShaderTemplateMaterialOpaque,
        material_prep::shader::template::ShaderTemplateMaterialPrep,
        material_transparent::shader::template::ShaderTemplateMaterialTransparent,
        occlusion::shader::template::{
            ShaderTemplateOcclusionCompaction, ShaderTemplateOcclusionCull,
        },
        shader_cache_key::ShaderCacheKeyRenderPass,
    },
    shaders::AwsmShaderError,
};

/// Render-pass shader template variants.
pub enum ShaderTemplateRenderPass {
    Coverage(ShaderTemplateCoverage),
    Geometry(ShaderTemplateGeometry),
    GeometryMasked(ShaderTemplateGeometryMasked),
    HzbSeed(ShaderTemplateHzbSeed),
    HzbReduce(ShaderTemplateHzbReduce),
    LightCulling(ShaderTemplateLightCulling),
    MaterialClassify(ShaderTemplateMaterialClassify),
    MaterialPrep(ShaderTemplateMaterialPrep),
    DecalClassify(ShaderTemplateDecalClassify),
    MaterialDecal(ShaderTemplateMaterialDecal),
    MaterialOpaque(ShaderTemplateMaterialOpaque),
    MaterialFinalBlend(ShaderTemplateMaterialFinalBlend),
    MaterialTransparent(ShaderTemplateMaterialTransparent),
    OcclusionCull(ShaderTemplateOcclusionCull),
    OcclusionCompaction(ShaderTemplateOcclusionCompaction),
    Effects(ShaderTemplateEffects),
    Display(ShaderTemplateDisplay),
}

impl TryFrom<&ShaderCacheKeyRenderPass> for ShaderTemplateRenderPass {
    type Error = AwsmShaderError;

    fn try_from(value: &ShaderCacheKeyRenderPass) -> std::result::Result<Self, Self::Error> {
        match value {
            ShaderCacheKeyRenderPass::Coverage(cache_key) => {
                Ok(ShaderTemplateRenderPass::Coverage(cache_key.try_into()?))
            }
            ShaderCacheKeyRenderPass::Geometry(cache_key) => {
                Ok(ShaderTemplateRenderPass::Geometry(cache_key.try_into()?))
            }
            ShaderCacheKeyRenderPass::GeometryMasked(cache_key) => Ok(
                ShaderTemplateRenderPass::GeometryMasked(cache_key.try_into()?),
            ),
            ShaderCacheKeyRenderPass::HzbSeed(cache_key) => {
                Ok(ShaderTemplateRenderPass::HzbSeed(cache_key.try_into()?))
            }
            ShaderCacheKeyRenderPass::HzbReduce(cache_key) => {
                Ok(ShaderTemplateRenderPass::HzbReduce(cache_key.try_into()?))
            }
            ShaderCacheKeyRenderPass::LightCulling(cache_key) => Ok(
                ShaderTemplateRenderPass::LightCulling(cache_key.try_into()?),
            ),
            ShaderCacheKeyRenderPass::MaterialClassify(cache_key) => Ok(
                ShaderTemplateRenderPass::MaterialClassify(cache_key.try_into()?),
            ),
            ShaderCacheKeyRenderPass::MaterialPrep(cache_key) => Ok(
                ShaderTemplateRenderPass::MaterialPrep(cache_key.try_into()?),
            ),
            ShaderCacheKeyRenderPass::DecalClassify(cache_key) => Ok(
                ShaderTemplateRenderPass::DecalClassify(cache_key.try_into()?),
            ),
            ShaderCacheKeyRenderPass::MaterialDecal(cache_key) => Ok(
                ShaderTemplateRenderPass::MaterialDecal(cache_key.try_into()?),
            ),
            ShaderCacheKeyRenderPass::MaterialOpaque(cache_key) => Ok(
                ShaderTemplateRenderPass::MaterialOpaque(cache_key.try_into()?),
            ),
            ShaderCacheKeyRenderPass::MaterialFinalBlend(cache_key) => Ok(
                ShaderTemplateRenderPass::MaterialFinalBlend(cache_key.try_into()?),
            ),
            ShaderCacheKeyRenderPass::MaterialTransparent(cache_key) => Ok(
                ShaderTemplateRenderPass::MaterialTransparent(cache_key.try_into()?),
            ),
            ShaderCacheKeyRenderPass::OcclusionCull(cache_key) => Ok(
                ShaderTemplateRenderPass::OcclusionCull(cache_key.try_into()?),
            ),
            ShaderCacheKeyRenderPass::OcclusionCompaction(cache_key) => Ok(
                ShaderTemplateRenderPass::OcclusionCompaction(cache_key.try_into()?),
            ),
            ShaderCacheKeyRenderPass::Effects(cache_key) => {
                Ok(ShaderTemplateRenderPass::Effects(cache_key.try_into()?))
            }
            ShaderCacheKeyRenderPass::Display(cache_key) => {
                Ok(ShaderTemplateRenderPass::Display(cache_key.try_into()?))
            }
        }
    }
}

impl ShaderTemplateRenderPass {
    /// Renders the template into WGSL source.
    pub fn into_source(self) -> std::result::Result<String, AwsmShaderError> {
        match self {
            ShaderTemplateRenderPass::Coverage(tmpl) => tmpl.into_source(),
            ShaderTemplateRenderPass::Geometry(tmpl) => tmpl.into_source(),
            ShaderTemplateRenderPass::GeometryMasked(tmpl) => tmpl.into_source(),
            ShaderTemplateRenderPass::HzbSeed(tmpl) => tmpl.into_source(),
            ShaderTemplateRenderPass::HzbReduce(tmpl) => tmpl.into_source(),
            ShaderTemplateRenderPass::LightCulling(tmpl) => tmpl.into_source(),
            ShaderTemplateRenderPass::MaterialClassify(tmpl) => tmpl.into_source(),
            ShaderTemplateRenderPass::MaterialPrep(tmpl) => tmpl.into_source(),
            ShaderTemplateRenderPass::DecalClassify(tmpl) => tmpl.into_source(),
            ShaderTemplateRenderPass::MaterialDecal(tmpl) => tmpl.into_source(),
            ShaderTemplateRenderPass::MaterialOpaque(tmpl) => tmpl.into_source(),
            ShaderTemplateRenderPass::MaterialFinalBlend(tmpl) => tmpl.into_source(),
            ShaderTemplateRenderPass::MaterialTransparent(tmpl) => tmpl.into_source(),
            ShaderTemplateRenderPass::OcclusionCull(tmpl) => tmpl.into_source(),
            ShaderTemplateRenderPass::OcclusionCompaction(tmpl) => tmpl.into_source(),
            ShaderTemplateRenderPass::Effects(tmpl) => tmpl.into_source(),
            ShaderTemplateRenderPass::Display(tmpl) => tmpl.into_source(),
        }
    }

    /// Returns an optional debug label for shader compilation.
    /// Kept in release builds (see `ShaderTemplate::into_descriptor`
    /// for the cost rationale).
    pub fn debug_label(&self) -> Option<&str> {
        match self {
            ShaderTemplateRenderPass::Coverage(tmpl) => tmpl.debug_label(),
            ShaderTemplateRenderPass::Geometry(tmpl) => tmpl.debug_label(),
            ShaderTemplateRenderPass::GeometryMasked(tmpl) => tmpl.debug_label(),
            ShaderTemplateRenderPass::HzbSeed(tmpl) => tmpl.debug_label(),
            ShaderTemplateRenderPass::HzbReduce(tmpl) => tmpl.debug_label(),
            ShaderTemplateRenderPass::LightCulling(tmpl) => tmpl.debug_label(),
            ShaderTemplateRenderPass::MaterialClassify(tmpl) => tmpl.debug_label(),
            ShaderTemplateRenderPass::MaterialPrep(tmpl) => tmpl.debug_label(),
            ShaderTemplateRenderPass::DecalClassify(tmpl) => tmpl.debug_label(),
            ShaderTemplateRenderPass::MaterialDecal(tmpl) => tmpl.debug_label(),
            ShaderTemplateRenderPass::MaterialOpaque(tmpl) => tmpl.debug_label(),
            ShaderTemplateRenderPass::MaterialFinalBlend(tmpl) => tmpl.debug_label(),
            ShaderTemplateRenderPass::MaterialTransparent(tmpl) => tmpl.debug_label(),
            ShaderTemplateRenderPass::OcclusionCull(tmpl) => tmpl.debug_label(),
            ShaderTemplateRenderPass::OcclusionCompaction(tmpl) => tmpl.debug_label(),
            ShaderTemplateRenderPass::Effects(tmpl) => tmpl.debug_label(),
            ShaderTemplateRenderPass::Display(tmpl) => tmpl.debug_label(),
        }
    }
}