render/render.h

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    render.h for the Openbox window manager
   4    Copyright (c) 2006        Mikael Magnusson
   5    Copyright (c) 2003-2007   Dana Jansens
   6    Copyright (c) 2003        Derek Foreman
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 2 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    See the COPYING file for a copy of the GNU General Public License.
  19 */
  20
  21 #ifndef __render_h
  22 #define __render_h
  23
  24 #include "geom.h"
  25 #include "version.h"
  26
  27 #include <X11/Xlib.h> /* some platforms dont include this as needed for Xft */
  28 #include <pango/pangoxft.h>
  29 #include <glib.h>
  30
  31 G_BEGIN_DECLS
  32
  33 typedef union  _RrTextureData      RrTextureData;
  34 typedef struct _RrAppearance       RrAppearance;
  35 typedef struct _RrSurface          RrSurface;
  36 typedef struct _RrFont             RrFont;
  37 typedef struct _RrTexture          RrTexture;
  38 typedef struct _RrTextureMask      RrTextureMask;
  39 typedef struct _RrTextureRGBA      RrTextureRGBA;
  40 typedef struct _RrTextureText      RrTextureText;
  41 typedef struct _RrTextureLineArt   RrTextureLineArt;
  42 typedef struct _RrPixmapMask       RrPixmapMask;
  43 typedef struct _RrInstance         RrInstance;
  44 typedef struct _RrColor            RrColor;
  45
  46 typedef guint32 RrPixel32;
  47 typedef guint16 RrPixel16;
  48 typedef guchar  RrPixel8;
  49
  50 typedef enum {
  51     RR_RELIEF_FLAT,
  52     RR_RELIEF_RAISED,
  53     RR_RELIEF_SUNKEN
  54 } RrReliefType;
  55
  56 typedef enum {
  57     RR_BEVEL_1,
  58     RR_BEVEL_2
  59 } RrBevelType;
  60
  61 typedef enum {
  62     RR_SURFACE_NONE,
  63     RR_SURFACE_PARENTREL,
  64     RR_SURFACE_SOLID,
  65     RR_SURFACE_SPLIT_VERTICAL,
  66     RR_SURFACE_HORIZONTAL,
  67     RR_SURFACE_VERTICAL,
  68     RR_SURFACE_DIAGONAL,
  69     RR_SURFACE_CROSS_DIAGONAL,
  70     RR_SURFACE_PYRAMID,
  71     RR_SURFACE_MIRROR_HORIZONTAL
  72 } RrSurfaceColorType;
  73
  74 typedef enum {
  75     RR_TEXTURE_NONE,
  76     RR_TEXTURE_MASK,
  77     RR_TEXTURE_TEXT,
  78     RR_TEXTURE_LINE_ART,
  79     RR_TEXTURE_RGBA
  80 } RrTextureType;
  81
  82 typedef enum {
  83     RR_JUSTIFY_LEFT,
  84     RR_JUSTIFY_CENTER,
  85     RR_JUSTIFY_RIGHT
  86 } RrJustify;
  87
  88 /* Put middle first so it's the default */
  89 typedef enum {
  90     RR_ELLIPSIZE_MIDDLE,
  91     RR_ELLIPSIZE_NONE,
  92     RR_ELLIPSIZE_START,
  93     RR_ELLIPSIZE_END
  94 } RrEllipsizeMode;
  95
  96 typedef enum {
  97     RR_FONTWEIGHT_LIGHT,
  98     RR_FONTWEIGHT_NORMAL,
  99     RR_FONTWEIGHT_SEMIBOLD,
 100     RR_FONTWEIGHT_BOLD,
 101     RR_FONTWEIGHT_ULTRABOLD
 102 } RrFontWeight;
 103
 104 typedef enum {
 105     RR_FONTSLANT_NORMAL,
 106     RR_FONTSLANT_ITALIC,
 107     RR_FONTSLANT_OBLIQUE
 108 } RrFontSlant;
 109
 110 struct _RrSurface {
 111     RrSurfaceColorType grad;
 112     RrReliefType relief;
 113     RrBevelType bevel;
 114     RrColor *primary;
 115     RrColor *secondary;
 116     RrColor *border_color;
 117     RrColor *bevel_dark;
 118     RrColor *bevel_light;
 119     RrColor *interlace_color;
 120     gboolean interlaced;
 121     gboolean border;
 122     RrAppearance *parent;
 123     gint parentx;
 124     gint parenty;
 125     RrPixel32 *pixel_data;
 126     gint bevel_dark_adjust;  /* 0-255, default is 64 */
 127     gint bevel_light_adjust; /* 0-255, default is 128 */
 128     RrColor *split_primary;
 129     RrColor *split_secondary;
 130 };
 131
 132 struct _RrTextureText {
 133     RrFont *font;
 134     RrJustify justify;
 135     RrColor *color;
 136     const gchar *string;
 137     gint shadow_offset_x;
 138     gint shadow_offset_y;
 139     RrColor *shadow_color;
 140     guchar shadow_alpha;
 141     gboolean shortcut; /*!< Underline a character */
 142     guint shortcut_pos; /*!< Position in bytes of the character to underline */
 143     RrEllipsizeMode ellipsize;
 144 };
 145
 146 struct _RrPixmapMask {
 147     const RrInstance *inst;
 148     Pixmap mask;
 149     gint width;
 150     gint height;
 151     gchar *data;
 152 };
 153
 154 struct _RrTextureMask {
 155     RrColor *color;
 156     RrPixmapMask *mask;
 157 };
 158
 159 struct _RrTextureRGBA {
 160     gint width;
 161     gint height;
 162     gint alpha;
 163     RrPixel32 *data;
 164 /* cached scaled so we don't have to scale often */
 165     gint cwidth;
 166     gint cheight;
 167     RrPixel32 *cache;
 168 /* size and position to draw at */
 169     gint tx;
 170     gint ty;
 171     gint twidth;
 172     gint theight;
 173 };
 174
 175 struct _RrTextureLineArt {
 176     RrColor *color;
 177     gint x1;
 178     gint y1;
 179     gint x2;
 180     gint y2;
 181 };
 182
 183 union _RrTextureData {
 184     RrTextureRGBA rgba;
 185     RrTextureText text;
 186     RrTextureMask mask;
 187     RrTextureLineArt lineart;
 188 };
 189
 190 struct _RrTexture {
 191     RrTextureType type;
 192     RrTextureData data;
 193 };
 194
 195 struct _RrAppearance {
 196     const RrInstance *inst;
 197
 198     RrSurface surface;
 199     gint textures;
 200     RrTexture *texture;
 201     Pixmap pixmap;
 202     XftDraw *xftdraw;
 203
 204     /* cached for internal use */
 205     gint w, h;
 206 };
 207
 208 /* these are the same on all endian machines because it seems to be dependant
 209    on the endianness of the gfx card, not the cpu. */
 210 #define RrDefaultAlphaOffset 24
 211 #define RrDefaultRedOffset 16
 212 #define RrDefaultGreenOffset 8
 213 #define RrDefaultBlueOffset 0
 214
 215 #define RrDefaultFontFamily       "arial,sans"
 216 #define RrDefaultFontSize         8
 217 #define RrDefaultFontWeight       RR_FONTWEIGHT_NORMAL
 218 #define RrDefaultFontSlant        RR_FONTSLANT_NORMAL
 219
 220 RrInstance* RrInstanceNew (Display *display, gint screen);
 221 void        RrInstanceFree (RrInstance *inst);
 222
 223 Display* RrDisplay      (const RrInstance *inst);
 224 gint     RrScreen       (const RrInstance *inst);
 225 Window   RrRootWindow   (const RrInstance *inst);
 226 Visual*  RrVisual       (const RrInstance *inst);
 227 gint     RrDepth        (const RrInstance *inst);
 228 Colormap RrColormap     (const RrInstance *inst);
 229 gint     RrRedOffset    (const RrInstance *inst);
 230 gint     RrGreenOffset  (const RrInstance *inst);
 231 gint     RrBlueOffset   (const RrInstance *inst);
 232 gint     RrRedShift     (const RrInstance *inst);
 233 gint     RrGreenShift   (const RrInstance *inst);
 234 gint     RrBlueShift    (const RrInstance *inst);
 235 gint     RrRedMask      (const RrInstance *inst);
 236 gint     RrGreenMask    (const RrInstance *inst);
 237 gint     RrBlueMask     (const RrInstance *inst);
 238
 239 RrColor *RrColorNew   (const RrInstance *inst, gint r, gint g, gint b);
 240 RrColor *RrColorParse (const RrInstance *inst, gchar *colorname);
 241 void     RrColorFree  (RrColor *in);
 242
 243 gint     RrColorRed   (const RrColor *c);
 244 gint     RrColorGreen (const RrColor *c);
 245 gint     RrColorBlue  (const RrColor *c);
 246 gulong   RrColorPixel (const RrColor *c);
 247 GC       RrColorGC    (RrColor *c);
 248
 249 RrAppearance *RrAppearanceNew  (const RrInstance *inst, gint numtex);
 250 RrAppearance *RrAppearanceCopy (RrAppearance *a);
 251 void          RrAppearanceFree (RrAppearance *a);
 252 void          RrAppearanceAddTextures(RrAppearance *a, gint numtex);
 253
 254 RrFont *RrFontOpen          (const RrInstance *inst, const gchar *name,
 255                              gint size, RrFontWeight weight, RrFontSlant slant);
 256 RrFont *RrFontOpenDefault   (const RrInstance *inst);
 257 void    RrFontClose         (RrFont *f);
 258 RrSize *RrFontMeasureString (const RrFont *f, const gchar *str,
 259                              gint shadow_offset_x, gint shadow_offset_y);
 260 gint    RrFontHeight        (const RrFont *f, gint shadow_offset_y);
 261 gint    RrFontMaxCharWidth  (const RrFont *f);
 262
 263 /* Paint into the appearance. The old pixmap is returned (if there was one). It
 264    is the responsibility of the caller to call XFreePixmap on the return when
 265    it is non-null. */
 266 Pixmap RrPaintPixmap (RrAppearance *a, gint w, gint h);
 267 void   RrPaint       (RrAppearance *a, Window win, gint w, gint h);
 268 void   RrMinSize     (RrAppearance *a, gint *w, gint *h);
 269 gint   RrMinWidth    (RrAppearance *a);
 270 gint   RrMinHeight   (RrAppearance *a);
 271 void   RrMargins     (RrAppearance *a, gint *l, gint *t, gint *r, gint *b);
 272
 273 gboolean RrPixmapToRGBA(const RrInstance *inst,
 274                         Pixmap pmap, Pixmap mask,
 275                         gint *w, gint *h, RrPixel32 **data);
 276
 277 G_END_DECLS
 278
 279 #endif /*__render_h*/