Skip to main content

Wipe Filter Component

Overview

This component applies various wipe transitions to the UI element. The wipe transitions are modular so more can be easy added or customisable.

WebGL Demo

Properties

Component Screenshot

Property                            Type    Range    DefaultDescription
Wipe
    StyleThe style template to use. Options are:
Blinds
Direction
Iris
Noise
Radial
Slide
The wipe properties are based on the selected style.
    Invert DirectionBoolFalseWhether or not to invert the wipe direction.
Apply
    Render SpaceEnumCanvasWhich coordinate system use when rendering this filter. Options are:
Canvas: Render the filter before any transforms (scale/rotation/translation etc) are applied.
Screen: Render the filter after transforms have been applied.
Read more about this property here.
    EasingEnumLinearThe ease in-out mode that is applied to the Strength value.
    StrengthFloat[0..1]1.0Strength of the effect.

Usage

Add this component to any GameObject that contains a UI Graphic component (eg Text, Image, RawImage, etc).

Usage with TextMeshPro

To use this filter effect with TextMeshPro - Text (UI) use the Filter Stack (TextMeshPro) component.

Styles