.. include:: ../substitutions

.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDrawHighlighting

.. _OEDepict_OEDrawHighlighting:


.. oe:function:: OEDrawHighlighting


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

      .. oe:api::

         void OEDrawHighlighting(OEImageBase& image,
                                 const OE2DMolDisplay& disp,
                                 const OEHighlightBase& highlight,
                                 const OEChem::OEAtomBondSet& abset)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawHighlighting(image: OEImageBase, disp: OE2DMolDisplay,
                            highlight: OEHighlightBase, abset: OEAtomBondSet) -> None

   Draws atom and bond highlighting into the image.

   *image*
      The image in which the highlighting is drawn.

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object of which atoms
      add/or bonds being highlighted.

   *highlight*
      The :ref:`OEHighlightBase <OEDepict_OEHighlightBase>` object that specifies the style of the highlighting.

   *abset*
      Stores the atoms and bonds being highlighted.

   .. note::

      This function renders the highlighting into an image rather than into the
      molecule display as does the :oe:func:`OEDepict::OEAddHighlighting` function.
      Since this function does not change the molecule display it is **not available**
      for the :ref:`OEHighlightByColor <OEDepict_OEHighlightByColor>` highlighting style.

   .. seealso::

      * :oe:func:`OEDepict::OEAddHighlighting` function
