Add the "obsetroot" tool. Use it to set the root background.
[dana/openbox.git] / otk / rendercontrol.hh
1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
2 #ifndef __rendercontrol_hh
3 #define __rendercontrol_hh
4
5 extern "C" {
6 #include <X11/Xlib.h>
7 #include <X11/Xutil.h>
8 }
9
10 #include "surface.hh"
11
12 namespace otk {
13
14 class ScreenInfo;
15 class RenderTexture;
16 class Font;
17 class RenderColor;
18 class ustring;
19 class PixmapMask;
20
21 class RenderControl {
22 protected:
23   int _screen;
24
25 //  bool _dither;
26
27   RenderControl(int screen);
28
29   inline void highlight(pixel32 *x, pixel32 *y, bool raised) const;
30   void verticalGradient(Surface &sf, const RenderTexture &texture) const;
31   void diagonalGradient(Surface &sf, const RenderTexture &texture) const;
32   void crossDiagonalGradient(Surface &sf, const RenderTexture &texture) const;
33   virtual void drawGradientBackground(Surface &sf,
34                                       const RenderTexture &texture) const;
35   virtual void drawSolidBackground(Surface& sf,
36                                    const RenderTexture& texture) const;
37
38   //! Reduces a Surface's Surface::pixelData so that it will display correctly
39   //! on the screen's depth
40   /*!
41     This function allocates and sets the im->data member. The allocated memory
42     will be freed when XDetroyImage is called on the XImage.
43   */
44   virtual void reduceDepth(Surface &sf, XImage *im) const = 0;
45
46 public:
47   virtual ~RenderControl();
48
49   static RenderControl *getRenderControl(int screen);
50
51   //! Draws a background onto a Surface, as specified by a RenderTexture
52   /*!
53     This function will overwrite the entire surface.
54   */
55   virtual void drawBackground(Surface &sf,
56                               const RenderTexture &texture) const;
57
58   //! Draws an image onto the surface
59   /*!
60     This function will overwrite the entire surface.<br>
61     The image must be specified in 32-bit packed ARGB format. The current
62     background will be used for applying the alpha.
63   */
64   virtual void drawImage(Surface &sf, int w, int h,
65                          unsigned long *data) const;
66   
67   //! Draws a string onto a Surface
68   virtual void drawString(Surface &sf, const Font &font, int x, int y,
69                           const RenderColor &color,
70                           const ustring &string) const;
71
72   //! Draws a PixmapMask with a specified color onto a Surface
73   virtual void drawMask(Surface &sf, const RenderColor &color,
74                         const PixmapMask &mask) const;
75
76   virtual void allocateColor(XColor *color) const = 0;
77 };
78
79 }
80
81 #endif // __rendercontrol_hh