Fix imgui renderer once and for all

Finally solved the problems with the imgui renderer after a long chat with clankers. Fixed some other stuff as well.

Reminder to keep the rendered_this_frame check as that's what solved it. Probably a deeper issue down there that caused us to render twice, but whatever.
This commit is contained in:
reo 2025-09-10 01:31:43 +03:00
parent 15122b8ebd
commit 0c0d5cdb2a
7 changed files with 77 additions and 51 deletions

1
Cargo.lock generated
View file

@ -1380,6 +1380,7 @@ dependencies = [
"raidillon_engine", "raidillon_engine",
"raidillon_glium", "raidillon_glium",
"raidillon_platform", "raidillon_platform",
"winit",
] ]
[[package]] [[package]]

View file

@ -15,10 +15,10 @@ pub struct SystemContext<'a> {
pub trait System { pub trait System {
/// Initialize the system. /// Initialize the system.
fn initialize(&mut self); fn initialize(&mut self) {}
/// Spawn the first entities of the world. /// Spawn the first entities of the world.
fn load_world(&mut self, ctx: &mut SystemContext); fn load_world(&mut self, ctx: &mut SystemContext) {}
fn update(&mut self, ctx: &mut SystemContext); fn update(&mut self, ctx: &mut SystemContext) {}
} }
pub type SystemID = &'static str; pub type SystemID = &'static str;

View file

@ -15,3 +15,4 @@ raidillon_ecs = { path = "../ecs" }
raidillon_engine = { path = "../engine" } raidillon_engine = { path = "../engine" }
raidillon_glium = { path = "../glium_platform", optional = true } raidillon_glium = { path = "../glium_platform", optional = true }
glam = "0.30.5" glam = "0.30.5"
winit = "0.30.12"

View file

@ -11,15 +11,39 @@ use raidillon_core::scene::Scene;
#[cfg(feature = "glium")] #[cfg(feature = "glium")]
use raidillon_glium::GliumPlatform; use raidillon_glium::GliumPlatform;
use raidillon_core::DebugUIBuffer; use raidillon_core::DebugUIBuffer;
use winit::event::{Event, WindowEvent};
const TEST_GLTF: &str = "pink-monkey.gltf"; const TEST_GLTF: &str = "pink-monkey.gltf";
const RENDERING_TEST_SYSTEM: &str = "rendering_test_system"; const RENDERING_TEST_SYSTEM: &str = "rendering_test_system";
const UPDATE_ASPECT_RATIO_SYSTEM: &str = "update_aspect_ratio_system";
const MAIN_SCENE_ID: &str = "main_scene"; const MAIN_SCENE_ID: &str = "main_scene";
struct RenderingTestSystem; struct UpdateAspectRatioSystem;
impl System for UpdateAspectRatioSystem {
fn initialize(&mut self) {}
fn load_world(&mut self, ctx: &mut SystemContext) {}
fn update(&mut self, ctx: &mut SystemContext) {
// FIXME: Need an event handler rework for systems.
match &ctx.platform_context.current_event {
Event::WindowEvent { event, .. } => match event {
WindowEvent::Resized(sz) => {
let _ = ctx.scene.world.query_mut::<&mut Camera>().into_iter().map(|mut cam| {
cam.1.aspect = sz.width as f32 / sz.height as f32;
});
}
_ => {}
},
_ => {}
}
}
}
struct RenderingTestSystem;
impl System for RenderingTestSystem { impl System for RenderingTestSystem {
fn initialize(&mut self) {} fn initialize(&mut self) {}
fn load_world(&mut self, ctx: &mut SystemContext) { fn load_world(&mut self, ctx: &mut SystemContext) {
@ -61,6 +85,7 @@ fn main() {
// engine.system_manager.add_system("spawn_chunks".to_string(), ChunkSystem); // engine.system_manager.add_system("spawn_chunks".to_string(), ChunkSystem);
// engine.system_manager.add_system("movement".to_string(), MovementSystem); // engine.system_manager.add_system("movement".to_string(), MovementSystem);
engine.system_manager.add_system(RENDERING_TEST_SYSTEM, Box::new(RenderingTestSystem)); engine.system_manager.add_system(RENDERING_TEST_SYSTEM, Box::new(RenderingTestSystem));
engine.system_manager.add_system(UPDATE_ASPECT_RATIO_SYSTEM, Box::new(UpdateAspectRatioSystem));
// Set up the scene // Set up the scene
let main_scene = Scene::new( let main_scene = Scene::new(

View file

@ -75,6 +75,11 @@ impl<E: EngineTrait> Platform<E> for GliumPlatform<E> {
}; };
self.engine.initialize(ctx.clone()); self.engine.initialize(ctx.clone());
let _ = &self.event_loop.run(move |event, el| { let _ = &self.event_loop.run(move |event, el| {
self.rendering_system_manager
.systems
.iter_mut()
.for_each(|(_, system)| system.handle_event(&mut self.window, event.clone()));
match event { match event {
Event::WindowEvent { event, .. } => match event { Event::WindowEvent { event, .. } => match event {
WindowEvent::CloseRequested => { WindowEvent::CloseRequested => {
@ -93,9 +98,10 @@ impl<E: EngineTrait> Platform<E> for GliumPlatform<E> {
debug_ui_buffer, debug_ui_buffer,
}; };
for (system_id, system) in self.rendering_system_manager.systems.iter_mut() { self.rendering_system_manager
system.render(&mut context); .systems
} .iter_mut()
.for_each(|(_, system)| system.render(&mut context));
target.finish().unwrap(); target.finish().unwrap();
} }
_ => {}, _ => {},
@ -104,6 +110,10 @@ impl<E: EngineTrait> Platform<E> for GliumPlatform<E> {
let mut ctx2 = ctx.clone(); let mut ctx2 = ctx.clone();
ctx2.current_event = event.clone(); ctx2.current_event = event.clone();
self.engine.update(ctx2); self.engine.update(ctx2);
self.rendering_system_manager
.systems
.iter_mut()
.for_each(|(_, system)| system.prepare_frame(&mut self.window));
self.window.request_redraw(); self.window.request_redraw();
} }
_ => {}, _ => {},

View file

@ -1,70 +1,55 @@
use std::cell::RefCell;
use std::rc::Rc;
use std::sync::Arc;
use std::time::Instant; use std::time::Instant;
use glium::Display; use glium::Display;
use glium::glutin::surface::WindowSurface; use glium::glutin::surface::WindowSurface;
use imgui::{Context as ImguiContext}; use imgui::{Context as ImguiContext};
use imgui_winit_support::{HiDpiMode, WinitPlatform}; use imgui_winit_support::{HiDpiMode, WinitPlatform};
use imgui_glium_renderer::Renderer as ImguiGliumRenderer; use imgui_glium_renderer::Renderer as ImguiGliumRenderer;
use winit::raw_window_handle::DisplayHandle;
use winit::window::Window; use winit::window::Window;
use anyhow::{Result}; use winit::event::Event;
use glium::Frame;
use crate::RenderingSystem; use crate::RenderingSystem;
use crate::system::RenderingContext; use crate::system::RenderingContext;
use glium::Frame;
use raidillon_core::DebugUIBuffer;
pub struct ImguiBridge { pub struct ImguiBridge {
imgui: ImguiContext, imgui: ImguiContext,
platform: WinitPlatform, platform: WinitPlatform,
renderer: ImguiGliumRenderer, renderer: ImguiGliumRenderer,
} last_frame: Instant,
rendered_this_frame: bool,
impl ImguiBridge {
pub fn render<F>(&mut self, target: &mut Frame, window: &Window, build_ui: F)
where
F: FnOnce(&imgui::Ui),
{
let ui = self.imgui.frame();
build_ui(&ui);
self.platform.prepare_render(ui, window);
let draw_data = self.imgui.render();
self
.renderer
.render(target, draw_data)
.expect("imgui rendering failed");
}
// pub fn initialize_frame(&mut self) -> &mut imgui::Ui {
// self.imgui.frame()
// }
//
// pub fn finish_frame(&mut self, target: &mut Frame, window: &Window, ui: imgui::Ui) {
// self.platform.prepare_render(&ui, window);
// let draw_data = self.imgui.render();
// self.renderer.render(target, draw_data).expect("imgui rendering failed");
// }
} }
impl RenderingSystem for ImguiBridge { impl RenderingSystem for ImguiBridge {
fn render(&mut self, ctx: &mut RenderingContext) { fn handle_event(&mut self, window: &mut Window, event: Event<()>) {
let mut ui = self.imgui.frame(); self.platform.handle_event(self.imgui.io_mut(), window, &event);
}
ctx.debug_ui_buffer.borrow_mut().write_buffer(&mut ui); fn prepare_frame(&mut self, window: &mut Window) {
self.rendered_this_frame = false;
let now = Instant::now();
self.imgui.io_mut().update_delta_time(now - self.last_frame);
self.last_frame = now;
self.platform
.prepare_frame(self.imgui.io_mut(), window)
.expect("Failed to prepare frame");
}
fn render(&mut self, ctx: &mut RenderingContext) {
if self.rendered_this_frame { return; }
self.rendered_this_frame = true;
let ui = self.imgui.frame();
ctx.debug_ui_buffer.borrow().write_buffer(&ui);
self.platform.prepare_render(&ui, ctx.window); self.platform.prepare_render(&ui, ctx.window);
let draw_data = self.imgui.render(); let draw_data = self.imgui.render();
if draw_data.total_vtx_count == 0 && draw_data.total_idx_count == 0 {
return;
}
self.renderer.render(ctx.target, draw_data).expect("imgui rendering failed"); self.renderer.render(ctx.target, draw_data).expect("imgui rendering failed");
} }
fn initialize(display: &Display<WindowSurface>, window: &glium::winit::window::Window) -> Self fn initialize(display: &Display<WindowSurface>, window: &Window) -> Self {
where
Self: Sized,
{
let mut imgui = ImguiContext::create(); let mut imgui = ImguiContext::create();
imgui.set_ini_filename(None); imgui.set_ini_filename(None);
let mut platform = WinitPlatform::new(&mut imgui); let mut platform = WinitPlatform::new(&mut imgui);
@ -76,6 +61,8 @@ impl RenderingSystem for ImguiBridge {
imgui, imgui,
platform, platform,
renderer, renderer,
last_frame: Instant::now(),
rendered_this_frame: false,
} }
} }
} }

View file

@ -19,6 +19,8 @@ pub struct RenderingContext<'a> {
/// The internal "rendering system" trait of glium_platform. /// The internal "rendering system" trait of glium_platform.
/// This is unrelated to the main System trait in core. /// This is unrelated to the main System trait in core.
pub trait RenderingSystem { pub trait RenderingSystem {
fn handle_event(&mut self, window: &mut glium::winit::window::Window, event: winit::event::Event<()>) {}
fn prepare_frame(&mut self, window: &mut glium::winit::window::Window) {}
fn render(&mut self, ctx: &mut RenderingContext); fn render(&mut self, ctx: &mut RenderingContext);
fn initialize(display: &Display<WindowSurface>, window: &glium::winit::window::Window) -> Self where Self: Sized; fn initialize(display: &Display<WindowSurface>, window: &glium::winit::window::Window) -> Self where Self: Sized;
} }