steamengine-renderer-util 0.1.4

A lightweight graphic engine
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

use steamengine_renderer::Renderer;
use steamengine_renderer::texture::Texture;
use steamengine_renderer::texture::TextureBuilder;
use steamengine_renderer::texture::TextureDimensions;
use wgpu::CompareFunction;
use wgpu::DepthBiasState;
use wgpu::DepthStencilState;
use wgpu::StencilState;
use wgpu::TextureFormat;

/// Abstraction of a depth texture
pub trait DepthTexture {
    /// Return the format of the texture, default Depth32Float
    fn format() -> TextureFormat {
        TextureFormat::Depth32Float
    }
    /// Return the compare funcion of the texture, default Less
    fn compare() -> CompareFunction {
        CompareFunction::Less
    }
    /// Return the stencil state, default Default::default
    fn stencil() -> StencilState {
        Default::default()
    }
    /// Return the bias, default Default::default
    fn bias() -> DepthBiasState {
        Default::default()
    }
    /// Return the pipeline config, default, with configurations
    fn pipeline_stencil() -> DepthStencilState {
        DepthStencilState {
            format: Self::format(),
            depth_write_enabled: true,
            depth_compare: Self::compare(),
            stencil: Self::stencil(),
            bias: Self::bias(),
        }
    }
    /// Create a new texture from renderer
    fn create_texture(renderer: &Renderer) -> Texture {
        let config = renderer.config();

        let mut texture = renderer.init_texture(
            "Depth texture",
            None,
            TextureBuilder::new()
                .format(Self::format())
                .dimension(TextureDimensions::new_2d(
                    config.width.max(1),
                    config.height.max(1),
                ))
                .usage(
                    wgpu::TextureUsages::RENDER_ATTACHMENT | wgpu::TextureUsages::TEXTURE_BINDING,
                ),
        );
        texture.texture_view(wgpu::TextureViewDescriptor::default());
        texture.texture_sampler(
            wgpu::wgt::SamplerDescriptor {
                label: Some("Depth sampler descriptor"),
                address_mode_u: wgpu::AddressMode::ClampToEdge,
                address_mode_v: wgpu::AddressMode::ClampToEdge,
                address_mode_w: wgpu::AddressMode::ClampToEdge,
                mag_filter: wgpu::FilterMode::Linear,
                min_filter: wgpu::FilterMode::Linear,
                mipmap_filter: wgpu::FilterMode::Nearest,
                lod_min_clamp: 0.0,
                lod_max_clamp: 100.0,
                compare: Some(Self::compare()),
                ..Default::default()
            },
            renderer,
        );

        texture
    }
    /// Create a new depth texture
    fn create(renderer: &Renderer) -> Self;
    /// Return the render pass config
    fn stencil_attachment(&self) -> wgpu::RenderPassDepthStencilAttachment;
}
/// Function to create a new depth_texture from a renderer
pub trait RenderPassCreateDepthTexture {
    fn create_depth_texture<T: DepthTexture>(&self) -> T;
}
impl RenderPassCreateDepthTexture for steamengine_renderer::Renderer<'_> {
    fn create_depth_texture<T: DepthTexture>(&self) -> T {
        T::create(self)
    }
}

/// Default implementation
pub struct DefaultDepthTexture {
    texture: Texture,
}
impl DepthTexture for DefaultDepthTexture {
    fn create(renderer: &Renderer) -> Self {
        let texture = Self::create_texture(renderer);
        Self { texture }
    }
    fn stencil_attachment(&self) -> wgpu::RenderPassDepthStencilAttachment {
        let texture = &self.texture;
        wgpu::RenderPassDepthStencilAttachment {
            view: texture
                .texture_view
                .as_ref()
                .expect("Texture view in depth texture not initilized"),
            depth_ops: Some(wgpu::Operations {
                load: wgpu::LoadOp::Clear(1.0),
                store: wgpu::StoreOp::Store,
            }),
            stencil_ops: None,
        }
    }
}