diff options
| author |  Héctor Ramón Jiménez <hector0193@gmail.com> | 2020-05-28 02:49:32 +0200 |
|---|---|---|
| committer | Héctor Ramón Jiménez <hector0193@gmail.com> | 2020-05-28 02:49:32 +0200 |
| commit | ef28347f1c816d8ad9e772303467de489efb802b (patch) | |
| tree | 78a06298839f1311a40a7655724fc7ec1322c730 /winit/src/application.rs | |
| parent | 508128436c5da88d4b4f384a9fe73288320eb9ec (diff) | |
| download | iced-ef28347f1c816d8ad9e772303467de489efb802b.tar.gz iced-ef28347f1c816d8ad9e772303467de489efb802b.tar.bz2 iced-ef28347f1c816d8ad9e772303467de489efb802b.zip | |
Write documentation for new `iced_winit` API
Diffstat (limited to 'winit/src/application.rs')
| -rw-r--r-- | winit/src/application.rs | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/winit/src/application.rs b/winit/src/application.rs index fcba47b3..df6e4eec 100644 --- a/winit/src/application.rs +++ b/winit/src/application.rs @@ -1,3 +1,4 @@ +//! Create interactive, native cross-platform applications. use crate::{ conversion, mouse, Clipboard, Command, Debug, Executor, Mode, Proxy, Runtime, Settings, Size, Subscription, @@ -72,6 +73,10 @@ pub trait Application: Program { } } +/// Runs an [`Application`] with an executor, compositor, and the provided +/// settings. +/// +/// [`Application`]: trait.Application.html pub fn run<A, E, C>( settings: Settings<A::Flags>, compositor_settings: C::Settings, @@ -254,6 +259,8 @@ pub fn run<A, E, C>( }) } +/// Handles a `WindowEvent` and mutates the provided control flow, keyboard +/// modifiers, viewport, and resized flag accordingly. pub fn handle_window_event( event: &winit::event::WindowEvent<'_>, window: &winit::window::Window, |