flutter_acrylic 0.1.0 copy "flutter_acrylic: ^0.1.0" to clipboard
flutter_acrylic: ^0.1.0 copied to clipboard

PlatformLinuxWindows
outdated

Window acrylic, mica & transparency effects for Flutter on Windows & Linux.

flutter_acrylic

Window acrylic, mica & transparency effects for Flutter on Windows & Linux

Installation #

Mention in your pubspec.yaml.

dependencies:
  ...
  flutter_acrylic: ^0.0.2

Example #

Documentation #

Initialize the plugin inside the main method.

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Window.initialize();
  runApp(MyApp());
}

Apply the effect to Flutter window.

await Acrylic.setEffect(
  effect: WindowEffect.acrylic,
  color: Color(0xCC222222),
);
await Acrylic.setEffect(
  effect: WindowEffect.mica,
  dark: true,
);

Following effects are available.

  • WindowEffect.disabled.
  • WindowEffect.solid.
  • WindowEffect.transparent.
  • WindowEffect.aero.
  • WindowEffect.acrylic.
  • WindowEffect.mica.

Other utility features offered by the plugin.

Enter fullscreen.

Window.enterFullscreen();

Exit fullscreen.

Window.exitFullscreen();

Hide controls.

Window.hideWindowControls();

Show controls.

Window.showWindowControls();

More features coming soon.

Notes #

Linux #

Additional setup for Linux.

Find my_application.cc inside the linux directory of your Flutter project & remove following lines from it.

gtk_widget_show(GTK_WIDGET(window));
gtk_widget_show(GTK_WIDGET(view));

Adding blur to the Window.

Since current Flutter embedder on Linux uses GTK 3.0, so there is no official API available for backdrop blur of the window.

However, some desktop environments like KDE Plasma (with KWin compositor) have some third party scripts like kwin-forceblur from Eon S. Jeon, which allow to add blur to GTK 3.0 windows aswell (when the window is transparent, which you can certainly achieve using the plugin). Thus, this setup can be used to obtain result as shown in the picture.

Blur on Linux is more dependent on the compositor, some compositors like compiz or wayfire also seem to support blur effects.

Windows #

This plugin exposes the undocumented SetWindowCompositionAttribute API from user32.dll on Windows 10. Learn more at Rafael Rivera's amazing blog post about this here.

In most cases, you might wanna render custom window frame because the blur effect might leak outside the window boundary (only on Windows 10). You can use bitsdojo_window to make a custom window for your Flutter application.

WindowEffect.acrylic causes lag on window drag in Windows 10, this issue is fixed by Microsoft in Windows 11. WindowEffect.mica only works on Windows 11.

You can see the example application for further details.

License #

MIT License. Contributions welcomed.

More #

Checkout other awesome projects for Flutter on Windows

(Irrespective of order)

  • bitsdojo_window
    • A Flutter package that makes it easy to customize and work with your Flutter desktop app window.
  • fluent_ui
    • Implements Microsoft's Fluent Design System in Flutter.

Aero blur effect.

Transparent Flutter window.

477
likes
130
pub points
95%
popularity

Publisher

unverified uploader

Window acrylic, mica & transparency effects for Flutter on Windows & Linux.

Repository (GitHub)
View/report issues

Documentation

Documentation
API reference

License

MIT (LICENSE)

Dependencies

flutter

More

Packages that depend on flutter_acrylic