1.0.0 • Published 4 years ago

liquideffect v1.0.0

Weekly downloads
3
License
MIT
Repository
github
Last release
4 years ago

LiquidEffect

Javascript Library for creating liquid effect on image and RGB effect on mouse direction.

Demo

https://liquideffect.netlify.app/

Dependencies

<script src="https://cdn.jsdelivr.net/npm/pixi.js@5.3.3/dist/pixi.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/pixi-filters@2.6.1/dist/pixi-filters.js"></script>
<script src="LiquidEffect.js"></script>

OR

npm i pixi.js
npm i @pixi/filter-displacement
npm i @pixi/filter-rgb-split

Usage

<script>
    LiquidEffect({
        appendTo: "#main",
        image: './assets/images/image.jpg',
        displacementImage: "./assets/images/displacement_map.jpg",
        displacementScale: 1,
        speed: 1,
        intensityX: 1.5,
        intensityY: 1.5,
    });
</script>

Parameters

NameTypeDescription
appendToDom ElementParent Element
imageImageImage to display
displacementImageImageDisplacement Image
displacementScaleFloatDisplacement Scale value 0.0 - 1.0 causing waves to be shorter or bigger
speedFloatLiquid effect wave speed
intensityXFloatLiquid effect intensity on X-axis
intensityYFloatLiquid effect intensity on Y-axis