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) 2003        Ben Jansens
   5    Copyright (c) 2003        Derek Foreman
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    See the COPYING file for a copy of the GNU General Public License.
  18 */
  19
  20 #ifndef __render_h
  21 #define __render_h
  22
  23 #include "geom.h"
  24 #include "version.h"
  25
  26 #include <X11/Xlib.h> /* some platforms dont include this as needed for Xft */
  27 #define _XFT_NO_COMPAT_ /* no Xft 1 API */
  28 #include <X11/Xft/Xft.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
  49 typedef enum {
  50     RR_RELIEF_FLAT,
  51     RR_RELIEF_RAISED,
  52     RR_RELIEF_SUNKEN
  53 } RrReliefType;
  54
  55 typedef enum {
  56     RR_BEVEL_1,
  57     RR_BEVEL_2
  58 } RrBevelType;
  59
  60 typedef enum {
  61     RR_SURFACE_NONE,
  62     RR_SURFACE_PARENTREL,
  63     RR_SURFACE_SOLID,
  64     RR_SURFACE_SPLIT,
  65     RR_SURFACE_HORIZONTAL,
  66     RR_SURFACE_VERTICAL,
  67     RR_SURFACE_DIAGONAL,
  68     RR_SURFACE_CROSS_DIAGONAL,
  69     RR_SURFACE_PYRAMID,
  70     RR_SURFACE_OSX
  71 } RrSurfaceColorType;
  72
  73 typedef enum {
  74     RR_TEXTURE_NONE,
  75     RR_TEXTURE_MASK,
  76     RR_TEXTURE_TEXT,
  77     RR_TEXTURE_LINE_ART,
  78     RR_TEXTURE_RGBA
  79 } RrTextureType;
  80
  81 typedef enum {
  82     RR_JUSTIFY_LEFT,
  83     RR_JUSTIFY_CENTER,
  84     RR_JUSTIFY_RIGHT
  85 } RrJustify;
  86
  87 struct _RrSurface {
  88     RrSurfaceColorType grad;
  89     RrReliefType relief;
  90     RrBevelType bevel;
  91     RrColor *primary;
  92     RrColor *secondary;
  93     RrColor *border_color;
  94     RrColor *bevel_dark;
  95     RrColor *bevel_light;
  96     RrColor *interlace_color;
  97     gboolean interlaced;
  98     gboolean border;
  99     RrAppearance *parent;
 100     gint parentx;
 101     gint parenty;
 102     RrPixel32 *pixel_data;
 103 };
 104
 105 struct _RrTextureText {
 106     RrFont *font;
 107     RrJustify justify;
 108     RrColor *color;
 109     gchar *string;
 110 };
 111
 112 struct _RrPixmapMask {
 113     const RrInstance *inst;
 114     Pixmap mask;
 115     gint width;
 116     gint height;
 117     gchar *data;
 118 };
 119
 120 struct _RrTextureMask {
 121     RrColor *color;
 122     RrPixmapMask *mask;
 123 };
 124
 125 struct _RrTextureRGBA {
 126     gint width;
 127     gint height;
 128     RrPixel32 *data;
 129 /* cached scaled so we don't have to scale often */
 130     gint cwidth;
 131     gint cheight;
 132     RrPixel32 *cache;
 133 };
 134
 135 struct _RrTextureLineArt {
 136     RrColor *color;
 137     gint x1;
 138     gint y1;
 139     gint x2;
 140     gint y2;
 141 };
 142
 143 union _RrTextureData {
 144     RrTextureRGBA rgba;
 145     RrTextureText text;
 146     RrTextureMask mask;
 147     RrTextureLineArt lineart;
 148 };
 149
 150 struct _RrTexture {
 151     RrTextureType type;
 152     RrTextureData data;
 153 };
 154
 155 struct _RrAppearance {
 156     const RrInstance *inst;
 157
 158     RrSurface surface;
 159     gint textures;
 160     RrTexture *texture;
 161     Pixmap pixmap;
 162     XftDraw *xftdraw;
 163
 164     /* cached for internal use */
 165     gint w, h;
 166 };
 167
 168 /* these are the same on all endian machines because it seems to be dependant
 169    on the endianness of the gfx card, not the cpu. */
 170 #define RrDefaultAlphaOffset 24
 171 #define RrDefaultRedOffset 16
 172 #define RrDefaultGreenOffset 8
 173 #define RrDefaultBlueOffset 0
 174
 175 RrInstance* RrInstanceNew (Display *display, gint screen);
 176 void        RrInstanceFree (RrInstance *inst);
 177
 178 Display* RrDisplay      (const RrInstance *inst);
 179 gint     RrScreen       (const RrInstance *inst);
 180 Window   RrRootWindow   (const RrInstance *inst);
 181 Visual*  RrVisual       (const RrInstance *inst);
 182 gint     RrDepth        (const RrInstance *inst);
 183 Colormap RrColormap     (const RrInstance *inst);
 184 gint     RrRedOffset    (const RrInstance *inst);
 185 gint     RrGreenOffset  (const RrInstance *inst);
 186 gint     RrBlueOffset   (const RrInstance *inst);
 187 gint     RrRedShift     (const RrInstance *inst);
 188 gint     RrGreenShift   (const RrInstance *inst);
 189 gint     RrBlueShift    (const RrInstance *inst);
 190 gint     RrRedMask      (const RrInstance *inst);
 191 gint     RrGreenMask    (const RrInstance *inst);
 192 gint     RrBlueMask     (const RrInstance *inst);
 193
 194 RrColor *RrColorNew   (const RrInstance *inst, gint r, gint g, gint b);
 195 RrColor *RrColorParse (const RrInstance *inst, gchar *colorname);
 196 void     RrColorFree  (RrColor *in);
 197
 198 gint     RrColorRed   (const RrColor *c);
 199 gint     RrColorGreen (const RrColor *c);
 200 gint     RrColorBlue  (const RrColor *c);
 201 gulong   RrColorPixel (const RrColor *c);
 202 GC       RrColorGC    (RrColor *c);
 203
 204 RrAppearance *RrAppearanceNew  (const RrInstance *inst, gint numtex);
 205 RrAppearance *RrAppearanceCopy (RrAppearance *a);
 206 void          RrAppearanceFree (RrAppearance *a);
 207
 208 RrSize *RrFontMeasureString (const RrFont *f, const gchar *str);
 209 gint RrFontHeight        (const RrFont *f);
 210 gint RrFontMaxCharWidth  (const RrFont *f);
 211
 212 void RrPaint   (RrAppearance *a, Window win, gint w, gint h);
 213 void RrMinsize (RrAppearance *a, gint *w, gint *h);
 214 void RrMargins (RrAppearance *a, gint *l, gint *t, gint *r, gint *b);
 215
 216 gboolean RrPixmapToRGBA(const RrInstance *inst,
 217                         Pixmap pmap, Pixmap mask,
 218                         gint *w, gint *h, RrPixel32 **data);
 219
 220 G_END_DECLS
 221
 222 #endif /*__render_h*/