lib/Image.hh

   1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
   2 // Image.hh for Blackbox - an X11 Window manager
   3 // Copyright (c) 2001 - 2003 Sean 'Shaleh' Perry <shaleh@debian.org>
   4 // Copyright (c) 1997 - 2000, 2002 - 2003
   5 //         Bradley T Hughes <bhughes at trolltech.com>
   6 //
   7 // Permission is hereby granted, free of charge, to any person obtaining a
   8 // copy of this software and associated documentation files (the "Software"),
   9 // to deal in the Software without restriction, including without limitation
  10 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11 // and/or sell copies of the Software, and to permit persons to whom the
  12 // Software is furnished to do so, subject to the following conditions:
  13 //
  14 // The above copyright notice and this permission notice shall be included in
  15 // all copies or substantial portions of the Software.
  16 //
  17 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  22 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  23 // DEALINGS IN THE SOFTWARE.
  24
  25 #ifndef   __Image_hh
  26 #define   __Image_hh
  27
  28 #include "Util.hh"
  29
  30 namespace bt {
  31
  32   // forward declarations
  33   class Color;
  34   class Display;
  35   class ScreenInfo;
  36   class Texture;
  37   class XColorTable;
  38
  39   enum DitherMode {
  40     NoDither,
  41     OrderedDither,
  42     FloydSteinbergDither
  43   };
  44
  45   struct RGB {
  46     unsigned int red      : 8;
  47     unsigned int green    : 8;
  48     unsigned int blue     : 8;
  49     unsigned int reserved : 8;
  50   };
  51
  52   class Image : public NoCopy {
  53   public:
  54     static inline unsigned int maximumColors(void)
  55     { return global_maximumColors; }
  56     static inline void setMaximumColors(unsigned int newval)
  57     { global_maximumColors = newval; }
  58
  59     static inline DitherMode ditherMode(void)
  60     { return global_ditherMode; }
  61     static inline void setDitherMode(DitherMode dithermode)
  62     { global_ditherMode = dithermode; }
  63
  64     Image(unsigned int w, unsigned int h);
  65     ~Image(void);
  66
  67     Pixmap render(const Display &display, unsigned int screen,
  68                   const Texture &texture);
  69
  70   private:
  71     RGB *data;
  72     unsigned int width, height;
  73
  74     void OrderedDither(XColorTable *colortable,
  75                        unsigned int bit_depth,
  76                        unsigned int bytes_per_line,
  77                        unsigned char *pixel_data);
  78     void FloydSteinbergDither(XColorTable *colortable,
  79                               unsigned int bit_depth,
  80                               unsigned int bytes_per_line,
  81                               unsigned char *pixel_data);
  82
  83     Pixmap renderPixmap(const Display &display, unsigned int screen);
  84
  85     void bevel(unsigned int border_width = 0);
  86     void dgradient(const Color &from, const Color &to, bool interlaced);
  87     void egradient(const Color &from, const Color &to, bool interlaced);
  88     void hgradient(const Color &from, const Color &to, bool interlaced);
  89     void pgradient(const Color &from, const Color &to, bool interlaced);
  90     void rgradient(const Color &from, const Color &to, bool interlaced);
  91     void vgradient(const Color &from, const Color &to, bool interlaced);
  92     void cdgradient(const Color &from, const Color &to, bool interlaced);
  93     void pcgradient(const Color &from, const Color &to, bool interlaced);
  94
  95     static unsigned int global_maximumColors;
  96     static DitherMode global_ditherMode;
  97   };
  98
  99 } // namespace bt
 100
 101 #endif // __Image_hh