leyoda/iced-yoda
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Fix doc links

Browse source
This commit is contained in:
Jeremy Soller 2024-10-18 17:42:35 -06:00 • committed by Ashley Wulber
parent 35cf63b323
commit 51b370ef48
No known key found for this signature in database
GPG key ID: 5216D4F46A90A820
6 changed files with 17 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

13
winit/src/platform_specific/wayland/sctk_event.rs
View file

@ -87,8 +87,9 @@ pub enum IcedSctkEvent {
///
/// This event type is useful as a place to put code that should be done before you start
/// processing events, such as updating frame timing information for benchmarking or checking
/// the [`StartCause`][crate::event::StartCause] to see if a timer set by
/// [`ControlFlow::WaitUntil`](crate::platform_specific::wayland::event_loop::ControlFlow::WaitUntil) has elapsed.
/// the [`StartCause`] to see if a timer set by
/// [`ControlFlow::WaitUntil`](crate::platform_specific::wayland::event_loop::control_flow::ControlFlow::WaitUntil)
/// has elapsed.
NewEvents(StartCause),
/// An event produced by sctk
@ -101,7 +102,7 @@ pub enum IcedSctkEvent {
/// state-changing events have been handled and you want to do stuff (updating state, performing
/// calculations, etc) that happens as the "main body" of your event loop. If your program only draws
/// graphics when something changes, it's usually better to do it in response to
/// [`Event::RedrawRequested`](crate::event::Event::RedrawRequested), which gets emitted
/// [`window::RedrawRequest`], which gets emitted
/// immediately after this event. Programs that draw graphics continuously, like most games,
/// can render here unconditionally for simplicity.
MainEventsCleared,
@ -111,7 +112,7 @@ pub enum IcedSctkEvent {
/// This gets triggered in two scenarios:
/// - The OS has performed an operation that's invalidated the window's contents (such as
/// resizing the window).
/// - The application has explicitly requested a redraw via [`Window::request_redraw`].
/// - The application has explicitly requested a redraw via [`iced_runtime::core::Shell::request_redraw`].
///
/// During each iteration of the event loop, Winit will aggregate duplicate redraw requests
/// into a single event, to help avoid duplicating rendering work.
@ -330,7 +331,7 @@ pub enum StartCause {
/// moment the timeout was requested and the requested resume time. The actual resume time is
/// guaranteed to be equal to or after the requested resume time.
///
/// [`ControlFlow::WaitUntil`]: crate::platform_specific::wayland::event_loop::ControlFlow::WaitUntil
/// [`ControlFlow::WaitUntil`]: crate::platform_specific::wayland::event_loop::control_flow::ControlFlow::WaitUntil
ResumeTimeReached {
start: Instant,
requested_resume: Instant,
@ -346,7 +347,7 @@ pub enum StartCause {
/// Sent if the event loop is being resumed after the loop's control flow was set to
/// [`ControlFlow::Poll`].
///
/// [`ControlFlow::Poll`]: crate::platform_specific::wayland::event_loop::ControlFlow::Poll
/// [`ControlFlow::Poll`]: crate::platform_specific::wayland::event_loop::control_flow::ControlFlow::Poll
Poll,
/// Sent once, immediately after `run` is called. Indicates that the loop was just initialized.