leyoda/winit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document platform-specific modules

Browse source
This commit is contained in:
Mads Marquart 2025-06-07 15:43:38 +02:00 • committed by GitHub
parent 2900ecab93
commit 3218316420
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 23 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

27
winit/src/platform/mod.rs
View file

@ -1,6 +1,25 @@
//! Contains traits with platform-specific methods in them.
//! # Platform implementations
//!
//! Only the modules corresponding to the platform you're compiling to will be available.
//! This module re-exports the platform-specific implementation crates that are used by default in
//! Winit.
//!
//! Only the crates / modules corresponding to the platform you're compiling to will be available.
//!
//! | Platform | Crate | Module |
//! | -------- | ----- | ------ |
#![doc = concat!("| Android | [`winit-android`](https://docs.rs/winit-android/", env!("CARGO_PKG_VERSION"), "/) | `winit::platform::android` |")]
#![doc = concat!("| macOS | [`winit-appkit`](https://docs.rs/winit-appkit/", env!("CARGO_PKG_VERSION"), "/) | `winit::platform::macos` |")]
#![doc = concat!("| Redox | [`winit-orbital`](https://docs.rs/winit-orbital/", env!("CARGO_PKG_VERSION"), "/) | `winit::platform::orbital` |")]
#![doc = concat!("| iOS/visionOS/tvOS/Mac Catalyst | [`winit-uikit`](https://docs.rs/winit-uikit/", env!("CARGO_PKG_VERSION"), "/) | `winit::platform::ios` |")]
#![doc = concat!("| Wayland | [`winit-wayland`](https://docs.rs/winit-wayland/", env!("CARGO_PKG_VERSION"), "/) | `winit::platform::wayland` |")]
#![doc = concat!("| Web | [`winit-web`](https://docs.rs/winit-web/", env!("CARGO_PKG_VERSION"), "/) | `winit::platform::web` |")]
#![doc = concat!("| Windows | [`winit-win32`](https://docs.rs/winit-win32/", env!("CARGO_PKG_VERSION"), "/) | `winit::platform::windows` |")]
#![doc = concat!("| X11 | [`winit-x11`](https://docs.rs/winit-x11/", env!("CARGO_PKG_VERSION"), "/) | `winit::platform::x11` |")]
//! ## Common modules
//!
//! Furthermore, we provide two modules for common functionality:
//! - `scancode`, available on Windows, macOS, Wayland and X11.
//! - `startup_notify`, available on Wayland and X11.
#[cfg(android_platform)]
pub use winit_android as android;
@ -10,8 +29,6 @@ pub use winit_appkit as macos;
pub use winit_orbital as orbital;
#[cfg(ios_platform)]
pub use winit_uikit as ios;
#[cfg(any(x11_platform, wayland_platform))]
pub mod startup_notify;
#[cfg(wayland_platform)]
pub use winit_wayland as wayland;
#[cfg(web_platform)]
@ -23,3 +40,5 @@ pub use winit_x11 as x11;
#[cfg(any(windows_platform, macos_platform, x11_platform, wayland_platform, docsrs))]
pub mod scancode;
#[cfg(any(x11_platform, wayland_platform, docsrs))]
pub mod startup_notify;