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 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
//! This module covers definition and functionality for an individual window.
use std::collections::HashMap;
use std::num::NonZeroU32;
use std::{mem, sync::Arc};
use crate::multi_window::NewWindowRequest;
use egui_glow::glow;
use egui_glow::EguiGlow;
use glutin::context::{NotCurrentContext, PossiblyCurrentContext};
use glutin::prelude::{GlConfig, GlDisplay};
use glutin::prelude::{
NotCurrentGlContextSurfaceAccessor, PossiblyCurrentContextGlSurfaceAccessor,
};
use glutin::surface::GlSurface;
use glutin::surface::SurfaceAttributesBuilder;
use glutin::surface::WindowSurface;
use raw_window_handle::{HasRawDisplayHandle, HasRawWindowHandle};
use thiserror::Error;
use winit::{
event::Event,
event_loop::{ControlFlow, EventLoopWindowTarget},
};
/// A holder of context and related items
pub struct ContextHolder<T> {
/// The context being held
context: T,
/// The window
window: winit::window::Window,
/// The window surface
ws: glutin::surface::Surface<WindowSurface>,
/// The display
display: glutin::display::Display,
}
impl<T> ContextHolder<T> {
/// Create a new context holder
fn new(
context: T,
window: winit::window::Window,
ws: glutin::surface::Surface<WindowSurface>,
display: glutin::display::Display,
) -> Self {
Self {
context,
window,
ws,
display,
}
}
}
impl ContextHolder<PossiblyCurrentContext> {
/// Call swap_buffers. linux targets have vsync specifically disabled because it causes problems with hidden windows.
fn swap_buffers(&self) -> glutin::error::Result<()> {
#[cfg(target_os = "linux")]
{
let _e = self
.ws
.set_swap_interval(&self.context, glutin::surface::SwapInterval::DontWait);
}
self.ws.swap_buffers(&self.context)
}
/// Resize the window to the specified size. The size cannot be zero in either dimension.
fn resize(&self, size: winit::dpi::PhysicalSize<u32>) {
let w = size.width;
let h = size.height;
self.ws.resize(
&self.context,
NonZeroU32::new(w).unwrap(),
NonZeroU32::new(h).unwrap(),
)
}
/// Make a possibly current context current
fn make_current(&self) -> glutin::error::Result<()> {
self.context.make_current(&self.ws)
}
/// convenience function to call get_proc_address on the display of this struct
fn get_proc_address(&self, s: &str) -> *const std::ffi::c_void {
let cs: *const std::ffi::c_char = s.as_ptr().cast();
let cst = unsafe { std::ffi::CStr::from_ptr(cs) };
self.display.get_proc_address(cst)
}
}
impl ContextHolder<NotCurrentContext> {
/// Transforms a not current context into a possibly current context
fn make_current(self) -> Result<ContextHolder<PossiblyCurrentContext>, glutin::error::Error> {
let c = self.context.make_current(&self.ws).unwrap();
let s = ContextHolder::<PossiblyCurrentContext> {
context: c,
window: self.window,
ws: self.ws,
display: self.display,
};
Ok(s)
}
}
/// The return value of the redraw function of trait `TrackedWindow<T>`
pub struct RedrawResponse<T> {
/// Should the window exit?
pub quit: bool,
/// A list of windows that the window desires to have created.
pub new_windows: Vec<NewWindowRequest<T>>,
}
/// A window being tracked by a `MultiWindow`. All tracked windows will be forwarded all events
/// received on the `MultiWindow`'s event loop.
pub trait TrackedWindow<T> {
/// Returns true if the window is a root window. Root windows will close all other windows when closed. Windows are not root windows by default.
/// It is completely valid to have more than one root window open at the same time. The program will exit when all root windows are closed.
fn is_root(&self) -> bool {
false
}
/// Returns true when the window is allowed to close. Default is windows are always allowed to close. Override to change this behavior.
fn can_quit(&mut self, _c: &mut T) -> bool {
true
}
/// Sets whether or not the window is a root window. Does nothing by default
fn set_root(&mut self, _root: bool) {}
/// Runs the redraw for the window. See RedrawResponse for the return value.
fn redraw(
&mut self,
c: &mut T,
egui: &mut EguiGlow,
window: &winit::window::Window,
) -> RedrawResponse<T>;
/// Allows opengl rendering to be done underneath all of the egui stuff of the window
/// # Safety
///
/// opengl functions are unsafe. This function would require calling opengl functions.
unsafe fn opengl_before(&mut self, _c: &mut T, _gl: &Arc<egui_glow::painter::Context>) {}
/// Allows opengl rendering to be done on top of all of the egui stuff of the window
/// # Safety
///
/// opengl functions are unsafe. This function would require calling opengl functions.
unsafe fn opengl_after(&mut self, _c: &mut T, _gl: &Arc<egui_glow::painter::Context>) {}
}
/// Handles one event from the event loop. Returns true if the window needs to be kept alive,
/// otherwise it will be closed. Window events should be checked to ensure that their ID is one
/// that the TrackedWindow is interested in.
fn handle_event<COMMON, U>(
s: &mut dyn TrackedWindow<COMMON>,
event: &winit::event::Event<U>,
c: &mut COMMON,
egui: &mut EguiGlow,
root_window_exists: bool,
gl_window: &mut ContextHolder<PossiblyCurrentContext>,
) -> TrackedWindowControl<COMMON> {
// Child window's requested control flow.
let mut control_flow = ControlFlow::Wait; // Unless this changes, we're fine waiting until the next event comes in.
let mut redraw = || {
let input = egui.egui_winit.take_egui_input(&gl_window.window);
let ppp = input.pixels_per_point;
egui.egui_ctx.begin_frame(input);
let rr = s.redraw(c, egui, &gl_window.window);
let full_output = egui.egui_ctx.end_frame();
if rr.quit {
control_flow = winit::event_loop::ControlFlow::Exit;
} else if full_output.repaint_after.is_zero() {
gl_window.window.request_redraw();
control_flow = winit::event_loop::ControlFlow::Poll;
} else if full_output.repaint_after.as_millis() > 0 && full_output.repaint_after.as_millis() < 10000 {
control_flow = winit::event_loop::ControlFlow::WaitUntil(
std::time::Instant::now() + full_output.repaint_after,
);
} else {
control_flow = winit::event_loop::ControlFlow::Wait;
};
{
let color = egui::Rgba::from_white_alpha(0.0);
unsafe {
use glow::HasContext as _;
egui.painter
.gl()
.clear_color(color[0], color[1], color[2], color[3]);
egui.painter.gl().clear(glow::COLOR_BUFFER_BIT);
}
// draw things behind egui here
unsafe { s.opengl_before(c, egui.painter.gl()) };
let prim = egui.egui_ctx.tessellate(full_output.shapes);
egui.painter.paint_and_update_textures(
gl_window.window.inner_size().into(),
ppp.unwrap_or(1.0),
&prim[..],
&full_output.textures_delta,
);
// draw things on top of egui here
unsafe { s.opengl_after(c, egui.painter.gl()) };
gl_window.swap_buffers().unwrap();
}
rr
};
let response = match event {
// Platform-dependent event handlers to workaround a winit bug
// See: https://github.com/rust-windowing/winit/issues/987
// See: https://github.com/rust-windowing/winit/issues/1619
winit::event::Event::RedrawEventsCleared if cfg!(windows) => Some(redraw()),
winit::event::Event::RedrawRequested(_) if !cfg!(windows) => Some(redraw()),
winit::event::Event::WindowEvent { event, .. } => {
if let winit::event::WindowEvent::Resized(physical_size) = event {
gl_window.resize(*physical_size);
}
if let winit::event::WindowEvent::CloseRequested = event {
control_flow = winit::event_loop::ControlFlow::Exit;
}
let resp = egui.on_event(event);
if resp.repaint {
gl_window.window.request_redraw();
}
None
}
winit::event::Event::LoopDestroyed => {
egui.destroy();
None
}
_ => None,
};
if !root_window_exists && !s.is_root() {
control_flow = ControlFlow::Exit;
}
TrackedWindowControl {
requested_control_flow: control_flow,
windows_to_create: if let Some(a) = response {
a.new_windows
} else {
Vec::new()
},
}
}
/// The options for a window.
pub struct TrackedWindowOptions {
/// Should the window be vsynced. Check github issues to see if this property actually does what it is supposed to.
pub vsync: bool,
/// Optionally sets the shader version for the window.
pub shader: Option<egui_glow::ShaderVersion>,
}
/// The main container for a window. Contains all required data for operating and maintaining a window.
pub struct TrackedWindowContainer<T, U> {
/// The context for the window
pub gl_window: IndeterminateWindowedContext,
/// The egui instance for this window, each window has a separate egui instance.
pub egui: Option<EguiGlow>,
/// The actual window
pub window: Box<dyn TrackedWindow<T>>,
/// The optional shader version for the window
pub shader: Option<egui_glow::ShaderVersion>,
/// Nothing, indicates that the type U is to be treated as if it exists.
_phantom: std::marker::PhantomData<U>,
}
impl<T, U> TrackedWindowContainer<T, U> {
/// Create a new window.
pub fn create<TE>(
window: Box<dyn TrackedWindow<T>>,
window_builder: winit::window::WindowBuilder,
event_loop: &winit::event_loop::EventLoopWindowTarget<TE>,
options: &TrackedWindowOptions,
) -> Result<TrackedWindowContainer<T, U>, DisplayCreationError> {
let rdh = event_loop.raw_display_handle();
let winitwindow = window_builder.build(event_loop).unwrap();
let rwh = winitwindow.raw_window_handle();
#[cfg(target_os = "windows")]
let pref = glutin::display::DisplayApiPreference::Wgl(Some(rwh));
#[cfg(target_os = "linux")]
let pref = glutin::display::DisplayApiPreference::Egl;
#[cfg(target_os = "macos")]
let pref = glutin::display::DisplayApiPreference::Cgl;
let display = unsafe { glutin::display::Display::new(rdh, pref) };
if let Ok(display) = display {
let configt = glutin::config::ConfigTemplateBuilder::default().build();
let config = unsafe { display.find_configs(configt) }
.unwrap()
.reduce(|config, acc| {
if config.num_samples() > acc.num_samples() {
config
} else {
acc
}
});
if let Some(config) = config {
let sab: SurfaceAttributesBuilder<WindowSurface> =
glutin::surface::SurfaceAttributesBuilder::default();
let sa = sab.build(
rwh,
std::num::NonZeroU32::new(winitwindow.inner_size().width).unwrap(),
std::num::NonZeroU32::new(winitwindow.inner_size().height).unwrap(),
);
let ws = unsafe { display.create_window_surface(&config, &sa).unwrap() };
let attr = glutin::context::ContextAttributesBuilder::new().build(Some(rwh));
let gl_window = unsafe { display.create_context(&config, &attr).unwrap() };
return Ok(TrackedWindowContainer {
window,
gl_window: IndeterminateWindowedContext::NotCurrent(ContextHolder::new(
gl_window,
winitwindow,
ws,
display,
)),
egui: None,
shader: options.shader,
_phantom: std::marker::PhantomData,
});
}
}
panic!("No window created");
}
/// Returns true if the specified event is for this window. A UserEvent (one generated by the EventLoopProxy) is not for any window.
pub fn is_event_for_window(&self, event: &winit::event::Event<U>) -> bool {
// Check if the window ID matches, if not then this window can pass on the event.
match (event, &self.gl_window) {
(Event::UserEvent(_), _) => false,
(
Event::WindowEvent {
window_id: id,
event: _,
..
},
IndeterminateWindowedContext::PossiblyCurrent(gl_window),
) => gl_window.window.id() == *id,
(
Event::WindowEvent {
window_id: id,
event: _,
..
},
IndeterminateWindowedContext::NotCurrent(gl_window),
) => gl_window.window.id() == *id,
_ => true, // we weren't able to check the window ID, maybe this window is not initialized yet. we should run it.
}
}
/// The outer event handler for a window. Responsible for activating the context, creating the egui context if required, and calling handle_event.
pub fn handle_event_outer(
&mut self,
c: &mut T,
event: &winit::event::Event<U>,
el: &EventLoopWindowTarget<U>,
root_window_exists: bool,
fontmap: &HashMap<String, egui::FontData>,
) -> TrackedWindowControl<T> {
// Activate this gl_window so we can use it.
// We cannot activate it without full ownership, so temporarily move the gl_window into the current scope.
// It *must* be returned at the end.
let gl_window = mem::replace(&mut self.gl_window, IndeterminateWindowedContext::None);
let mut gl_window = match gl_window {
IndeterminateWindowedContext::PossiblyCurrent(w) => {
let _e = w.make_current();
w
}
IndeterminateWindowedContext::NotCurrent(w) => w.make_current().unwrap(),
IndeterminateWindowedContext::None => panic!("there's no window context???"),
};
// Now that the window is active, create a context if it is missing.
match self.egui.as_ref() {
None => {
let gl = Arc::new(unsafe {
glow::Context::from_loader_function(|s| gl_window.get_proc_address(s))
});
unsafe {
use glow::HasContext as _;
gl.enable(glow::FRAMEBUFFER_SRGB);
}
let egui = egui_glow::EguiGlow::new(el, gl, self.shader);
{
let mut fonts = egui::FontDefinitions::default();
for (name, font) in fontmap {
fonts.font_data.insert(name.clone(), font.clone());
fonts.families.insert(
egui::FontFamily::Name(name.to_owned().into()),
vec![name.to_owned()],
);
}
egui.egui_ctx.set_fonts(fonts)
}
self.egui = Some(egui);
}
Some(_) => (),
};
let result = match self.egui.as_mut() {
Some(egui) => {
let result = handle_event(
&mut *self.window,
event,
c,
egui,
root_window_exists,
&mut gl_window,
);
if let ControlFlow::Exit = result.requested_control_flow {
if self.window.can_quit(c) {
// This window wants to go away. Close it.
egui.destroy();
}
};
result
}
_ => {
panic!("Window wasn't fully initialized");
}
};
match mem::replace(
&mut self.gl_window,
IndeterminateWindowedContext::PossiblyCurrent(gl_window),
) {
IndeterminateWindowedContext::None => (),
_ => {
panic!("Window had a GL context while we were borrowing it?");
}
}
result
}
}
/// Enum of the potential options for a window context
pub enum IndeterminateWindowedContext {
/// The window context is possibly current
PossiblyCurrent(ContextHolder<PossiblyCurrentContext>),
/// The window context is not current
NotCurrent(ContextHolder<NotCurrentContext>),
/// The window context is empty
None,
}
/// The eventual return struct of the `TrackedWindow<T>` trait update function. Used internally for window management.
pub struct TrackedWindowControl<T> {
/// Indicates how the window desires to respond to future events
pub requested_control_flow: ControlFlow,
/// A list of windows to be created
pub windows_to_create: Vec<NewWindowRequest<T>>,
}
#[derive(Error, Debug)]
/// Enumerates the kinds of errors that display creation can have.
pub enum DisplayCreationError {}