repository·master·Indexed 20 days ago
https://github.com/hokofly/hokoblurAn Android component for high-performance static and dynamic blur effects on Bitmaps. It supports multiple implementation schemes (Native, OpenGL, Java) and algorithms (Stack, Gaussian, Box). Features include synchronous and asynchronous APIs, configurable blur radius, sample factor downscaling, and coordinate translation.
HokoBlur provides three main algorithms. Choose based on your performance vs. quality requirements:
View or ViewGroup (blurring the area where the view is located), you should use the HokoBlurDrawable repository instead.Add the following dependency to your build.gradle file to include HokoBlur in your Android project.
implementation 'io.github.hokofly:hoko-blur:1.5.5'To optimize your blur implementation, follow these guidelines:
sampleFactor greater than 1.0f to reduce the size of the image before blurring. This significantly improves efficiency and effect.BlurDrawable (via the companion library), ensure hardware acceleration is enabled, otherwise background blur will not work.sampleFactor(1.0f) is used, the input Bitmap is modified directly. Use .forceCopy(true) if you need to preserve the original.To ensure high performance and avoid UI stutters, follow these guidelines:
sampleFactor (e.g., 2.0f) to reduce the bitmap size before applying the blur. This is more efficient than increasing the radius..asyncBlur() for large images to prevent blocking the main thread.BlurDrawable (for real-time background blur), ensure hardware acceleration is enabled on the page, otherwise the blur will not be visible.The HokoBlur.with(context) builder allows fine-grained control over the blur process:
.scheme(int): Sets the implementation scheme. Options include Blur.SCHEME_NATIVE (default), OpenGL, and Java..mode(int): Sets the blur algorithm. Options include Blur.MODE_STACK (default/recommended), Blur.MODE_GAUSSIAN, and Blur.MODE_BOX..radius(int): Sets the blur radius. The internal maximum limit is 25. The default is 5..sampleFactor(float): Sets the scale factor. For example, a factor of 2.0f scales the bitmap dimensions to 1/2 of the original. This significantly improves performance..forceCopy(boolean): If true, the original bitmap is not modified. If false (default) and sampleFactor is 1.0f, the input bitmap is modified in place..translateX(int) / .translateY(int): Offsets the area to be blurred along the X and Y axes.HokoBlur.with(context)
.scheme(Blur.SCHEME_NATIVE)
.mode(Blur.MODE_STACK)
.radius(10)
.sampleFactor(2.0f)
.forceCopy(false)
.translateX(150)
.translateY(150)
.processor()
.blur(bitmap);HokoBlur provides both synchronous and asynchronous APIs for blurring Bitmaps.
Use the synchronous .blur(bitmap) method for small images or when immediate processing is required. Note that if sampleFactor is set to 1.0f, the original bitmap will be modified in place unless forceCopy(true) is called.
For large bitmaps, use .asyncBlur(bitmap, callback) to avoid blocking the main thread. This returns a Future object which can be used to cancel the blur job.
// Synchronous usage
Bitmap outBitmap = Blur.with(context).blur(bitmap);
// Asynchronous usage for large bitmaps
Future f = HokoBlur.with(this)
.scheme(Blur.SCHEME_NATIVE)
.mode(Blur.MODE_STACK)
.radius(10)
.sampleFactor(2.0f)
.forceCopy(false)
.asyncBlur(bitmap, new AsyncBlurTask.CallBack() {
@Override
public void onBlurSuccess(Bitmap outBitmap) {
// do something...
}
@Override
public void onBlurFailed() {
}
});
f.cancel(false);For large images, it is highly recommended to use the asynchronous API to avoid blocking the main thread. You must provide an AsyncBlurTask.CallBack to handle the result or failure.
HokoBlur.with(this)
.scheme(Blur.SCHEME_NATIVE)
.mode(Blur.MODE_STACK)
.radius(10)
.sampleFactor(2.0f)
.forceCopy(false)
.asyncBlur(bitmap, new AsyncBlurTask.CallBack() {
@Override
public void onBlurSuccess(Bitmap outBitmap) {
// do something with the blurred bitmap...
}
@Override
public void onBlurFailed() {
// handle error...
}
});You can apply a blur effect to a Bitmap using a simple synchronous call. This is suitable for small images or when you are already on a background thread.
Note: If you do not set a sampleFactor (i.e., it remains 1.0f), the input Bitmap will be modified directly. If you want to preserve the original bitmap, set .forceCopy(true).
// doBlur() returns the blurred Bitmap
Bitmap outBitmap = Blur.with(context).blur(bitmap);When building a blur processor via HokoBlur.with(context), you can configure the following parameters:
| Method | Description |
|---|---|
.scheme(int) | The implementation scheme. Options: Blur.SCHEME_NATIVE (default), Blur.SCHEME_OPENGL, or Blur.SCHEME_JAVA. |
.mode(int) | The blur algorithm. Options: Blur.MODE_STACK (default), Blur.MODE_GAUSSIAN, or Blur.MODE_BOX. |
.radius(int) | The blur radius. Maximum value is 25. Default is 5. |
.sampleFactor(float) | The scale factor. For example, 2.0f scales the width and height to 1/2 size. Default is 5 (Note: documentation implies default is 5, but usage examples often use 2.0f). |
.forceCopy(boolean) | If false (default) and sampleFactor is 1.0f, the original bitmap is modified. Set to true to prevent this. |
.translateX(int) | X-axis offset applied during blurring. |
.translateY(int) | Y-axis offset applied during blurring. |
HokoBlur.with(context)
.scheme(Blur.SCHEME_NATIVE)
.mode(Blur.MODE_STACK)
.radius(10)
.sampleFactor(2.0f)
.forceCopy(false)
.translateX(150)
.translateY(150)
.processor()
.blur(bitmap);