About UIFX - Blur Filter
Overview
What?
UIFX-BlurFilter is a new visual effect for Unity's UI (uGUI) components that allows visual blurring of UI components.
Why?
Unity's UI system currently doesn't have an option to blur UI components.
Blurring can be used to take UI transitions to the next level, or to indicate deactivated UI elements.
How?
Just add the UIFX-BlurFilter component to your UI component. That's it!
Features
- High quality blur rendering
- TextMeshPro supported
- Easy to use
- Highly optimised
- Cross-platform
- Built-in/URP/HDRP
- Source code included
- Well documented & supported
- Also works in editor (no need to enter play mode)
Usage
There are three axes the blur can use which creates different effects:
- Default
- Horizontal Axis
- Vertical Axis
Some example use cases:
- Focus Effect
- Fade Transition
By animating the blur Strength property on multiple UI elements a fake camera depth-of-field focus effect can be achieved.
Alpha Curve can specify the transparency of the effect linked to the Strength property which can be useful for creating appear/disappear transitions.
Compatibility
| Unity Version | 6.x | 2023.x | 2022.x | 2021.x | 2020.x | 2019.x | 2018.x | 2017.x |
|---|---|---|---|---|---|---|---|---|
| Supported | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✗ | ✗ |
| Platform | Windows/UWP | macOS | Linux | Android | iOS / tvOS | WebGL | PS4 / PS5 | XBox One |
|---|---|---|---|---|---|---|---|---|
| Supported | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Render Pipeline | Built-in | URP | HDRP |
|---|---|---|---|
| Supported | ✓ | ✓ | ✓ |
Dependencies
This plugin requires the Unity.UI package that is included with Unity by default.
The Asset Package
The asset package consists of the following files:
A demo scene is included. All scripts are grouped using Assembly Definition files.
Supported Features
| UI Feature | Supported | Notes |
|---|---|---|
| Components: | ||
| Text | ✓ | |
| TextMeshPro | ✓ | |
| Image | ✓ | |
| RawImage | ✓ | |
| Mask | ✓ | |
| Rect Mask 2D | ✓ | |
| CanvasGroup | ✓ | |
| Custom | ✓ | |
| Canvas Render Modes: | ||
| Screen-Space Overlay | ✓ | |
| Screen-Space Camera | ✓ | |
| World Space | ✓ | |
| Effects: | ||
| Shadow | ✓ | |
| Outline | ✓ |
| UI Feature | Supported | Notes |
|---|---|---|
| Render Pipelines: | ||
| Built-in | ✓ | |
| URP | ✓ | |
| HDRP | ✓ | |
| Colorspaces: | ||
| Gamma | ✓ | |
| Linear | ✓ |
Advanced
Performance
UIFX-BlurFilter has had several optimisation passes, so we can say with confidence that it is highly performant. There are still a number of optimisations we have planned for version 1.1.0 coming soon!
Garbage Collection
This component has been optimised to reduce garbage generation.