summaryrefslogtreecommitdiffstats
path: root/third_party/rust/raw-window-handle/src/lib.rs
diff options
context:
space:
mode:
Diffstat (limited to 'third_party/rust/raw-window-handle/src/lib.rs')
-rw-r--r--third_party/rust/raw-window-handle/src/lib.rs194
1 files changed, 194 insertions, 0 deletions
diff --git a/third_party/rust/raw-window-handle/src/lib.rs b/third_party/rust/raw-window-handle/src/lib.rs
new file mode 100644
index 0000000000..6bd8072d64
--- /dev/null
+++ b/third_party/rust/raw-window-handle/src/lib.rs
@@ -0,0 +1,194 @@
+//! Interoperability library for Rust Windowing applications.
+//!
+//! This library provides standard types for accessing a window's platform-specific raw window
+//! handle. This does not provide any utilities for creating and managing windows; instead, it
+//! provides a common interface that window creation libraries (e.g. Winit, SDL) can use to easily
+//! talk with graphics libraries (e.g. gfx-hal).
+//!
+//! ## Platform handle initialization
+//!
+//! Each platform handle struct is purposefully non-exhaustive, so that additional fields may be
+//! added without breaking backwards compatibility. Each struct provides an `empty` method that may
+//! be used along with the struct update syntax to construct it. See each specific struct for
+//! examples.
+//!
+#![cfg_attr(feature = "nightly-docs", feature(doc_cfg))]
+#![no_std]
+
+#[cfg_attr(feature = "nightly-docs", doc(cfg(target_os = "android")))]
+#[cfg_attr(not(feature = "nightly-docs"), cfg(target_os = "android"))]
+pub mod android;
+#[cfg_attr(feature = "nightly-docs", doc(cfg(target_os = "ios")))]
+#[cfg_attr(not(feature = "nightly-docs"), cfg(target_os = "ios"))]
+pub mod ios;
+#[cfg_attr(feature = "nightly-docs", doc(cfg(target_os = "macos")))]
+#[cfg_attr(not(feature = "nightly-docs"), cfg(target_os = "macos"))]
+pub mod macos;
+#[cfg_attr(
+ feature = "nightly-docs",
+ doc(cfg(any(
+ target_os = "linux",
+ target_os = "dragonfly",
+ target_os = "freebsd",
+ target_os = "netbsd",
+ target_os = "openbsd"
+ )))
+)]
+#[cfg_attr(
+ not(feature = "nightly-docs"),
+ cfg(any(
+ target_os = "linux",
+ target_os = "dragonfly",
+ target_os = "freebsd",
+ target_os = "netbsd",
+ target_os = "openbsd"
+ ))
+)]
+pub mod unix;
+#[cfg_attr(feature = "nightly-docs", doc(cfg(target_arch = "wasm32")))]
+#[cfg_attr(not(feature = "nightly-docs"), cfg(target_arch = "wasm32"))]
+pub mod web;
+#[cfg_attr(feature = "nightly-docs", doc(cfg(target_os = "windows")))]
+#[cfg_attr(not(feature = "nightly-docs"), cfg(target_os = "windows"))]
+pub mod windows;
+
+mod platform {
+ #[cfg(target_os = "android")]
+ pub use crate::android::*;
+ #[cfg(target_os = "macos")]
+ pub use crate::macos::*;
+ #[cfg(any(
+ target_os = "linux",
+ target_os = "dragonfly",
+ target_os = "freebsd",
+ target_os = "netbsd",
+ target_os = "openbsd"
+ ))]
+ pub use crate::unix::*;
+ #[cfg(target_os = "windows")]
+ pub use crate::windows::*;
+ // mod platform;
+ #[cfg(target_os = "ios")]
+ pub use crate::ios::*;
+ #[cfg(target_arch = "wasm32")]
+ pub use crate::web::*;
+}
+
+/// Window that wraps around a raw window handle.
+///
+/// # Safety guarantees
+///
+/// Users can safely assume that non-`null`/`0` fields are valid handles, and it is up to the
+/// implementer of this trait to ensure that condition is upheld. However, It is entirely valid
+/// behavior for fields within each platform-specific `RawWindowHandle` variant to be `null` or
+/// `0`, and appropriate checking should be done before the handle is used.
+///
+/// Despite that qualification, implementers should still make a best-effort attempt to fill in all
+/// available fields. If an implementation doesn't, and a downstream user needs the field, it should
+/// try to derive the field from other fields the implementer *does* provide via whatever methods the
+/// platform provides.
+///
+/// The exact handles returned by `raw_window_handle` must remain consistent between multiple calls
+/// to `raw_window_handle`, and must be valid for at least the lifetime of the `HasRawWindowHandle`
+/// implementer.
+pub unsafe trait HasRawWindowHandle {
+ fn raw_window_handle(&self) -> RawWindowHandle;
+}
+
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
+pub enum RawWindowHandle {
+ #[cfg_attr(feature = "nightly-docs", doc(cfg(target_os = "ios")))]
+ #[cfg_attr(not(feature = "nightly-docs"), cfg(target_os = "ios"))]
+ IOS(ios::IOSHandle),
+
+ #[cfg_attr(feature = "nightly-docs", doc(cfg(target_os = "macos")))]
+ #[cfg_attr(not(feature = "nightly-docs"), cfg(target_os = "macos"))]
+ MacOS(macos::MacOSHandle),
+
+ #[cfg_attr(
+ feature = "nightly-docs",
+ doc(cfg(any(
+ target_os = "linux",
+ target_os = "dragonfly",
+ target_os = "freebsd",
+ target_os = "netbsd",
+ target_os = "openbsd"
+ )))
+ )]
+ #[cfg_attr(
+ not(feature = "nightly-docs"),
+ cfg(any(
+ target_os = "linux",
+ target_os = "dragonfly",
+ target_os = "freebsd",
+ target_os = "netbsd",
+ target_os = "openbsd"
+ ))
+ )]
+ Xlib(unix::XlibHandle),
+
+ #[cfg_attr(
+ feature = "nightly-docs",
+ doc(cfg(any(
+ target_os = "linux",
+ target_os = "dragonfly",
+ target_os = "freebsd",
+ target_os = "netbsd",
+ target_os = "openbsd"
+ )))
+ )]
+ #[cfg_attr(
+ not(feature = "nightly-docs"),
+ cfg(any(
+ target_os = "linux",
+ target_os = "dragonfly",
+ target_os = "freebsd",
+ target_os = "netbsd",
+ target_os = "openbsd"
+ ))
+ )]
+ Xcb(unix::XcbHandle),
+
+ #[cfg_attr(
+ feature = "nightly-docs",
+ doc(cfg(any(
+ target_os = "linux",
+ target_os = "dragonfly",
+ target_os = "freebsd",
+ target_os = "netbsd",
+ target_os = "openbsd"
+ )))
+ )]
+ #[cfg_attr(
+ not(feature = "nightly-docs"),
+ cfg(any(
+ target_os = "linux",
+ target_os = "dragonfly",
+ target_os = "freebsd",
+ target_os = "netbsd",
+ target_os = "openbsd"
+ ))
+ )]
+ Wayland(unix::WaylandHandle),
+
+ #[cfg_attr(feature = "nightly-docs", doc(cfg(target_os = "windows")))]
+ #[cfg_attr(not(feature = "nightly-docs"), cfg(target_os = "windows"))]
+ Windows(windows::WindowsHandle),
+
+ #[cfg_attr(feature = "nightly-docs", doc(cfg(target_arch = "wasm32")))]
+ #[cfg_attr(not(feature = "nightly-docs"), cfg(target_arch = "wasm32"))]
+ Web(web::WebHandle),
+
+ #[cfg_attr(feature = "nightly-docs", doc(cfg(target_os = "android")))]
+ #[cfg_attr(not(feature = "nightly-docs"), cfg(target_os = "android"))]
+ Android(android::AndroidHandle),
+
+ #[doc(hidden)]
+ #[deprecated = "This field is used to ensure that this struct is non-exhaustive, so that it may be extended in the future. Do not refer to this field."]
+ __NonExhaustiveDoNotUse(seal::Seal),
+}
+
+mod seal {
+ #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
+ pub struct Seal;
+}
generated by cgit v1.2.3 (git 2.39.1) at 2025-01-10 12:26:37 +0000