.. # split from OEGraphemeFunctions.rst:2390

.. include:: ../substitutions

.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEDrawWreathCircle

.. oe:function:: OEDrawWreathCircle

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEDrawWreathCircle(OEDepict::OEImageBase& image,
                                 const OEDepict::OE2DPoint& center,
                                 double radius, const OEDepict::OEPen& pen,
                                 double patternAngle = 15.0,
                                 double patternWidthRatio = 0.20)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawWreathCircle(image: OEImageBase, c: OE2DPoint, radius: float,
                            pen: OEPen, patternAngle: float = 15.0,
                            patternWidthRatio: float = 0.20) -> bool

   Draws a circle with the :oe:const:`OEGrapheme::OECircleStyle::Wreath` style.

   .. _figure_draw_circle_wreath:

   .. figure:: ../images/OEDrawWreathCircle.*
      :align:  center

      **OEDrawWreathCircle**

   *image*
     |circle_image|

   *center*
     |circle_center|

   *radius*
     |circle_radius|

   *pen*
     |circle_pen|

     See examples (A) and (B) in :ref:`Figure: OEDrawWreathCircle<figure_draw_circle_wreath>`.

   *patternAngle*
     |circle_pattern_angle|

     See example (C) in :ref:`Figure: OEDrawWreathCircle<figure_draw_circle_wreath>`.

   *patternWidthRatio*
     |circle_width_ratio|

     See example (D) in :ref:`Figure: OEDrawWreathCircle<figure_draw_circle_wreath>`.
