1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
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
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.
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.
18 See the COPYING file for a copy of the GNU General Public License.
27 #include <X11/Xlib.h> /* some platforms dont include this as needed for Xft */
28 #include <pango/pangoxft.h>
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;
46 typedef guint32 RrPixel32;
47 typedef guint16 RrPixel16;
48 typedef guchar RrPixel8;
65 RR_SURFACE_SPLIT_VERTICAL,
66 RR_SURFACE_HORIZONTAL,
69 RR_SURFACE_CROSS_DIAGONAL,
71 RR_SURFACE_MIRROR_HORIZONTAL
88 /* Put middle first so it's the default */
99 RR_FONTWEIGHT_SEMIBOLD,
101 RR_FONTWEIGHT_ULTRABOLD
111 RrSurfaceColorType grad;
116 RrColor *border_color;
118 RrColor *bevel_light;
119 RrColor *interlace_color;
122 RrAppearance *parent;
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;
132 struct _RrTextureText {
137 gint shadow_offset_x;
138 gint shadow_offset_y;
139 RrColor *shadow_color;
140 gboolean shortcut; /*!< Underline a character */
141 guint shortcut_pos; /*!< Position in bytes of the character to underline */
142 RrEllipsizeMode ellipsize;
143 gboolean flow; /* allow multiple lines. must set maxwidth below */
145 guchar shadow_alpha; /* at the bottom to improve alignment */
148 struct _RrPixmapMask {
149 const RrInstance *inst;
156 struct _RrTextureMask {
161 struct _RrTextureRGBA {
166 /* cached scaled so we don't have to scale often */
170 /* size and position to draw at */
177 struct _RrTextureLineArt {
185 union _RrTextureData {
189 RrTextureLineArt lineart;
197 struct _RrAppearance {
198 const RrInstance *inst;
206 /* cached for internal use */
210 /* these are the same on all endian machines because it seems to be dependant
211 on the endianness of the gfx card, not the cpu. */
212 #define RrDefaultAlphaOffset 24
213 #define RrDefaultRedOffset 16
214 #define RrDefaultGreenOffset 8
215 #define RrDefaultBlueOffset 0
217 #define RrDefaultFontFamily "arial,sans"
218 #define RrDefaultFontSize 8
219 #define RrDefaultFontWeight RR_FONTWEIGHT_NORMAL
220 #define RrDefaultFontSlant RR_FONTSLANT_NORMAL
222 RrInstance* RrInstanceNew (Display *display, gint screen);
223 void RrInstanceFree (RrInstance *inst);
225 Display* RrDisplay (const RrInstance *inst);
226 gint RrScreen (const RrInstance *inst);
227 Window RrRootWindow (const RrInstance *inst);
228 Visual* RrVisual (const RrInstance *inst);
229 gint RrDepth (const RrInstance *inst);
230 Colormap RrColormap (const RrInstance *inst);
231 gint RrRedOffset (const RrInstance *inst);
232 gint RrGreenOffset (const RrInstance *inst);
233 gint RrBlueOffset (const RrInstance *inst);
234 gint RrRedShift (const RrInstance *inst);
235 gint RrGreenShift (const RrInstance *inst);
236 gint RrBlueShift (const RrInstance *inst);
237 gint RrRedMask (const RrInstance *inst);
238 gint RrGreenMask (const RrInstance *inst);
239 gint RrBlueMask (const RrInstance *inst);
241 RrColor *RrColorNew (const RrInstance *inst, gint r, gint g, gint b);
242 RrColor *RrColorParse (const RrInstance *inst, gchar *colorname);
243 void RrColorFree (RrColor *in);
245 gint RrColorRed (const RrColor *c);
246 gint RrColorGreen (const RrColor *c);
247 gint RrColorBlue (const RrColor *c);
248 gulong RrColorPixel (const RrColor *c);
249 GC RrColorGC (RrColor *c);
251 RrAppearance *RrAppearanceNew (const RrInstance *inst, gint numtex);
252 RrAppearance *RrAppearanceCopy (RrAppearance *a);
253 void RrAppearanceFree (RrAppearance *a);
254 void RrAppearanceRemoveTextures(RrAppearance *a);
255 void RrAppearanceAddTextures(RrAppearance *a, gint numtex);
257 RrFont *RrFontOpen (const RrInstance *inst, const gchar *name,
258 gint size, RrFontWeight weight, RrFontSlant slant);
259 RrFont *RrFontOpenDefault (const RrInstance *inst);
260 void RrFontClose (RrFont *f);
261 RrSize *RrFontMeasureString (const RrFont *f, const gchar *str,
262 gint shadow_offset_x, gint shadow_offset_y,
263 gboolean flow, gint maxwidth);
264 gint RrFontHeight (const RrFont *f, gint shadow_offset_y);
265 gint RrFontMaxCharWidth (const RrFont *f);
267 /* Paint into the appearance. The old pixmap is returned (if there was one). It
268 is the responsibility of the caller to call XFreePixmap on the return when
270 Pixmap RrPaintPixmap (RrAppearance *a, gint w, gint h);
271 void RrPaint (RrAppearance *a, Window win, gint w, gint h);
272 void RrMinSize (RrAppearance *a, gint *w, gint *h);
273 gint RrMinWidth (RrAppearance *a);
274 /* For text textures, if flow is TRUE, then the string must be set before
275 calling this, otherwise it doesn't need to be */
276 gint RrMinHeight (RrAppearance *a);
277 void RrMargins (RrAppearance *a, gint *l, gint *t, gint *r, gint *b);
279 gboolean RrPixmapToRGBA(const RrInstance *inst,
280 Pixmap pmap, Pixmap mask,
281 gint *w, gint *h, RrPixel32 **data);
285 #endif /*__render_h*/