diff options
| author | 2022-05-02 21:21:24 +0200 | |
|---|---|---|
| committer | 2022-05-02 21:21:24 +0200 | |
| commit | 5acba65c1135d8ebbda94efc74ea0bebb29c438a (patch) | |
| tree | 88673403313ad90cec226ee92d4ebf4ef0a24bdc /winit | |
| parent | a17a7103d382f02c64e7b271d953ea6babffac97 (diff) | |
| parent | 7e111f273fb22a6ffc7a4fd24bea5e838d276758 (diff) | |
| download | iced-5acba65c1135d8ebbda94efc74ea0bebb29c438a.tar.gz iced-5acba65c1135d8ebbda94efc74ea0bebb29c438a.tar.bz2 iced-5acba65c1135d8ebbda94efc74ea0bebb29c438a.zip | |
Merge pull request #1327 from iced-rs/update-docs
Update documentation
Diffstat (limited to '')
| -rw-r--r-- | winit/README.md | 2 | ||||
| -rw-r--r-- | winit/src/conversion.rs | 12 | ||||
| -rw-r--r-- | winit/src/lib.rs | 4 | ||||
| -rw-r--r-- | winit/src/settings.rs | 4 | 
4 files changed, 13 insertions, 9 deletions
| diff --git a/winit/README.md b/winit/README.md index 5a94cd92..3ca46fff 100644 --- a/winit/README.md +++ b/winit/README.md @@ -1,7 +1,7 @@  # `iced_winit`  [][documentation]  [](https://crates.io/crates/iced_winit) -[](https://github.com/hecrj/iced/blob/master/LICENSE) +[](https://github.com/iced-rs/iced/blob/master/LICENSE)  [](https://discord.gg/3xZJ65GAhd)  `iced_winit` offers some convenient abstractions on top of [`iced_native`] to quickstart development when using [`winit`]. diff --git a/winit/src/conversion.rs b/winit/src/conversion.rs index b00a095d..8e6c0b37 100644 --- a/winit/src/conversion.rs +++ b/winit/src/conversion.rs @@ -1,7 +1,7 @@  //! Convert [`winit`] types into [`iced_native`] types, and viceversa.  //!  //! [`winit`]: https://github.com/rust-windowing/winit -//! [`iced_native`]: https://github.com/hecrj/iced/tree/master/native +//! [`iced_native`]: https://github.com/iced-rs/iced/tree/0.4/native  use crate::keyboard;  use crate::mouse;  use crate::touch; @@ -208,7 +208,7 @@ pub fn visible(mode: Mode) -> bool {  /// Converts a `MouseCursor` from [`iced_native`] to a [`winit`] cursor icon.  ///  /// [`winit`]: https://github.com/rust-windowing/winit -/// [`iced_native`]: https://github.com/hecrj/iced/tree/master/native +/// [`iced_native`]: https://github.com/iced-rs/iced/tree/0.4/native  pub fn mouse_interaction(      interaction: mouse::Interaction,  ) -> winit::window::CursorIcon { @@ -232,7 +232,7 @@ pub fn mouse_interaction(  /// Converts a `MouseButton` from [`winit`] to an [`iced_native`] mouse button.  ///  /// [`winit`]: https://github.com/rust-windowing/winit -/// [`iced_native`]: https://github.com/hecrj/iced/tree/master/native +/// [`iced_native`]: https://github.com/iced-rs/iced/tree/0.4/native  pub fn mouse_button(mouse_button: winit::event::MouseButton) -> mouse::Button {      match mouse_button {          winit::event::MouseButton::Left => mouse::Button::Left, @@ -248,7 +248,7 @@ pub fn mouse_button(mouse_button: winit::event::MouseButton) -> mouse::Button {  /// modifiers state.  ///  /// [`winit`]: https://github.com/rust-windowing/winit -/// [`iced_native`]: https://github.com/hecrj/iced/tree/master/native +/// [`iced_native`]: https://github.com/iced-rs/iced/tree/0.4/native  pub fn modifiers(      modifiers: winit::event::ModifiersState,  ) -> keyboard::Modifiers { @@ -275,7 +275,7 @@ pub fn cursor_position(  /// Converts a `Touch` from [`winit`] to an [`iced_native`] touch event.  ///  /// [`winit`]: https://github.com/rust-windowing/winit -/// [`iced_native`]: https://github.com/hecrj/iced/tree/master/native +/// [`iced_native`]: https://github.com/iced-rs/iced/tree/0.4/native  pub fn touch_event(      touch: winit::event::Touch,      scale_factor: f64, @@ -306,7 +306,7 @@ pub fn touch_event(  /// Converts a `VirtualKeyCode` from [`winit`] to an [`iced_native`] key code.  ///  /// [`winit`]: https://github.com/rust-windowing/winit -/// [`iced_native`]: https://github.com/hecrj/iced/tree/master/native +/// [`iced_native`]: https://github.com/iced-rs/iced/tree/0.4/native  pub fn key_code(      virtual_keycode: winit::event::VirtualKeyCode,  ) -> keyboard::KeyCode { diff --git a/winit/src/lib.rs b/winit/src/lib.rs index b31adf6e..2bb30caa 100644 --- a/winit/src/lib.rs +++ b/winit/src/lib.rs @@ -1,6 +1,6 @@  //! A windowing shell for Iced, on top of [`winit`].  //! -//!  +//!   //!  //! `iced_winit` offers some convenient abstractions on top of [`iced_native`]  //! to quickstart development when using [`winit`]. @@ -11,7 +11,7 @@  //! Additionally, a [`conversion`] module is available for users that decide to  //! implement a custom event loop.  //! -//! [`iced_native`]: https://github.com/hecrj/iced/tree/master/native +//! [`iced_native`]: https://github.com/iced-rs/iced/tree/0.4/native  //! [`winit`]: https://github.com/rust-windowing/winit  //! [`conversion`]: crate::conversion  #![doc( diff --git a/winit/src/settings.rs b/winit/src/settings.rs index 9a93824a..213ef47f 100644 --- a/winit/src/settings.rs +++ b/winit/src/settings.rs @@ -37,12 +37,16 @@ pub struct Settings<Flags> {      /// Whether the [`Application`] should exit when the user requests the      /// window to close (e.g. the user presses the close button). +    /// +    /// [`Application`]: crate::Application      pub exit_on_close_request: bool,      /// Whether the [`Application`] should try to build the context      /// using OpenGL ES first then OpenGL.      ///      /// NOTE: Only works for the `glow` backend. +    /// +    /// [`Application`]: crate::Application      pub try_opengles_first: bool,  } | 
