From db0d918483123ba466772765b5453730f521ba19 Mon Sep 17 00:00:00 2001
From: Mads Marquart <mads@marquart.dk>
Date: Sat, 21 Jan 2023 17:27:31 +0100
Subject: [PATCH] Note the status quo on `RedrawRequested`
And link to https://github.com/rust-windowing/winit/issues/2640
---
src/event.rs | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/src/event.rs b/src/event.rs
index d2eb37eb7c..f0bc889764 100644
--- a/src/event.rs
+++ b/src/event.rs
@@ -202,7 +202,16 @@ pub enum Event<'a, T: 'static> {
/// Mainly of interest to applications with mostly-static graphics that avoid redrawing unless
/// something changes, like most non-game GUIs.
///
+ ///
+ /// ## Platform-specific
+ ///
+ /// - **macOS / iOS:** Due to implementation difficulties, this will often, but not always, be
+ /// emitted directly inside `drawRect:`, with neither a preceding [`MainEventsCleared`] nor
+ /// subsequent `RedrawEventsCleared`. See [#2640] for work on this.
+ ///
/// [`MainEventsCleared`]: Self::MainEventsCleared
+ /// [`RedrawEventsCleared`]: Self::RedrawEventsCleared
+ /// [#2640]: https://github.com/rust-windowing/winit/issues/2640
RedrawRequested(WindowId),
/// Emitted after all [`RedrawRequested`] events have been processed and control flow is about to