Skip to main content

dear_imgui_wgpu/renderer/
lifecycle.rs

1use super::WgpuRenderer;
2use crate::{FrameResources, RenderResources, RendererResult};
3
4impl WgpuRenderer {
5    /// Called every frame to prepare for rendering
6    ///
7    /// This corresponds to ImGui_ImplWGPU_NewFrame in the C++ implementation
8    pub fn new_frame(&mut self) -> RendererResult<()> {
9        let needs_recreation = if let Some(backend_data) = &self.backend_data {
10            backend_data.pipeline_state.is_none()
11        } else {
12            false
13        };
14
15        if needs_recreation {
16            // Extract the backend data temporarily to avoid borrow checker issues
17            let mut backend_data = self.backend_data.take().unwrap();
18            self.create_device_objects(&mut backend_data)?;
19            self.backend_data = Some(backend_data);
20        }
21        Ok(())
22    }
23
24    /// Invalidate device objects
25    ///
26    /// This corresponds to ImGui_ImplWGPU_InvalidateDeviceObjects in the C++ implementation
27    pub fn invalidate_device_objects(&mut self) -> RendererResult<()> {
28        if let Some(ref mut backend_data) = self.backend_data {
29            backend_data.pipeline_state = None;
30            backend_data.render_resources = RenderResources::new();
31
32            // Clear frame resources
33            for frame_resources in &mut backend_data.frame_resources {
34                *frame_resources = FrameResources::new();
35            }
36        }
37
38        // Clear texture manager
39        self.texture_manager.clear();
40        self.default_texture = None;
41
42        Ok(())
43    }
44
45    /// Shutdown the renderer
46    ///
47    /// This corresponds to ImGui_ImplWGPU_Shutdown in the C++ implementation.
48    ///
49    /// If multi-viewport support was enabled, this also makes renderer callbacks no-op for this
50    /// renderer. Call the matching multi-viewport shutdown helper when you also need to uninstall
51    /// callbacks from the ImGui context and destroy platform windows.
52    pub fn shutdown(&mut self) {
53        #[cfg(any(feature = "multi-viewport-winit", feature = "multi-viewport-sdl3"))]
54        self.clear_multi_viewport_renderer_state();
55        self.invalidate_device_objects().ok();
56        self.backend_data = None;
57    }
58
59    #[cfg(any(feature = "multi-viewport-winit", feature = "multi-viewport-sdl3"))]
60    pub(super) fn clear_multi_viewport_renderer_state(&mut self) {
61        // Make any installed multi-viewport callbacks become a no-op if the renderer is
62        // shut down or dropped without an explicit disable/shutdown call.
63        #[cfg(feature = "multi-viewport-winit")]
64        {
65            super::multi_viewport::clear_for_drop(self as *mut WgpuRenderer);
66        }
67        #[cfg(feature = "multi-viewport-sdl3")]
68        {
69            super::multi_viewport_sdl3::clear_for_drop(self as *mut WgpuRenderer);
70        }
71    }
72}