Skip to content

Repository files navigation

BlurKit Header

Join SpectrumBuddy.Works

What Is BlurKit?

BlurKit is an extraordinarily easy to use and performant utility to render real time blur effects in Android.

BlurKit Demo

Perfomance

BlurKit is faster than other blurring libraries due to a number of bitmap retrieval and drawing optimizations. We've been logging benchmarks for the basic high-intensity tasks for a 300dp x 100dp BlurView:

TaskBlurKit timeAvg. time without BlurKit
Retrieve source bitmap1-2 ms8-25 ms
Blur and draw to BlurView1-2 ms10-50ms

This results in an average work/frame time of 2-4ms, which will be a seamless experience for most users and apps.

Setup

Add BlurKit to the dependencies block of the app level build.gradle:

dependencies {
implementation 'io.alterac.blurkit:blurkit:1.1.0'
}

Usage

BlurLayout

Add a BlurLayout to your XML layout just like any other view.

<io.alterac.blurkit.BlurLayout
android:id="@+id/blurLayout"android:layout_width="150dp"android:layout_height="150dp"/>

In the Main_Activity.java you need to override the onStart() and onStop() methods to include the BlurLayout functionality.

BlurLayoutblurLayout;
@OverrideprotectedvoidonCreate(BundlesavedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
blurLayout = findViewById(R.id.blurLayout);
}
@OverrideprotectedvoidonStart() {
super.onStart();
blurLayout.startBlur();
}
@OverrideprotectedvoidonStop() {
blurLayout.pauseBlur();
super.onStop();
}

The layout background will continuously blur the content behind it. If you know your background content will be somewhat static, you can set the layout fps to 0. At any time you can re-blur the background content by calling invalidate() on the BlurLayout.

<io.alterac.blurkit.BlurLayout
android:id="@+id/blurLayout"android:layout_width="150dp"android:layout_height="150dp"blurkit:blk_fps="0" />

Other attributes you can configure are the blur radius and the downscale factor. Getting these to work together well can take some experimentation. The downscale factor is a performance optimization; the bitmap for the background content will be downsized by this factor before being drawn and blurred.

<io.alterac.blurkit.BlurLayout
android:id="@+id/blurLayout"android:layout_width="150dp"android:layout_height="150dp"blurkit:blk_blurRadius="12"blurkit:blk_downscaleFactor="0.12"blurkit:blk_fps="60" />

Creating BlurKit Outside Of A Layout

You can use the BlurKit class which has a few useful blurring utilities. Before using this class outside of a BlurLayout, you need to initialize BlurKit.

publicclassMyApplicationextendsApplication {
@OverridepublicvoidonCreate() {
BlurKit.init(this);
}
}

You can blur a View, or a Bitmap directly.

// ViewBlurKit.getInstance().blur(Viewsrc, intradius);
// BitmapBlurKit.getInstance().blur(Bitmapsrc, intradius);

You can also fastBlur a View. This optimizes the view blurring process by allocating a downsized bitmap and using a Matrix with the bitmaps Canvas to prescale the drawing of the view to the bitmap.

BlurKit.getInstance().fastBlur(Viewsrc, intradius, floatdownscaleFactor);

Upcoming Features

  • SurfaceView support
  • Support for use outside of an Activity (dialogs, etc.)
  • Enhance retrieval of background content to only include views drawn behind the BlurLayout.

License

BlurKit is MIT licensed.


Blurkit is a sister project of CameraKit and maintained by the CameraKit team.

About

The missing Android blurring library. Fast blur-behind layout that parallels iOS.

Topics

Resources

Stars

3.8k stars

Watchers

73 watching

Forks

Releases

Packages

Used by

Contributors

Languages