.. include:: headings.inc

.. module:: lib.imageutils

.. currentmodule:: lib.imageutils

.. highlight:: python



.. _lib.imageutils:

==========================================================================================================================================
|phoenix_title|  **imageutils**
==========================================================================================================================================




|function_summary| Functions Summary
====================================

================================================================================ ================================================================================
:func:`~lib.imageutils.grayOut`                                                  Convert the given image (in place) to a grayed-out
:func:`~lib.imageutils.makeGray`                                                 Make a pixel grayed-out. If the pixel
:func:`~lib.imageutils.stepColour`                                               stepColour is a utility function that simply darkens or lightens a
================================================================================ ================================================================================


|



Functions
------------

.. function:: grayOut(anImage)

   Convert the given image (in place) to a grayed-out
   version, appropriate for a 'disabled' appearance.


.. function:: makeGray((r,g,b), factor, maskColor)

   Make a pixel grayed-out. If the pixel
   matches the maskColor, it won't be
   changed.


.. function:: stepColour(c, step)

   stepColour is a utility function that simply darkens or lightens a
   color, based on the specified step value.  A step of 0 is
   completely black and a step of 200 is totally white, and 100
   results in the same color as was passed in.