Click here to interactively play with filters to see how they work.
All filters work with PixiJS v5.
PixiJS has a handful of core filters that are built-in to the PixiJS library.
Installation is available using NPM:
npm install pixi-filters
Alternatively, you can use a CDN such as JSDelivr:
<script src="https://cdn.jsdelivr.net/npm/pixi-filters@latest/dist/pixi-filters.js"></script>
If all else failes, you can manually download the bundled file from the releases section and include it in your project.
PixiJS Filters uses Lerna under-the-hood to build all of the filters separately. Install all dependencies by simply running the following.
npm install
Build all filters, demo and screenshots by running the following:
npm run build
Build single filter by running the following:
npm run build:prod -- --scope "@pixi/filter-emboss"
Build multiple filters where scope is a glob expression:
npm run build:prod -- --scope "{@pixi/filter-emboss,@pixi/filter-glow}"
Watch all filters (auto-rebuild upon src changes):
npm run watch
Build all filters in dev-mode (un-minified):
npm run build:dev
API documention can be found here.