dd32ace9ab
* Restore the ability to have fully transparent windows on Windows
Besides its original purpose, commit 6343059b "Fix Windows transparency
behavior to support fully-opaque regions (#1621)" also included some
changes considered cleanups, one of them was:
* Remove the `CreateRectRgn` call, since we want the entire window's region to
have blur behind it, and `DwnEnableBlurBehindWindow` does that by default.
But the original code actually disabled the blur effect for the whole
window by creating an empty region for it, because that allows for the
window to be truely fully transparent. With the blur effect in place,
the areas meant to be transparent either blur the things behind it
(until Windows 8) or are darkened (since Windows 8). This also means
that on Windows 8 and newer, the resulting colors are darker than
intended in translucent areas when the blur effect is enabled.
This restores the behaviour from winit <0.24 and fixes #1814.
Arguably, one might want to expose the ability to control the blur
region, but that is outside the scope of this commit.
* Remove useless WS_EX_LAYERED from transparent windows on Windows
`WS_EX_LAYERED` is not supposed to be used in combination with
`CS_OWNDC`. In winit, as it is currently used, `WS_EX_LAYERED` actually
has no effect at all. The only relevant call is to
`SetLayeredWindowAttributes`, which is required to make the window
visible at all with `WS_EX_LAYERED` set, but is called with full
opacity, i.e. there's no transparency involved at all.
The actual transparency is already achieved by using
`DwmEnableBlurBehindWindow`, so `WS_EX_LAYERED` and the call to
`SetLayeredWindowAttributes` can both be removed.
winit - Cross-platform window creation and management in Rust
[dependencies]
winit = "0.24.0"
Documentation
For features within the scope of winit, see FEATURES.md.
For features outside the scope of winit, see Missing features provided by other crates in the wiki.
Contact Us
Join us in any of these:
Usage
Winit is a window creation and management library. It can create windows and lets you handle events (for example: the window being resized, a key being pressed, a mouse movement, etc.) produced by window.
Winit is designed to be a low-level brick in a hierarchy of libraries. Consequently, in order to show something on the window you need to use the platform-specific getters provided by winit, or another library.
use winit::{
event::{Event, WindowEvent},
event_loop::{ControlFlow, EventLoop},
window::WindowBuilder,
};
fn main() {
let event_loop = EventLoop::new();
let window = WindowBuilder::new().build(&event_loop).unwrap();
event_loop.run(move |event, _, control_flow| {
*control_flow = ControlFlow::Wait;
match event {
Event::WindowEvent {
event: WindowEvent::CloseRequested,
window_id,
} if window_id == window.id() => *control_flow = ControlFlow::Exit,
_ => (),
}
});
}
Winit is only officially supported on the latest stable version of the Rust compiler.
Cargo Features
Winit provides the following features, which can be enabled in your Cargo.toml file:
serde: Enables serialization/deserialization of certain types with Serde.x11(enabled by default): On Unix platform, compiles with the X11 backendwayland(enabled by default): On Unix platform, compiles with the Wayland backend
Platform-specific usage
WebAssembly
Winit supports compiling to the wasm32-unknown-unknown target with either a
stdweb or a web-sys backend for use on web browsers. However, please note
that the stdweb backend is being deprecated and may be removed in a future
release of Winit. The web-sys backend is also more feature complete.
On the web platform, a Winit window is backed by a <canvas> element. You can
either provide Winit with a <canvas> element, or let Winit
create a <canvas> element which you can then retrieve and
insert it into the DOM yourself.
For example code using Winit with WebAssembly, check out the web example. For information on using Rust on WebAssembly, check out the Rust and WebAssembly book.
Android
This library makes use of the ndk-rs crates, refer to that repo for more documentation.
Running on an Android device needs a dynamic system library, add this to Cargo.toml:
[[example]]
name = "request_redraw_threaded"
crate-type = ["cdylib"]
And add this to the example file to add the native activity glue:
#[cfg_attr(target_os = "android", ndk_glue::main(backtrace = "on"))]
fn main() {
...
}
And run the application with cargo apk run --example request_redraw_threaded
MacOS
To ensure compatibility with older MacOS systems, winit links to
CGDisplayCreateUUIDFromDisplayID through the CoreGraphics framework.
However, under certain setups this function is only available to be linked
through the newer ColorSync framework. So, winit provides the
WINIT_LINK_COLORSYNC environment variable which can be set to 1 or true
while compiling to enable linking via ColorSync.