kinetic-slider/dist/types/hooks/useDisplacementEffects.d.ts

A WebGL-powered kinetic slider component using PIXI.js

import { type UseDisplacementEffectsProps } from '../types';
/**
 * Custom hook that manages displacement effects with consistent behavior
 * for both atlas textures and individual images.
 *
 * @param {UseDisplacementEffectsProps} props - Hook properties
 * @returns {Object} Functions to control displacement effects
 * @property {Function} showDisplacementEffects - Animates in displacement effects
 * @property {Function} hideDisplacementEffects - Animates out displacement effects
 * @property {number} DEFAULT_BG_FILTER_SCALE - Default background filter scale
 * @property {number} DEFAULT_CURSOR_FILTER_SCALE - Default cursor filter scale
 */
export declare const useDisplacementEffects: ({ sliderRef, bgDispFilterRef, cursorDispFilterRef, backgroundDisplacementSpriteRef, cursorDisplacementSpriteRef, appRef, backgroundDisplacementSpriteLocation, cursorDisplacementSpriteLocation, cursorImgEffect, cursorScaleIntensity, cursorDisplacementSizing, cursorDisplacementWidth, cursorDisplacementHeight, resourceManager, atlasManager, effectsAtlas, useEffectsAtlas }: UseDisplacementEffectsProps) => {
    showDisplacementEffects: () => gsap.core.Tween[];
    hideDisplacementEffects: () => gsap.core.Tween[];
    DEFAULT_BG_FILTER_SCALE: number;
    DEFAULT_CURSOR_FILTER_SCALE: number;
};