.. include:: ../substitutions

.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEDrawBorder

.. _OEDepict_OEDrawBorder:


.. oe:function:: OEDrawBorder


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

      .. oe:api::

         void OEDrawBorder(OEImageBase& image, const OEPen& pen)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawBorder(image: OEImageBase, arg2: OEPen) -> None

   Draws a border around the image with the given pen.

   *image*
      The image around which the border is drawn.

   *pen*
      The graphical properties of the border.

   See code snippet below and the corresponding image in
   :ref:`Figure: Example of using the OEDrawBorder function <figure_OEDrawBorder>`.

   .. oe:source:: OEDrawBorder.py
      :language: python
      :noindent:
      :frag:     SNIPPET-OEDrawBorder

   .. oe:source:: OEDrawBorder.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-OEDrawBorder

   .. oe:source:: OEDrawBorder.java
      :language: java
      :noindent:
      :frag:     SNIPPET-OEDrawBorder

   .. oe:source:: OEDrawBorder.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-OEDrawBorder

   .. _figure_OEDrawBorder:

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

      **Example of using the OEDrawBorder function**

   .. seealso::

      * :ref:`OEImageBase <OEDepict_OEImageBase>` class
      * :ref:`OEPen <OEDepict_OEPen>` class
      * :oe:func:`OEDepict::OEDrawCurvedBorder` function
