wrlib/wraster.h

   1 /*
   2  *  Raster graphics library
   3  *
   4  *  Copyright (c) 1997, 1998 Alfredo K. Kojima
   5  *
   6  *  This library is free software; you can redistribute it and/or
   7  *  modify it under the terms of the GNU Library General Public
   8  *  License as published by the Free Software Foundation; either
   9  *  version 2 of the License, or (at your option) any later version.
  10  *
  11  *  This library is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  *  Library General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU Library General Public
  17  *  License along with this library; if not, write to the Free
  18  *  Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19  */
  20
  21 /*
  22  * Environment variables:
  23  *
  24  * WRASTER_GAMMA <rgamma>/<ggamma>/<bgamma>
  25  * gamma correction value. Must be  greater than 0
  26  * Only for PseudoColor visuals.
  27  *
  28  * Default:
  29  * WRASTER_GAMMA 1/1/1
  30  *
  31  *
  32  * If you want a specific value for a screen, append the screen number
  33  * preceded by a hash to the variable name as in
  34  * WRASTER_GAMMA#1
  35  * for screen number 1
  36  */
  37
  38 #ifndef RLRASTER_H_
  39 #define RLRASTER_H_
  40
  41
  42 /* version of the header for the library: 0.11 */
  43 #define WRASTER_HEADER_VERSION  11
  44
  45
  46 #include <X11/Xlib.h>
  47 #include <X11/Xutil.h>
  48
  49 #ifdef XSHM
  50 #include <X11/extensions/XShm.h>
  51 #endif
  52
  53 /* RM_MATCH or RM_DITHER */
  54 #define RC_RenderMode           (1<<0)
  55
  56 /* number of colors per channel for colormap in PseudoColor mode */
  57 #define RC_ColorsPerChannel     (1<<1)
  58
  59 /* do gamma correction */
  60 #define RC_GammaCorrection      (1<<2)
  61
  62 /* visual id to use */
  63 #define RC_VisualID             (1<<3)
  64
  65 /* shared memory usage */
  66 #define RC_UseSharedMemory      (1<<4)
  67
  68 /* use default instead of best visual */
  69 #define RC_DefaultVisual        (1<<5)
  70
  71 typedef struct RContextAttributes {
  72     int flags;
  73     int render_mode;
  74     int colors_per_channel;            /* for PseudoColor */
  75     float rgamma;                      /* gamma correction for red, */
  76     float ggamma;                      /* green, */
  77     float bgamma;                      /* and blue */
  78     VisualID visualid;                 /* visual ID to use */
  79     int use_shared_memory;             /* True of False */
  80 } RContextAttributes;
  81
  82
  83 /*
  84  * describes a screen in terms of depth, visual, number of colors
  85  * we can use, if we should do dithering, and what colors to use for
  86  * dithering.
  87  */
  88 typedef struct RContext {
  89     Display *dpy;
  90     int screen_number;
  91     Colormap cmap;
  92
  93     RContextAttributes *attribs;
  94
  95     GC copy_gc;
  96
  97     Visual *visual;
  98     int depth;
  99     Window drawable;                   /* window to pass for XCreatePixmap().*/
 100                                        /* generally = root */
 101     int vclass;
 102
 103     unsigned long black;
 104     unsigned long white;
 105
 106     int red_offset;                    /* only used in 24bpp */
 107     int green_offset;
 108     int blue_offset;
 109
 110     /* only used for pseudocolor and grayscale */
 111
 112     XStandardColormap *std_rgb_map;    /* standard RGB colormap */
 113     XStandardColormap *std_gray_map;   /* standard grayscale colormap */
 114
 115     int ncolors;                       /* total number of colors we can use */
 116     XColor *colors;                    /* internal colormap */
 117
 118     struct {
 119         unsigned int use_shared_pixmap:1;
 120     } flags;
 121 } RContext;
 122
 123
 124 typedef struct RColor {
 125     unsigned char red;
 126     unsigned char green;
 127     unsigned char blue;
 128     unsigned char alpha;
 129 } RColor;
 130
 131
 132 typedef struct RHSVColor {
 133     unsigned short hue;                /* 0-359 */
 134     unsigned char saturation;          /* 0-255 */
 135     unsigned char value;               /* 0-255 */
 136 } RHSVColor;
 137
 138
 139
 140 typedef struct RPoint {
 141     int x, y;
 142 } RPoint;
 143
 144
 145 typedef struct RSegment {
 146     int x1, y1, x2, y2;
 147 } RSegment;
 148
 149
 150 /*
 151  * internal 24bit+alpha image representation
 152  */
 153 typedef struct RImage {
 154     unsigned width, height;            /* size of the image */
 155     RColor background;                 /* background color */
 156     unsigned char *data[4];            /* image data (R,G,B,A) */
 157 } RImage;
 158
 159
 160 /*
 161  * internal wrapper for XImage. Used for shm abstraction
 162  */
 163 typedef struct RXImage {
 164     XImage *image;
 165
 166     /* Private data. Do not access */
 167 #ifdef XSHM
 168     XShmSegmentInfo info;
 169     char is_shared;
 170 #endif
 171 } RXImage;
 172
 173
 174 /* note that not all operations are supported in all functions */
 175 enum {
 176     RClearOperation,                   /* clear with 0 */
 177         RCopyOperation,
 178         RNormalOperation,              /* same as combine */
 179         RAddOperation,
 180         RSubtractOperation
 181 };
 182
 183
 184 /* image display modes */
 185 enum {
 186     RDitheredRendering = 0,
 187     RBestMatchRendering = 1
 188 };
 189
 190 /* bw compat */
 191 #define RM_DITHER RDitheredRendering
 192 #define RM_MATCH  RBestMatchRendering
 193
 194 enum {
 195     RAbsoluteCoordinates = 0,
 196     RRelativeCoordinates = 1
 197 };
 198
 199
 200 enum {
 201     RSunkenBevel        = -1,
 202     RRaisedBevel        = 1
 203 };
 204 /* bw compat */
 205 #define RBEV_SUNKEN     RSunkenBevel
 206 /* 1 pixel wide */
 207 #define RBEV_RAISED     RRaisedBevel
 208 /* 1 pixel wide on top/left 2 on bottom/right */
 209 #define RBEV_RAISED2    2
 210 /* 2 pixel width */
 211 #define RBEV_RAISED3    3
 212
 213 enum {
 214     RHorizontalGradient = 2,
 215         RVerticalGradient = 3,
 216         RDiagonalGradient = 4
 217 };
 218 /* for backwards compatibility */
 219 #define RGRD_HORIZONTAL  RHorizontalGradient
 220 #define RGRD_VERTICAL   RVerticalGradient
 221 #define RGRD_DIAGONAL   RDiagonalGradient
 222
 223
 224
 225 /* error codes */
 226 #define RERR_NONE               0
 227 #define RERR_OPEN               1      /* cant open file */
 228 #define RERR_READ               2      /* error reading from file */
 229 #define RERR_WRITE              3      /* error writing to file */
 230 #define RERR_NOMEMORY           4      /* out of memory */
 231 #define RERR_NOCOLOR            5      /* out of color cells */
 232 #define RERR_BADIMAGEFILE       6      /* image file is corrupted or invalid */
 233 #define RERR_BADFORMAT          7      /* image file format is unknown */
 234 #define RERR_BADINDEX           8      /* no such image index in file */
 235
 236 #define RERR_BADVISUALID        16     /* invalid visual ID requested for context */
 237
 238 #define RERR_XERROR             127    /* internal X error */
 239 #define RERR_INTERNAL           128    /* should not happen */
 240
 241
 242 /*
 243  * Returns a NULL terminated array of strings containing the
 244  * supported formats, such as: TIFF, XPM, PNG, JPEG, PPM, GIF
 245  */
 246 char **RSupportedFileFormats(void);
 247
 248 void RFreeStringList(char **list);
 249
 250 /*
 251  * Xlib contexts
 252  */
 253 RContext *RCreateContext(Display *dpy, int screen_number,
 254                          RContextAttributes *attribs);
 255
 256 void RDestroyContext(RContext *context);
 257
 258 Bool RGetClosestXColor(RContext *context, RColor *color, XColor *retColor);
 259
 260 /*
 261  * RImage creation
 262  */
 263 RImage *RCreateImage(unsigned width, unsigned height, int alpha);
 264
 265 RImage *RCreateImageFromXImage(RContext *context, XImage *image, XImage *mask);
 266
 267 RImage *RCreateImageFromDrawable(RContext *context, Drawable drawable,
 268                                  Pixmap mask);
 269
 270 RImage *RLoadImage(RContext *context, char *file, int index);
 271
 272
 273 void RDestroyImage(RImage *image);
 274
 275 RImage *RGetImageFromXPMData(RContext *context, char **data);
 276
 277 /*
 278  * RImage storing
 279  */
 280 Bool RSaveImage(RImage *image, char *filename, char *format);
 281
 282 /*
 283  * Area manipulation
 284  */
 285 RImage *RCloneImage(RImage *image);
 286
 287 RImage *RGetSubImage(RImage *image, int x, int y, unsigned width,
 288                      unsigned height);
 289
 290 void RCombineImageWithColor(RImage *image, RColor *color);
 291
 292 void RCombineImages(RImage *image, RImage *src);
 293
 294 void RCombineArea(RImage *image, RImage *src, int sx, int sy, unsigned width,
 295                  unsigned height, int dx, int dy);
 296
 297 void RCombineImagesWithOpaqueness(RImage *image, RImage *src, int opaqueness);
 298
 299 void RCombineAreaWithOpaqueness(RImage *image, RImage *src, int sx, int sy,
 300                                unsigned width, unsigned height, int dx, int dy,
 301                                int opaqueness);
 302
 303 RImage *RScaleImage(RImage *image, unsigned new_width, unsigned new_height);
 304
 305 RImage *RMakeTiledImage(RImage *tile, unsigned width, unsigned height);
 306
 307 RImage* RMakeCenteredImage(RImage *image, unsigned width, unsigned height,
 308                            RColor *color);
 309
 310 /*
 311  * Drawing
 312  */
 313 Bool RGetPixel(RImage *image, int x, int y, RColor *color);
 314
 315 void RPutPixel(RImage *image, int x, int y, RColor *color);
 316
 317 void ROperatePixel(RImage *image, int operation, int x, int y, RColor *color);
 318
 319 void RPutPixels(RImage *image, RPoint *points, int npoints, int mode,
 320                 RColor *color);
 321
 322 void ROperatePixels(RImage *image, int operation, RPoint *points,
 323                     int npoints, int mode, RColor *color);
 324
 325 int RDrawLine(RImage *image, int x0, int y0, int x1, int y1, RColor *color);
 326
 327 int ROperateLine(RImage *image, int operation, int x0, int y0, int x1, int y1,
 328                  RColor *color);
 329
 330 void RDrawLines(RImage *image, RPoint *points, int npoints, int mode,
 331                 RColor *color);
 332
 333 void ROperateLines(RImage *image, int operation, RPoint *points, int npoints,
 334                    int mode, RColor *color);
 335
 336 void RDrawSegments(RImage *image, RSegment *segs, int nsegs, RColor *color);
 337
 338 void ROperateSegments(RImage *image, int operation, RSegment *segs, int nsegs,
 339                       RColor *color);
 340
 341 /*
 342  * Color convertion
 343  */
 344 void RRGBtoHSV(RColor *color, RHSVColor *hsv);
 345 void RHSVtoRGB(RHSVColor *hsv, RColor *rgb);
 346
 347 /*
 348  * Painting
 349  */
 350 void RClearImage(RImage *image, RColor *color);
 351
 352 void RBevelImage(RImage *image, int bevel_type);
 353
 354 RImage *RRenderGradient(unsigned width, unsigned height, RColor *from,
 355                         RColor *to, int style);
 356
 357
 358 RImage *RRenderMultiGradient(unsigned width, unsigned height, RColor **colors,
 359                              int style);
 360
 361
 362
 363 /*
 364  * Convertion into X Pixmaps
 365  */
 366 int RConvertImage(RContext *context, RImage *image, Pixmap *pixmap);
 367
 368 int RConvertImageMask(RContext *context, RImage *image, Pixmap *pixmap,
 369                       Pixmap *mask, int threshold);
 370
 371
 372 /*
 373  * misc. utilities
 374  */
 375 RXImage *RCreateXImage(RContext *context, int depth,
 376                        unsigned width, unsigned height);
 377
 378 void RDestroyXImage(RContext *context, RXImage *ximage);
 379
 380 void RPutXImage(RContext *context, Drawable d, GC gc, RXImage *ximage,
 381                 int src_x, int src_y, int dest_x, int dest_y,
 382                 unsigned width, unsigned height);
 383
 384 /* do not free the returned string! */
 385 const char *RMessageForError(int errorCode);
 386
 387 int RBlurImage(RImage *image);
 388
 389 /****** Global Variables *******/
 390
 391 extern int RErrorCode;
 392
 393 #endif