.. include:: ../substitutions

.. oe:namespace:: OEDepict

.. _OEDepict_OEAddOpenEyeIcon:


.. oe:function:: OEAddOpenEyeIcon


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

      .. oe:api::

         void OEAddOpenEyeIcon(OEImageBase& image,
                               unsigned int loc = OEIconLocation::Default,
                               double scale = 1.0)
         void OEAddOpenEyeIcon(OE2DMolDisplay& disp,
                               unsigned int loc = OEIconLocation::Default,
                               double scale = 1.0)

   .. oe:language:: python

      .. oe:api:: python

         OEAddOpenEyeIcon(image: OEImageBase, loc: int, scale: float = 1.0) -> None
         OEAddOpenEyeIcon(disp: OE2DMolDisplay, loc: int, scale: float = 1.0) -> None

   Adds an OpenEye logo to an image or a molecule display.

   *loc*
      This value has to be from the :oe:constns:`OEDepict::OEIconLocation`
      namespace.

   *scale*
      The multiplier that can be used to increase or decrease the size of the icon.
      This value has to be in the range of ``[0.5, 2.0]``.

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

      **Example of using the OEAddOpenEyeIcon function**
