libs/gil/doc/html/_sources/toolbox.rst.txt

   1 ToolBox extension
   2 =================
   3
   4 .. _Reference: reference.html
   5
   6 Overview
   7 --------
   8
   9 ToolBox provides collection of Boost.GIL extensions which are too
  10 small to be maintained as standalone extensions.
  11
  12 Content:
  13
  14 * Color converters: Gray to  RGBA
  15
  16 * Color spaces: CMYKA, Gray with Alpha, HSL, HSV, Lab, XYZ
  17
  18 * Metafunctions:
  19
  20   * ``channel_type``
  21   * ``channel_type_to_index``
  22   * ``get_num_bits``
  23   * ``get_pixel_type``
  24   * ``is_bit_aligned``
  25   * ``is_homogeneous``
  26   * ``is_similar``
  27   * ``pixel_bit_size``
  28
  29 * Image types:
  30
  31   * ``indexed_image``
  32
  33 This extension will hopefully be added on by the community.
  34
  35 Since the extension is header-only, user just needs to include
  36 its main header ``#include <boost/gil/extension/toolbox.hpp>``.
  37
  38 All definitions of the toolbox belong to the ``boost::gil`` namespace.
  39
  40 Folder Structure
  41 ----------------
  42
  43 The toolbox structured in the following sub-directories:
  44
  45 * color_converters
  46 * color_spaces
  47 * metafunctions
  48 * image_types
  49
  50 Acknowledgements
  51 ----------------
  52
  53 Thanks to all the people who have reviewed this library and
  54 made suggestions for improvements.
  55
  56 Reference
  57 ---------
  58
  59 The Reference_ section.