.. _bpy.types.ShaderFxSwirl:

*******************
Swirl Visual Effect
*******************

The *Swirl* Visual Effect applies a swirling pattern to the object.
The effect use an object as the center of the swirl.


Options
=======

.. figure:: /images/grease-pencil_visual-effects_swirl_panel.png
   :align: right

   Shadow Visual Effect.

Object
   Sets the object to use as the center of the swirl.

Radius
   External radius size of the swirl.

Angle
   Rotation angle of the swirl. A value of 0 shows no swirl.

Transparent
   When enabled, the Object is fully transparent outside the radius of the swirl.


Example
=======

.. list-table:: Swirl Effect samples (with a Radius of 100 px).

   * - .. figure:: /images/grease-pencil_visual-effects_swirl_angle-00.png
          :width: 200px

          Angle: 0°.

     - .. figure:: /images/grease-pencil_visual-effects_swirl_angle-15.png
          :width: 200px

          Angle: 15°.

     - .. figure:: /images/grease-pencil_visual-effects_swirl_angle-45.png
          :width: 200px

          Angle: 45°.

     - .. figure:: /images/grease-pencil_visual-effects_swirl_angle-90.png
          :width: 200px

          Angle: 90°.