1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

//! Make your windows vibrant.
//!
//! # Platform support:
//!
//! - **Windows:** Yes!
//! - **macOS:** Yes!
//! - **Linux:** No, blur effect is controlled by the compositor installed on the user system and they can enable it for your app if they want.
//!
//! # Example with [`winit`](https://docs.rs/winit)
//!
//! ```no_run
//! # use winit::{event_loop::EventLoop, window::WindowBuilder};
//! # use window_vibrancy::{apply_vibrancy, apply_blur, NSVisualEffectMaterial};
//! let event_loop = EventLoop::new();
//!
//! let window = WindowBuilder::new()
//!  .with_decorations(false)
//!  .build(&event_loop)
//!  .unwrap();
//!
//! #[cfg(target_os = "windows")]
//! apply_blur(&window, Some((18, 18, 18, 125))).unwrap();
//!
//! #[cfg(target_os = "macos")]
//! apply_vibrancy(&window, NSVisualEffectMaterial::AppearanceBased).unwrap();
//! ```

mod macos;
mod windows;

pub use macos::NSVisualEffectMaterial;

/// a tuple of RGBA colors. Each value has minimum of 0 and maximum of 255.
pub type Color = (u8, u8, u8, u8);

/// Applies blur effect to window. Works only on Windows 7, Windows 10 v1809 or newer and Windows 11.
///
/// - *`color`* is ignored on Windows 7 and has no effect.
pub fn apply_blur(
  window: impl raw_window_handle::HasRawWindowHandle,
  #[allow(unused)] color: Option<Color>,
) -> Result<(), Error> {
  match window.raw_window_handle() {
    #[cfg(target_os = "windows")]
    raw_window_handle::RawWindowHandle::Win32(handle) => {
      windows::apply_blur(handle.hwnd as _, color)
    }
    _ => Err(Error::UnsupportedPlatform(
      "\"apply_blur()\" is only supported on Windows.",
    )),
  }
}

/// Clears blur effect applied to window. Works only on Windows 7, Windows 10 v1809 or newer and Windows 11.
pub fn clear_blur(window: impl raw_window_handle::HasRawWindowHandle) -> Result<(), Error> {
  match window.raw_window_handle() {
    #[cfg(target_os = "windows")]
    raw_window_handle::RawWindowHandle::Win32(handle) => windows::clear_blur(handle.hwnd as _),
    _ => Err(Error::UnsupportedPlatform(
      "\"clear_blur()\" is only supported on Windows.",
    )),
  }
}

/// Applies Acrylic effect to you window. Works only on Windows 10 v1809 or newer and Windows 11
///
/// - *`color`* is ignored on Windows 11 build 22523 and newer and has no effect.
///
/// ## WARNING:
///
/// This method has poor performance on Windows 10 v1903+ and Windows 11 build 22000,
/// the window will lag when resizing or dragging.
/// It is an issue in the undocumented api used for this method
/// and microsoft needs to fix it (they probably won't).
pub fn apply_acrylic(
  window: impl raw_window_handle::HasRawWindowHandle,
  #[allow(unused)] color: Option<Color>,
) -> Result<(), Error> {
  match window.raw_window_handle() {
    #[cfg(target_os = "windows")]
    raw_window_handle::RawWindowHandle::Win32(handle) => {
      windows::apply_acrylic(handle.hwnd as _, color)
    }
    _ => Err(Error::UnsupportedPlatform(
      "\"apply_acrylic()\" is only supported on Windows.",
    )),
  }
}

/// Clears acrylic effect applied to window. Works only on Windows 10 v1809 or newer and Windows 11.
pub fn clear_acrylic(window: impl raw_window_handle::HasRawWindowHandle) -> Result<(), Error> {
  match window.raw_window_handle() {
    #[cfg(target_os = "windows")]
    raw_window_handle::RawWindowHandle::Win32(handle) => windows::clear_acrylic(handle.hwnd as _),
    _ => Err(Error::UnsupportedPlatform(
      "\"clear_acrylic()\" is only supported on Windows.",
    )),
  }
}

/// Applies mica effect to window. Works only on Windows 11.
pub fn apply_mica(window: impl raw_window_handle::HasRawWindowHandle) -> Result<(), Error> {
  match window.raw_window_handle() {
    #[cfg(target_os = "windows")]
    raw_window_handle::RawWindowHandle::Win32(handle) => windows::apply_mica(handle.hwnd as _),
    _ => Err(Error::UnsupportedPlatform(
      "\"apply_mica()\" is only supported on Windows.",
    )),
  }
}

/// Clears mica effect applied to window. Works only on Windows 11.
pub fn clear_mica(window: impl raw_window_handle::HasRawWindowHandle) -> Result<(), Error> {
  match window.raw_window_handle() {
    #[cfg(target_os = "windows")]
    raw_window_handle::RawWindowHandle::Win32(handle) => windows::clear_mica(handle.hwnd as _),
    _ => Err(Error::UnsupportedPlatform(
      "\"clear_mica()\" is only supported on Windows.",
    )),
  }
}

/// Applies macos vibrancy effect to window. Works only on macOS 10.10 or newer.
pub fn apply_vibrancy(
  window: impl raw_window_handle::HasRawWindowHandle,
  #[allow(unused)] effect: NSVisualEffectMaterial,
) -> Result<(), Error> {
  match window.raw_window_handle() {
    #[cfg(target_os = "macos")]
    raw_window_handle::RawWindowHandle::AppKit(handle) => {
      macos::apply_vibrancy(handle.ns_window as _, effect)
    }
    _ => Err(Error::UnsupportedPlatform(
      "\"apply_vibrancy()\" is only supported on macOS.",
    )),
  }
}

#[derive(Debug)]
pub enum Error {
  UnsupportedPlatform(&'static str),
  UnsupportedPlatformVersion(&'static str),
  NotMainThread(&'static str),
}

impl std::fmt::Display for Error {
  fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
    match self {
      Error::UnsupportedPlatform(e)
      | Error::UnsupportedPlatformVersion(e)
      | Error::NotMainThread(e) => {
        write!(f, "{}", e)
      }
    }
  }
}