Legacy Documentation: Version 4.6.2
Language: English
Tonemapping
Vignetting (and Chromatic Aberration)

Twirl

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 Twirl image effect distorts the rendered image within a circular region. The pixels at the centre of the circle are rotated by a specified angle; the rotation for other pixels in the circle decreases with distance from the centre, diminishing to zero at the circle’s edge.

Twirl is similar to another image effect called Vortex, although vortex distorts the image around a central circle rather than a single point.

As with the other image effects, this effect is only available in Unity Pro and you must have the Pro Standard Assets installed before it becomes available.

Twirl image effect applied to the scene
Twirl image effect applied to the scene

Properties

Property: Function:
Radius The radius of the ellipse where image distortion occurs, given in normalized screen coordinates (ie, a radius of 0.5 is half the size of the screen).
Angle The angle of rotation at the centre point.
Center The point at the centre of the circle where distortion occurs.

Hardware Support

This effect requires a graphics card that supports Shader Model 2. See the Graphics Hardware Capabilities and Emulation page for further details and a list of compliant hardware.

Tonemapping
Vignetting (and Chromatic Aberration)