Legacy Documentation: Version 5.0
Vignetting and Chromatic Aberration
Mesh Components

Vortex

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

The Vortex image effect distorts the rendered image within a circular region. Pixels in the image are displaced around a central circular area by a specified angle; the amount of displacement reduces with distance from the centre, diminishing to zero at the circle’s edge. Vortex is similar to another image effect called Twirl, although Twirl distorts the image around a point rather than a circle.

As with the other image effects, you must have the Standard Assets Effects package installed before it becomes available.

Vortex image effect applied to the scene
Vortex image effect applied to the scene

Properties

Property: Function:
Radius The radius of the circle where distortion occurs, given in normalized screen coordinates (ie, a radius of 0.5 is half the size of the screen).
Angle The angle by which pixels are displaced around the central circle.
Center The center of the circular region of distortion.

Hardware Support

This effect should run on all hardware that Unity supports.

Vignetting and Chromatic Aberration
Mesh Components