Add docs for BackdropBlurFilter class

pixijs · Feb 22, 2024 · 5c96567 · 5c96567
1 parent ea46220
commit 5c96567
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/backdrop-blur/BackdropBlurFilter.ts b/src/backdrop-blur/BackdropBlurFilter.ts
@@ -13,6 +13,13 @@ import { vertex, wgslVertex } from '../defaults';
 
 export type BackdropBlurFilterOptions = BlurFilterOptions;
 
+/**
+ * The BackdropBlurFilter applies a Gaussian blur to everything behind an object, and then draws the object on top of it.
+ *
+ * @class
+ * @extends BlurFilter
+ * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters}
+ */
 export class BackdropBlurFilter extends BlurFilter
 {
     private _blendPass: Filter;