vk-graph-hot 0.1.1

Hot-reloading shader pipelines for vk-graph
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

//! Hot-reload ray tracing pipeline support.

use {
    super::{
        HotPipeline, compile_shaders_and_watch, create_watcher, pipeline, pipeline_handle,
        shader::HotShader,
    },
    log::info,
    std::sync::{
        Arc, RwLock,
        atomic::{AtomicBool, Ordering},
    },
    vk_graph::{
        cmd::{Command, Pipeline},
        driver::{
            DriverError,
            device::Device,
            ray_tracing::{RayTracingPipeline, RayTracingPipelineInfo, RayTracingShaderGroup},
        },
    },
};

/// A ray tracing pipeline wrapper that recompiles its shaders when source files change.
#[derive(Debug)]
pub struct HotRayTracingPipeline {
    cache: RwLock<HotPipeline<RayTracingPipeline>>,
    device: Device,
    has_changes: Arc<AtomicBool>,
    shader_groups: Box<[RayTracingShaderGroup]>,
    shaders: Box<[HotShader]>,
}

impl HotRayTracingPipeline {
    /// Creates a hot-reload ray tracing pipeline from shader files and shader groups.
    pub fn create<S>(
        device: &Device,
        info: impl Into<RayTracingPipelineInfo>,
        shaders: impl IntoIterator<Item = S>,
        shader_groups: impl IntoIterator<Item = RayTracingShaderGroup>,
    ) -> Result<Self, DriverError>
    where
        S: Into<HotShader>,
    {
        let shaders = shaders.into_iter().map(Into::into).collect::<Box<_>>();
        let shader_groups = shader_groups.into_iter().collect::<Box<_>>();

        let has_changes = Default::default();
        let mut watcher = create_watcher(&has_changes);

        let pipeline = RayTracingPipeline::create(
            device,
            info,
            compile_shaders_and_watch(&shaders, &mut watcher)?,
            shader_groups.iter().copied(),
        )?;

        Ok(Self {
            cache: RwLock::new(HotPipeline { pipeline, watcher }),
            device: device.clone(),
            has_changes,
            shader_groups,
            shaders,
        })
    }

    fn compile_shader_and_bind_cmd<'a>(
        &self,
        cmd: Command<'a>,
    ) -> <RayTracingPipeline as Pipeline<'a>>::Command {
        if self.has_changes.swap(false, Ordering::Relaxed) {
            info!("Shader change detected");

            let mut cache = self.cache_mut();

            if let Ok(shaders) = compile_shaders_and_watch(&self.shaders, &mut cache.watcher)
                && let Ok(pipeline) = RayTracingPipeline::create(
                    &self.device,
                    cache.pipeline.info(),
                    shaders,
                    self.shader_groups.iter().copied(),
                )
            {
                cache.pipeline = pipeline;
            }
        }

        self.cache().pipeline.clone().bind_cmd(cmd)
    }
}

pipeline!(RayTracingPipeline);
pipeline_handle!(HotRayTracingPipeline);