wgpui 0.4.1

Independent wgpu + winit UI framework (community fork of GPUI / GPUI-CE 0.3.3)
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
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
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
use crate::{
    AnyWindowHandle, Bounds, Capslock, FrameCapture, FrameCaptureError, Modifiers, Pixels,
    PlatformInputHandler, PlatformWindow, Point, Size, WgpuSurfaceHandle, WindowAppearance,
    WindowBackgroundAppearance, WindowBounds,
    platform::{
        atlas::WgpuAtlas, dispatcher::CrossEvent, render_context::WgpuContext,
        renderer::WgpuRenderer,
    },
};
use futures::channel::oneshot;
use std::{
    cell::{Cell, OnceCell, RefCell},
    rc::Rc,
    sync::Arc,
};
use winit::event_loop::EventLoopProxy;

#[derive(Clone)]
pub struct CrossWindow(pub(crate) Rc<CrossWindowInner>);

pub(crate) struct CrossWindowInner {
    pub(crate) winit_window: OnceCell<Arc<winit::window::Window>>,
    pub(crate) renderer: OnceCell<RefCell<WgpuRenderer>>,
    pub(crate) wgpu_context: Arc<WgpuContext>,
    pub(crate) sprite_atlas: Arc<WgpuAtlas>,
    pub(crate) event_loop_proxy: EventLoopProxy<CrossEvent>,
    pub(crate) handle: AnyWindowHandle,
    pub(crate) hovered: Cell<bool>,
    pub(crate) accessibility_adapter: OnceCell<RefCell<accesskit_winit::Adapter>>,
    pub(crate) state: CrossWindowState,
    surfaces_closed: Cell<bool>,
    surface_owner: OnceCell<crate::platform::surface_registry::SurfaceOwner>,
}

impl CrossWindowInner {
    fn close_surfaces(&self) {
        if !self.surfaces_closed.replace(true) {
            if let Some(owner) = self.surface_owner.get() {
                self.wgpu_context.surface_registry.close_owner(*owner);
            }
        }
    }
}
impl Drop for CrossWindowInner {
    fn drop(&mut self) {
        self.close_surfaces();
    }
}

#[derive(Default)]
pub(crate) struct CrossWindowState {
    pub(crate) callbacks: Callbacks,
    pub(crate) input_handler: RefCell<Option<PlatformInputHandler>>,
    pub(crate) mouse_position: Cell<Point<Pixels>>,
    pub(crate) touch_ids: RefCell<collections::FxHashMap<u64, crate::TouchId>>,
    pub(crate) next_touch_id: Cell<u64>,
    pub(crate) modifiers: Cell<Modifiers>,
    pub(crate) capslock: Cell<Capslock>,
    pub(crate) occluded: Cell<bool>,
    pub(crate) accessibility_active: Cell<bool>,
    pub(crate) text_input_configuration: RefCell<crate::TextInputConfiguration>,
}

#[derive(Default)]
pub(crate) struct Callbacks {
    pub(crate) on_request_frame: Cell<Option<Box<dyn FnMut(crate::RequestFrameOptions)>>>,
    pub(crate) on_input:
        Cell<Option<Box<dyn FnMut(crate::PlatformInput) -> crate::DispatchEventResult>>>,
    pub(crate) on_active_status_change: Cell<Option<Box<dyn FnMut(bool)>>>,
    pub(crate) on_hover_status_change: Cell<Option<Box<dyn FnMut(bool)>>>,
    pub(crate) on_resize: Cell<Option<Box<dyn FnMut(crate::Size<crate::Pixels>, f32)>>>,
    pub(crate) on_moved: Cell<Option<Box<dyn FnMut()>>>,
    pub(crate) on_visibility_change: Cell<Option<Box<dyn FnMut(bool)>>>,
    pub(crate) on_visual_viewport_changed: Cell<Option<Box<dyn FnMut()>>>,
    pub(crate) on_accessibility_event: Cell<Option<Box<dyn FnMut(accesskit_winit::WindowEvent)>>>,
    pub(crate) on_should_close: Cell<Option<Box<dyn FnMut() -> bool>>>,
    pub(crate) on_hit_test_window_control:
        Cell<Option<Box<dyn FnMut() -> Option<crate::WindowControlArea>>>>,
    pub(crate) on_close: Cell<Option<Box<dyn FnOnce()>>>,
    pub(crate) on_appearance_changed: Cell<Option<Box<dyn FnMut()>>>,
}

impl Callbacks {
    pub(crate) fn invoke_mut<F: ?Sized>(
        &self,
        cell: &Cell<Option<Box<F>>>,
        f: impl FnOnce(&mut F),
    ) {
        if let Some(mut cb) = cell.take() {
            f(&mut cb);
            cell.set(Some(cb));
        }
    }
}

impl CrossWindow {
    pub(crate) fn new(
        wgpu_context: Arc<WgpuContext>,
        event_loop_proxy: EventLoopProxy<CrossEvent>,
        handle: AnyWindowHandle,
    ) -> Self {
        let sprite_atlas = Arc::new(WgpuAtlas::new(wgpu_context.clone()));

        Self(Rc::new(CrossWindowInner {
            winit_window: OnceCell::new(),
            wgpu_context,
            renderer: OnceCell::new(),
            sprite_atlas,
            event_loop_proxy,
            handle,
            hovered: Cell::new(false),
            accessibility_adapter: OnceCell::new(),
            state: CrossWindowState::default(),
            surfaces_closed: Cell::new(false),
            surface_owner: OnceCell::new(),
        }))
    }

    pub(crate) fn close_surfaces(&self) {
        self.0.close_surfaces();
    }

    pub(crate) fn configure_retry_deadline(&self) -> Option<std::time::Instant> {
        let size = self.0.winit_window.get()?.inner_size();
        // A minimized window cannot configure or draw; its resize event resumes recovery.
        if size.width == 0 || size.height == 0 {
            return None;
        }
        self.0
            .renderer
            .get()
            .and_then(|renderer| renderer.borrow().configure_retry_deadline())
    }

    pub(crate) fn handle(&self) -> crate::AnyWindowHandle {
        self.0.handle
    }

    pub(crate) fn set_hovered(&self, hovered: bool) {
        let was_hovered = self.0.hovered.replace(hovered);
        if was_hovered != hovered {
            self.0.state.callbacks.invoke_mut(
                &self.0.state.callbacks.on_hover_status_change,
                |callback| {
                    callback(hovered);
                },
            );
        }
    }

    /// Runs `f` with the window's input handler taken out of its cell, then puts it back.
    ///
    /// The handler must never stay borrowed across `f`: applying text runs view code, and
    /// that code can flush queued effects and re-enter the window — a queued
    /// `Window::draw` takes the input handler back out — so a `borrow_mut()` still live
    /// at the re-entry point panics with `RefCell already borrowed` and kills the process.
    /// This mirrors the take/call/put-back discipline `Window` already uses around
    /// `dispatch_input`, `accepts_text_input` and `selected_bounds`.
    pub(crate) fn with_input_handler(&self, f: impl FnOnce(&mut PlatformInputHandler)) {
        with_taken_handler(&self.0.state.input_handler, f);
    }

    pub(crate) fn initialize(
        &self,
        winit_window: winit::window::Window,
        event_loop: &winit::event_loop::ActiveEventLoop,
    ) {
        let initial_size = winit_window.inner_size();
        let owner = self
            .0
            .wgpu_context
            .surface_registry
            .open_owner(winit_window.id());
        assert!(
            self.0.surface_owner.set(owner).is_ok(),
            "surface owner already initialized"
        );

        self.0
            .winit_window
            .set(Arc::new(winit_window))
            .expect("winit_window already initialized");

        self.0
            .accessibility_adapter
            .set(RefCell::new(
                accesskit_winit::Adapter::with_event_loop_proxy(
                    event_loop,
                    self.window(),
                    self.0.event_loop_proxy.clone(),
                ),
            ))
            .unwrap_or_else(|_| panic!("accessibility adapter already initialized"));

        if initial_size.width > 0 && initial_size.height > 0 {
            let renderer = WgpuRenderer::new(
                self.0.wgpu_context.clone(),
                self.window(),
                self.0.sprite_atlas.clone(),
                initial_size.width,
                initial_size.height,
                4,
            )
            .expect("Failed to create renderer");

            let _ = self.0.renderer.set(RefCell::new(renderer));
            self.window().request_redraw();
        }
    }

    pub(crate) fn window(&self) -> &winit::window::Window {
        self.0
            .winit_window
            .get()
            .expect("winit_window should be initialized")
    }
}

impl PlatformWindow for CrossWindow {
    fn on_visual_viewport_changed(&self, callback: Box<dyn FnMut()>) {
        self.0
            .state
            .callbacks
            .on_visual_viewport_changed
            .set(Some(callback));
    }

    fn is_a11y_active(&self) -> bool {
        self.0.state.accessibility_active.get()
    }

    fn update_a11y(&self, update: accesskit::TreeUpdate) {
        if let Some(adapter) = self.0.accessibility_adapter.get() {
            adapter.borrow_mut().update_if_active(|| update);
        }
    }

    fn on_accessibility_event(&self, callback: Box<dyn FnMut(accesskit_winit::WindowEvent)>) {
        self.0
            .state
            .callbacks
            .on_accessibility_event
            .set(Some(callback));
    }

    fn bounds(&self) -> Bounds<Pixels> {
        let scale_factor = self.window().scale_factor() as f32;
        let physical_size = self.window().inner_size();
        let origin = self
            .window()
            .outer_position()
            .map(|pos| Point {
                x: Pixels(pos.x as f32 / scale_factor),
                y: Pixels(pos.y as f32 / scale_factor),
            })
            .unwrap_or_default();

        Bounds {
            origin,
            size: Size {
                width: Pixels(physical_size.width as f32 / scale_factor),
                height: Pixels(physical_size.height as f32 / scale_factor),
            },
        }
    }

    fn is_resizable(&self) -> bool {
        self.window().is_resizable()
    }

    fn is_visible(&self) -> bool {
        self.window().is_visible().unwrap_or(true) && !self.0.state.occluded.get()
    }

    fn set_text_input_configuration(&self, configuration: &crate::TextInputConfiguration) {
        // Winit exposes IME purpose, but no per-field capitalization or enter-key hint.
        // Preserve those preferences for backends that can apply richer native sessions.
        self.0
            .state
            .text_input_configuration
            .replace(configuration.clone());
        self.window()
            .set_ime_purpose(winit::window::ImePurpose::Normal);
    }

    fn show_soft_keyboard(&self) {
        self.window().set_ime_allowed(true);
    }

    fn hide_soft_keyboard(&self) {
        self.window().set_ime_allowed(false);
    }

    fn is_maximized(&self) -> bool {
        self.window().is_maximized()
    }

    fn window_bounds(&self) -> crate::WindowBounds {
        let bounds = self.bounds();

        if let Some(_fullscreen) = self.window().fullscreen() {
            return WindowBounds::Fullscreen(bounds);
        }

        if self.window().is_maximized() {
            return WindowBounds::Maximized(bounds);
        }

        WindowBounds::Windowed(bounds)
    }

    fn content_size(&self) -> crate::Size<crate::Pixels> {
        let scale_factor = self.window().scale_factor() as f32;
        let physical_size = self.window().inner_size();

        crate::Size {
            width: Pixels(physical_size.width as f32 / scale_factor),
            height: Pixels(physical_size.height as f32 / scale_factor),
        }
    }

    fn resize(&mut self, size: crate::Size<crate::Pixels>) {
        let _ =
            self.window()
                .request_inner_size(winit::dpi::Size::Logical(winit::dpi::LogicalSize {
                    width: size.width.0 as f64,
                    height: size.height.0 as f64,
                }));
    }

    fn scale_factor(&self) -> f32 {
        self.window().scale_factor() as f32
    }

    fn appearance(&self) -> crate::WindowAppearance {
        match self.window().theme() {
            Some(winit::window::Theme::Light) => WindowAppearance::Light,
            Some(winit::window::Theme::Dark) => WindowAppearance::Dark,
            None => WindowAppearance::default(),
        }
    }

    fn display(&self) -> Option<std::rc::Rc<dyn crate::PlatformDisplay>> {
        let monitor = self.window().current_monitor()?;
        Some(crate::platform::platform::display_for_winit_monitor(
            &monitor,
        ))
    }

    fn mouse_position(&self) -> Point<Pixels> {
        self.0.state.mouse_position.get()
    }

    fn modifiers(&self) -> Modifiers {
        self.0.state.modifiers.get()
    }

    fn capslock(&self) -> Capslock {
        self.0.state.capslock.get()
    }

    fn set_input_handler(&mut self, input_handler: PlatformInputHandler) {
        self.0
            .state
            .input_handler
            .borrow_mut()
            .replace(input_handler);
    }

    fn take_input_handler(&mut self) -> Option<PlatformInputHandler> {
        self.0.state.input_handler.borrow_mut().take()
    }

    fn prompt(
        &self,
        _level: crate::PromptLevel,
        _msg: &str,
        _detail: Option<&str>,
        _answers: &[crate::PromptButton],
    ) -> Option<futures::channel::oneshot::Receiver<usize>> {
        None
    }

    fn activate(&self) {
        self.window().focus_window();
    }

    fn is_active(&self) -> bool {
        self.window().has_focus()
    }

    fn is_hovered(&self) -> bool {
        self.0.hovered.get()
    }

    fn set_title(&mut self, title: &str) {
        self.window().set_title(title);
    }

    fn set_background_appearance(&self, _background_appearance: WindowBackgroundAppearance) {
        // Window chrome transparency is not implemented by the WGPUI window backend.
    }

    fn minimize(&self) {
        self.window().set_minimized(true);
    }

    fn zoom(&self) {
        self.window().set_maximized(!self.window().is_maximized());
    }

    fn toggle_fullscreen(&self) {
        self.window()
            .set_fullscreen(Some(winit::window::Fullscreen::Borderless(None)));
    }

    fn is_fullscreen(&self) -> bool {
        self.window().fullscreen().is_some()
    }

    fn on_request_frame(&self, callback: Box<dyn FnMut(crate::RequestFrameOptions)>) {
        self.0.state.callbacks.on_request_frame.set(Some(callback));
    }

    fn on_input(
        &self,
        callback: Box<dyn FnMut(crate::PlatformInput) -> crate::DispatchEventResult>,
    ) {
        self.0.state.callbacks.on_input.set(Some(callback));
    }

    fn on_active_status_change(&self, callback: Box<dyn FnMut(bool)>) {
        self.0
            .state
            .callbacks
            .on_active_status_change
            .set(Some(callback));
    }

    fn on_hover_status_change(&self, callback: Box<dyn FnMut(bool)>) {
        self.0
            .state
            .callbacks
            .on_hover_status_change
            .set(Some(callback));
    }

    fn on_resize(&self, callback: Box<dyn FnMut(crate::Size<crate::Pixels>, f32)>) {
        self.0.state.callbacks.on_resize.set(Some(callback));
    }

    fn on_visibility_change(&self, callback: Box<dyn FnMut(bool)>) {
        self.0
            .state
            .callbacks
            .on_visibility_change
            .set(Some(callback));
    }

    fn on_moved(&self, callback: Box<dyn FnMut()>) {
        self.0.state.callbacks.on_moved.set(Some(callback));
    }

    fn on_should_close(&self, callback: Box<dyn FnMut() -> bool>) {
        self.0.state.callbacks.on_should_close.set(Some(callback));
    }

    fn on_hit_test_window_control(
        &self,
        callback: Box<dyn FnMut() -> Option<crate::WindowControlArea>>,
    ) {
        self.0
            .state
            .callbacks
            .on_hit_test_window_control
            .set(Some(callback));
    }

    fn on_close(&self, callback: Box<dyn FnOnce()>) {
        self.0.state.callbacks.on_close.set(Some(callback));
    }

    fn on_appearance_changed(&self, callback: Box<dyn FnMut()>) {
        self.0
            .state
            .callbacks
            .on_appearance_changed
            .set(Some(callback));
    }

    fn draw(&self, scene: &crate::Scene) {
        if let Some(renderer) = self.0.renderer.get() {
            renderer.borrow().draw(scene);
        }
    }

    fn close_surface_presentations(&self) {
        self.close_surfaces();
    }

    fn create_wgpu_surface(
        &self,
        width: u32,
        height: u32,
        format: wgpu::TextureFormat,
    ) -> Option<WgpuSurfaceHandle> {
        if self.0.surfaces_closed.get() {
            return None;
        }
        let ctx = &self.0.wgpu_context;
        let registry = ctx.surface_registry.clone();
        let window_id = self.0.winit_window.get()?.id();
        let owner = *self.0.surface_owner.get()?;
        let surface_id = registry.create(&ctx.device, width, height, format, Some(owner))?;

        // Build the present trigger: sends a CrossEvent to wake the event loop
        // and request a redraw for this window.
        let proxy = self.0.event_loop_proxy.clone();
        let delivery_registry = registry.clone();
        let present_trigger: Arc<dyn Fn() + Send + Sync> = Arc::new(move || {
            if let Err(error) = proxy.send_event(CrossEvent::SurfacePresent(window_id)) {
                log::warn!("Surface presentation event could not be delivered: {error}");
                delivery_registry.shutdown();
            }
        });

        Some(WgpuSurfaceHandle::new(
            ctx.device.clone(),
            ctx.queue.clone(),
            surface_id,
            registry,
            present_trigger,
            width,
            height,
            format,
        ))
    }

    fn sprite_atlas(&self) -> std::sync::Arc<dyn crate::PlatformAtlas> {
        self.0.sprite_atlas.clone()
    }

    fn request_frame_capture(
        &self,
    ) -> Option<oneshot::Receiver<Result<FrameCapture, FrameCaptureError>>> {
        let renderer = self.0.renderer.get()?;
        let receiver = renderer.borrow().request_frame_capture();
        // One redraw makes the frame this capture reads back. No loop is started, and this is
        // the only redraw the request causes.
        self.window().request_redraw();
        Some(receiver)
    }

    fn gpu_specs(&self) -> Option<crate::GpuSpecs> {
        self.0
            .renderer
            .get()
            .map(|renderer| renderer.borrow().gpu_specs())
    }

    fn update_ime_position(&self, bounds: crate::Bounds<crate::Pixels>) {
        let window = self.window();
        window.set_ime_cursor_area(
            winit::dpi::LogicalPosition::new(bounds.origin.x.0 as f64, bounds.origin.y.0 as f64),
            winit::dpi::LogicalSize::new(bounds.size.width.0 as f64, bounds.size.height.0 as f64),
        );
    }
}

impl raw_window_handle::HasDisplayHandle for CrossWindow {
    fn display_handle(
        &self,
    ) -> Result<raw_window_handle::DisplayHandle<'_>, raw_window_handle::HandleError> {
        self.window().display_handle()
    }
}

impl raw_window_handle::HasWindowHandle for CrossWindow {
    fn window_handle(
        &self,
    ) -> Result<raw_window_handle::WindowHandle<'_>, raw_window_handle::HandleError> {
        self.window().window_handle()
    }
}

// Reentrant view updates can install a newer handler while the old one is in use.
fn with_taken_handler<T>(slot: &RefCell<Option<T>>, callback: impl FnOnce(&mut T)) {
    let Some(mut handler) = slot.borrow_mut().take() else {
        return;
    };
    callback(&mut handler);
    let mut current = slot.borrow_mut();
    if current.is_none() {
        *current = Some(handler);
    }
}

#[cfg(test)]
mod reentrant_handler_tests {
    use super::*;

    #[test]
    fn text_application_releases_borrow_and_preserves_nested_replacement() {
        let slot = RefCell::new(Some(String::from("old")));
        with_taken_handler(&slot, |handler| {
            handler.push_str(" text");
            assert!(slot.borrow().is_none());
            *slot.borrow_mut() = Some(String::from("new focused handler"));
        });
        assert_eq!(slot.borrow().as_deref(), Some("new focused handler"));
    }

    #[test]
    fn text_application_restores_updated_handler_without_replacement() {
        let slot = RefCell::new(Some(String::new()));
        with_taken_handler(&slot, |handler| handler.push_str("é👩‍💻"));
        assert_eq!(slot.borrow().as_deref(), Some("é👩‍💻"));
        *slot.borrow_mut() = None;
        with_taken_handler(&slot, |_| panic!("absent handler must not run"));
    }
}