wrlib/wraster.h

   1 /*
   2  *  Raster graphics library
   3  *
   4  *  Copyright (c) 1997, 1998, 1999 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.20 */
  43 #define WRASTER_HEADER_VERSION  20
  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
  54 #ifdef __cplusplus
  55 extern "C" {
  56 #endif /* __cplusplus */
  57
  58 /* RBestMatchRendering or RDitheredRendering */
  59 #define RC_RenderMode           (1<<0)
  60
  61 /* number of colors per channel for colormap in PseudoColor mode */
  62 #define RC_ColorsPerChannel     (1<<1)
  63
  64 /* do gamma correction */
  65 #define RC_GammaCorrection      (1<<2)
  66
  67 /* visual id to use */
  68 #define RC_VisualID             (1<<3)
  69
  70 /* shared memory usage */
  71 #define RC_UseSharedMemory      (1<<4)
  72
  73 /* use default instead of best visual */
  74 #define RC_DefaultVisual        (1<<5)
  75
  76 /* filter type for smoothed scaling */
  77 #define RC_ScalingFilter        (1<<6)
  78
  79 /* standard colormap usage */
  80 #define RC_StandardColormap     (1<<7)
  81
  82
  83
  84
  85
  86
  87 /* std colormap usage/creation modes */
  88 enum {
  89     RUseStdColormap,                   /* default. fallbacks to RIgnore.. if
  90                                         there is none defined */
  91         RCreateStdColormap,
  92         RIgnoreStdColormap
  93 };
  94
  95
  96
  97 typedef struct RContextAttributes {
  98     int flags;
  99     int render_mode;
 100     int colors_per_channel;            /* for PseudoColor */
 101     float rgamma;                      /* gamma correction for red, */
 102     float ggamma;                      /* green, */
 103     float bgamma;                      /* and blue */
 104     VisualID visualid;                 /* visual ID to use */
 105     int use_shared_memory;             /* True of False */
 106     int scaling_filter;
 107     int standard_colormap_mode;        /* what to do with std cma */
 108 } RContextAttributes;
 109
 110
 111 /*
 112  * describes a screen in terms of depth, visual, number of colors
 113  * we can use, if we should do dithering, and what colors to use for
 114  * dithering.
 115  */
 116 typedef struct RContext {
 117     Display *dpy;
 118     int screen_number;
 119     Colormap cmap;
 120
 121     RContextAttributes *attribs;
 122
 123     GC copy_gc;
 124
 125     Visual *visual;
 126     int depth;
 127     Window drawable;                   /* window to pass for XCreatePixmap().*/
 128                                        /* generally = root */
 129     int vclass;
 130
 131     unsigned long black;
 132     unsigned long white;
 133
 134     int red_offset;                    /* only used in 24bpp */
 135     int green_offset;
 136     int blue_offset;
 137
 138     /* only used for pseudocolor and grayscale */
 139
 140     XStandardColormap *std_rgb_map;    /* standard RGB colormap */
 141     XStandardColormap *std_gray_map;   /* standard grayscale colormap */
 142
 143     int ncolors;                       /* total number of colors we can use */
 144     XColor *colors;                    /* internal colormap */
 145
 146     struct {
 147         unsigned int use_shared_pixmap:1;
 148         unsigned int optimize_for_speed:1;
 149     } flags;
 150 } RContext;
 151
 152
 153 typedef struct RColor {
 154     unsigned char red;
 155     unsigned char green;
 156     unsigned char blue;
 157     unsigned char alpha;
 158 } RColor;
 159
 160
 161 typedef struct RHSVColor {
 162     unsigned short hue;                /* 0-359 */
 163     unsigned char saturation;          /* 0-255 */
 164     unsigned char value;               /* 0-255 */
 165 } RHSVColor;
 166
 167
 168
 169 typedef struct RPoint {
 170     int x, y;
 171 } RPoint;
 172
 173
 174 typedef struct RSegment {
 175     int x1, y1, x2, y2;
 176 } RSegment;
 177
 178
 179
 180 /* image formats */
 181 enum RImageFormat {
 182     RRGBFormat,
 183     RRGBAFormat
 184 };
 185
 186
 187 /*
 188  * internal 24bit+alpha image representation
 189  */
 190 typedef struct RImage {
 191     unsigned char *data;               /* image data RGBA or RGB */
 192     unsigned width, height;            /* size of the image */
 193     enum RImageFormat format;
 194     RColor background;                 /* background color */
 195 } RImage;
 196
 197
 198 /*
 199  * internal wrapper for XImage. Used for shm abstraction
 200  */
 201 typedef struct RXImage {
 202     XImage *image;
 203
 204     /* Private data. Do not access */
 205 #ifdef XSHM
 206     XShmSegmentInfo info;
 207     char is_shared;
 208 #endif
 209 } RXImage;
 210
 211
 212 /* image display modes */
 213 enum {
 214     RDitheredRendering = 0,
 215     RBestMatchRendering = 1
 216 };
 217
 218
 219 /* smoothed scaling filter types */
 220 enum {
 221     RBoxFilter,
 222         RTriangleFilter,
 223         RBellFilter,
 224         RBSplineFilter,
 225         RLanczos3Filter,
 226         RMitchellFilter
 227 };
 228
 229
 230 /* note that not all operations are supported in all functions */
 231 enum {
 232     RClearOperation,                   /* clear with 0 */
 233         RCopyOperation,
 234         RNormalOperation,              /* same as combine */
 235         RAddOperation,
 236         RSubtractOperation
 237 };
 238
 239
 240 enum {
 241     RAbsoluteCoordinates = 0,
 242     RRelativeCoordinates = 1
 243 };
 244
 245
 246 enum {
 247     RSunkenBevel        = -1,
 248     RNoBevel            = 0,
 249     RRaisedBevel        = 1
 250 };
 251 /* bw compat */
 252 #define RBEV_SUNKEN     RSunkenBevel
 253 /* 1 pixel wide */
 254 #define RBEV_RAISED     RRaisedBevel
 255 /* 1 pixel wide on top/left 2 on bottom/right */
 256 #define RBEV_RAISED2    2
 257 /* 2 pixel width */
 258 #define RBEV_RAISED3    3
 259
 260 enum {
 261     RHorizontalGradient = 2,
 262         RVerticalGradient = 3,
 263         RDiagonalGradient = 4
 264 };
 265 /* for backwards compatibility */
 266 #define RGRD_HORIZONTAL  RHorizontalGradient
 267 #define RGRD_VERTICAL   RVerticalGradient
 268 #define RGRD_DIAGONAL   RDiagonalGradient
 269
 270
 271
 272 /* error codes */
 273 #define RERR_NONE               0
 274 #define RERR_OPEN               1      /* cant open file */
 275 #define RERR_READ               2      /* error reading from file */
 276 #define RERR_WRITE              3      /* error writing to file */
 277 #define RERR_NOMEMORY           4      /* out of memory */
 278 #define RERR_NOCOLOR            5      /* out of color cells */
 279 #define RERR_BADIMAGEFILE       6      /* image file is corrupted or invalid */
 280 #define RERR_BADFORMAT          7      /* image file format is unknown */
 281 #define RERR_BADINDEX           8      /* no such image index in file */
 282
 283 #define RERR_BADVISUALID        16     /* invalid visual ID requested for context */
 284 #define RERR_STDCMAPFAIL        17     /* failed to created std colormap */
 285
 286 #define RERR_XERROR             127    /* internal X error */
 287 #define RERR_INTERNAL           128    /* should not happen */
 288
 289
 290 /*
 291  * Returns a NULL terminated array of strings containing the
 292  * supported formats, such as: TIFF, XPM, PNG, JPEG, PPM, GIF
 293  * Do not free the returned data.
 294  */
 295 char **RSupportedFileFormats(void);
 296
 297
 298 char *RGetImageFileFormat(char *file);
 299
 300 /*
 301  * Xlib contexts
 302  */
 303 RContext *RCreateContext(Display *dpy, int screen_number,
 304                          RContextAttributes *attribs);
 305
 306 void RDestroyContext(RContext *context);
 307
 308 Bool RGetClosestXColor(RContext *context, RColor *color, XColor *retColor);
 309
 310 /*
 311  * RImage creation
 312  */
 313 RImage *RCreateImage(unsigned width, unsigned height, int alpha);
 314
 315 RImage *RCreateImageFromXImage(RContext *context, XImage *image, XImage *mask);
 316
 317 RImage *RCreateImageFromDrawable(RContext *context, Drawable drawable,
 318                                  Pixmap mask);
 319
 320 RImage *RLoadImage(RContext *context, char *file, int index);
 321
 322
 323 void RDestroyImage(RImage *image);
 324
 325 RImage *RGetImageFromXPMData(RContext *context, char **xpmData);
 326
 327 /*
 328  * RImage storing
 329  */
 330 Bool RSaveImage(RImage *image, char *filename, char *format);
 331
 332 /*
 333  * Area manipulation
 334  */
 335 RImage *RCloneImage(RImage *image);
 336
 337 RImage *RGetSubImage(RImage *image, int x, int y, unsigned width,
 338                      unsigned height);
 339
 340 void RCombineImageWithColor(RImage *image, RColor *color);
 341
 342 void RCombineImages(RImage *image, RImage *src);
 343
 344 void RCombineArea(RImage *image, RImage *src, int sx, int sy, unsigned width,
 345                  unsigned height, int dx, int dy);
 346
 347 void RCombineImagesWithOpaqueness(RImage *image, RImage *src, int opaqueness);
 348
 349 void RCombineAreaWithOpaqueness(RImage *image, RImage *src, int sx, int sy,
 350                                unsigned width, unsigned height, int dx, int dy,
 351                                int opaqueness);
 352
 353 RImage *RScaleImage(RImage *image, unsigned new_width, unsigned new_height);
 354
 355 RImage *RSmoothScaleImage(RImage *src, unsigned new_width,
 356                           unsigned new_height);
 357
 358 RImage *RMakeTiledImage(RImage *tile, unsigned width, unsigned height);
 359
 360 RImage* RMakeCenteredImage(RImage *image, unsigned width, unsigned height,
 361                            RColor *color);
 362
 363 /*
 364  * Drawing
 365  */
 366 Bool RGetPixel(RImage *image, int x, int y, RColor *color);
 367
 368 void RPutPixel(RImage *image, int x, int y, RColor *color);
 369
 370 void ROperatePixel(RImage *image, int operation, int x, int y, RColor *color);
 371
 372 void RPutPixels(RImage *image, RPoint *points, int npoints, int mode,
 373                 RColor *color);
 374
 375 void ROperatePixels(RImage *image, int operation, RPoint *points,
 376                     int npoints, int mode, RColor *color);
 377
 378 int RDrawLine(RImage *image, int x0, int y0, int x1, int y1, RColor *color);
 379
 380 int ROperateLine(RImage *image, int operation, int x0, int y0, int x1, int y1,
 381                  RColor *color);
 382
 383 void RDrawLines(RImage *image, RPoint *points, int npoints, int mode,
 384                 RColor *color);
 385
 386 void ROperateLines(RImage *image, int operation, RPoint *points, int npoints,
 387                    int mode, RColor *color);
 388
 389 void RDrawSegments(RImage *image, RSegment *segs, int nsegs, RColor *color);
 390
 391 void ROperateSegments(RImage *image, int operation, RSegment *segs, int nsegs,
 392                       RColor *color);
 393
 394 /*
 395  * Color convertion
 396  */
 397 void RRGBtoHSV(RColor *color, RHSVColor *hsv);
 398 void RHSVtoRGB(RHSVColor *hsv, RColor *rgb);
 399
 400 /*
 401  * Painting
 402  */
 403 void RClearImage(RImage *image, RColor *color);
 404
 405 void RBevelImage(RImage *image, int bevel_type);
 406
 407 RImage *RRenderGradient(unsigned width, unsigned height, RColor *from,
 408                         RColor *to, int style);
 409
 410
 411 RImage *RRenderMultiGradient(unsigned width, unsigned height, RColor **colors,
 412                              int style);
 413
 414
 415
 416 /*
 417  * Convertion into X Pixmaps
 418  */
 419 int RConvertImage(RContext *context, RImage *image, Pixmap *pixmap);
 420
 421 int RConvertImageMask(RContext *context, RImage *image, Pixmap *pixmap,
 422                       Pixmap *mask, int threshold);
 423
 424
 425 /*
 426  * misc. utilities
 427  */
 428 RXImage *RCreateXImage(RContext *context, int depth,
 429                        unsigned width, unsigned height);
 430
 431 RXImage *RGetXImage(RContext *context, Drawable d, int x, int y,
 432                     unsigned width, unsigned height);
 433
 434 void RDestroyXImage(RContext *context, RXImage *ximage);
 435
 436 void RPutXImage(RContext *context, Drawable d, GC gc, RXImage *ximage,
 437                 int src_x, int src_y, int dest_x, int dest_y,
 438                 unsigned width, unsigned height);
 439
 440 /* do not free the returned string! */
 441 const char *RMessageForError(int errorCode);
 442
 443 int RBlurImage(RImage *image);
 444
 445 /****** Global Variables *******/
 446
 447 extern int RErrorCode;
 448
 449 #ifdef __cplusplus
 450 }
 451 #endif /* __cplusplus */
 452
 453 #endif