wrlib/wraster.h

   1 /*
   2  * Raster graphics library
   3  *
   4  * Copyright (c) 1997-2003 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 */
  43 #define WRASTER_HEADER_VERSION  22
  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     unsigned long *pixels;             /* RContext->colors[].pixel */
 146
 147     struct {
 148         unsigned int use_shared_pixmap:1;
 149         unsigned int optimize_for_speed:1;
 150     } flags;
 151 } RContext;
 152
 153
 154 typedef struct RColor {
 155     unsigned char red;
 156     unsigned char green;
 157     unsigned char blue;
 158     unsigned char alpha;
 159 } RColor;
 160
 161
 162 typedef struct RHSVColor {
 163     unsigned short hue;        /* 0-359 */
 164     unsigned char saturation;      /* 0-255 */
 165     unsigned char value;               /* 0-255 */
 166 } RHSVColor;
 167
 168
 169
 170 typedef struct RPoint {
 171     int x, y;
 172 } RPoint;
 173
 174
 175 typedef struct RSegment {
 176     int x1, y1, x2, y2;
 177 } RSegment;
 178
 179
 180
 181 /* image formats */
 182 enum RImageFormat {
 183     RRGBFormat,
 184     RRGBAFormat
 185 };
 186
 187
 188 /*
 189  * internal 24bit+alpha image representation
 190  */
 191 typedef struct RImage {
 192     unsigned char *data;       /* image data RGBA or RGB */
 193     int width, height;     /* size of the image */
 194     enum RImageFormat format;
 195     RColor background;     /* background color */
 196     int refCount;
 197 } RImage;
 198
 199
 200 /*
 201  * internal wrapper for XImage. Used for shm abstraction
 202  */
 203 typedef struct RXImage {
 204     XImage *image;
 205
 206     /* Private data. Do not access */
 207 #ifdef XSHM
 208     XShmSegmentInfo info;
 209     char is_shared;
 210 #endif
 211 } RXImage;
 212
 213
 214 /* image display modes */
 215 enum {
 216     RDitheredRendering = 0,
 217     RBestMatchRendering = 1
 218 };
 219
 220
 221 /* smoothed scaling filter types */
 222 enum {
 223     RBoxFilter,
 224     RTriangleFilter,
 225     RBellFilter,
 226     RBSplineFilter,
 227     RLanczos3Filter,
 228     RMitchellFilter
 229 };
 230
 231
 232 /* note that not all operations are supported in all functions */
 233 enum {
 234     RClearOperation,           /* clear with 0 */
 235     RCopyOperation,
 236     RNormalOperation,          /* same as combine */
 237     RAddOperation,
 238     RSubtractOperation
 239 };
 240
 241
 242 enum {
 243     RAbsoluteCoordinates = 0,
 244     RRelativeCoordinates = 1
 245 };
 246
 247
 248 enum {
 249     RSunkenBevel        = -1,
 250     RNoBevel    = 0,
 251     RRaisedBevel        = 1
 252 };
 253 /* bw compat */
 254 #define RBEV_SUNKEN     RSunkenBevel
 255 /* 1 pixel wide */
 256 #define RBEV_RAISED     RRaisedBevel
 257 /* 1 pixel wide on top/left 2 on bottom/right */
 258 #define RBEV_RAISED2    2
 259 /* 2 pixel width */
 260 #define RBEV_RAISED3    3
 261
 262 enum {
 263     RHorizontalGradient = 2,
 264     RVerticalGradient = 3,
 265     RDiagonalGradient = 4
 266 };
 267 /* for backwards compatibility */
 268 #define RGRD_HORIZONTAL  RHorizontalGradient
 269 #define RGRD_VERTICAL   RVerticalGradient
 270 #define RGRD_DIAGONAL   RDiagonalGradient
 271
 272
 273
 274 /* error codes */
 275 #define RERR_NONE               0
 276 #define RERR_OPEN               1      /* cant open file */
 277 #define RERR_READ               2      /* error reading from file */
 278 #define RERR_WRITE              3      /* error writing to file */
 279 #define RERR_NOMEMORY           4      /* out of memory */
 280 #define RERR_NOCOLOR            5      /* out of color cells */
 281 #define RERR_BADIMAGEFILE       6      /* image file is corrupted or invalid */
 282 #define RERR_BADFORMAT          7      /* image file format is unknown */
 283 #define RERR_BADINDEX           8      /* no such image index in file */
 284
 285 #define RERR_BADVISUALID        16     /* invalid visual ID requested for context */
 286 #define RERR_STDCMAPFAIL        17     /* failed to created std colormap */
 287
 288 #define RERR_XERROR             127    /* internal X error */
 289 #define RERR_INTERNAL           128    /* should not happen */
 290
 291
 292 /*
 293  * Returns a NULL terminated array of strings containing the
 294  * supported formats, such as: TIFF, XPM, PNG, JPEG, PPM, GIF
 295  * Do not free the returned data.
 296  */
 297 char **RSupportedFileFormats(void);
 298
 299
 300 char *RGetImageFileFormat(char *file);
 301
 302 /*
 303  * Xlib contexts
 304  */
 305 RContext *RCreateContext(Display *dpy, int screen_number,
 306                          RContextAttributes *attribs);
 307
 308 void RDestroyContext(RContext *context);
 309
 310 Bool RGetClosestXColor(RContext *context, RColor *color, XColor *retColor);
 311
 312 /*
 313  * RImage creation
 314  */
 315 RImage *RCreateImage(unsigned width, unsigned height, int alpha);
 316
 317 RImage *RCreateImageFromXImage(RContext *context, XImage *image, XImage *mask);
 318
 319 RImage *RCreateImageFromDrawable(RContext *context, Drawable drawable,
 320                                  Pixmap mask);
 321
 322 RImage *RLoadImage(RContext *context, char *file, int index);
 323
 324 RImage* RRetainImage(RImage *image);
 325
 326 void RReleaseImage(RImage *image);
 327
 328 RImage *RGetImageFromXPMData(RContext *context, char **xpmData);
 329
 330 /*
 331  * RImage storing
 332  */
 333 Bool RSaveImage(RImage *image, char *filename, char *format);
 334
 335 /*
 336  * Area manipulation
 337  */
 338 RImage *RCloneImage(RImage *image);
 339
 340 RImage *RGetSubImage(RImage *image, int x, int y, unsigned width,
 341                      unsigned height);
 342
 343 void RCombineImageWithColor(RImage *image, RColor *color);
 344
 345 void RCombineImages(RImage *image, RImage *src);
 346
 347 void RCombineArea(RImage *image, RImage *src, int sx, int sy, unsigned width,
 348                   unsigned height, int dx, int dy);
 349
 350 void RCopyArea(RImage *image, RImage *src, int sx, int sy, unsigned width,
 351                unsigned height, int dx, int dy);
 352
 353 void RCombineImagesWithOpaqueness(RImage *image, RImage *src, int opaqueness);
 354
 355 void RCombineAreaWithOpaqueness(RImage *image, RImage *src, int sx, int sy,
 356                                 unsigned width, unsigned height, int dx, int dy,
 357                                 int opaqueness);
 358
 359 RImage *RScaleImage(RImage *image, unsigned new_width, unsigned new_height);
 360
 361 RImage *RSmoothScaleImage(RImage *src, unsigned new_width,
 362                           unsigned new_height);
 363
 364 RImage *RRotateImage(RImage *image, float angle);
 365
 366
 367 RImage *RMakeTiledImage(RImage *tile, unsigned width, unsigned height);
 368
 369 RImage* RMakeCenteredImage(RImage *image, unsigned width, unsigned height,
 370                            RColor *color);
 371
 372 /*
 373  * Drawing
 374  */
 375 Bool RGetPixel(RImage *image, int x, int y, RColor *color);
 376
 377 void RPutPixel(RImage *image, int x, int y, RColor *color);
 378
 379 void ROperatePixel(RImage *image, int operation, int x, int y, RColor *color);
 380
 381 void RPutPixels(RImage *image, RPoint *points, int npoints, int mode,
 382                 RColor *color);
 383
 384 void ROperatePixels(RImage *image, int operation, RPoint *points,
 385                     int npoints, int mode, RColor *color);
 386
 387 int RDrawLine(RImage *image, int x0, int y0, int x1, int y1, RColor *color);
 388
 389 int ROperateLine(RImage *image, int operation, int x0, int y0, int x1, int y1,
 390                  RColor *color);
 391
 392 void RDrawLines(RImage *image, RPoint *points, int npoints, int mode,
 393                 RColor *color);
 394
 395 void ROperateLines(RImage *image, int operation, RPoint *points, int npoints,
 396                    int mode, RColor *color);
 397
 398 void RDrawSegments(RImage *image, RSegment *segs, int nsegs, RColor *color);
 399
 400 void ROperateSegments(RImage *image, int operation, RSegment *segs, int nsegs,
 401                       RColor *color);
 402
 403 /*
 404  * Color convertion
 405  */
 406 void RRGBtoHSV(RColor *color, RHSVColor *hsv);
 407 void RHSVtoRGB(RHSVColor *hsv, RColor *rgb);
 408
 409 /*
 410  * Painting
 411  */
 412 void RClearImage(RImage *image, RColor *color);
 413
 414 void RLightImage(RImage *image, RColor *color);
 415
 416 void RFillImage(RImage *image, RColor *color);
 417
 418 void RBevelImage(RImage *image, int bevel_type);
 419
 420 RImage *RRenderGradient(unsigned width, unsigned height, RColor *from,
 421                         RColor *to, int style);
 422
 423
 424 RImage *RRenderMultiGradient(unsigned width, unsigned height, RColor **colors,
 425                              int style);
 426
 427
 428 RImage *RRenderInterwovenGradient(unsigned width, unsigned height,
 429                                   RColor colors1[2], int thickness1,
 430                                   RColor colors2[2], int thickness2);
 431
 432
 433 /*
 434  * Convertion into X Pixmaps
 435  */
 436 int RConvertImage(RContext *context, RImage *image, Pixmap *pixmap);
 437
 438 int RConvertImageMask(RContext *context, RImage *image, Pixmap *pixmap,
 439                       Pixmap *mask, int threshold);
 440
 441
 442 /*
 443  * misc. utilities
 444  */
 445 RXImage *RCreateXImage(RContext *context, int depth,
 446                        unsigned width, unsigned height);
 447
 448 RXImage *RGetXImage(RContext *context, Drawable d, int x, int y,
 449                     unsigned width, unsigned height);
 450
 451 void RDestroyXImage(RContext *context, RXImage *ximage);
 452
 453 void RPutXImage(RContext *context, Drawable d, GC gc, RXImage *ximage,
 454                 int src_x, int src_y, int dest_x, int dest_y,
 455                 unsigned width, unsigned height);
 456
 457 /* do not free the returned string! */
 458 const char *RMessageForError(int errorCode);
 459
 460 int RBlurImage(RImage *image);
 461
 462 /****** Global Variables *******/
 463
 464 extern int RErrorCode;
 465
 466 #ifdef __cplusplus
 467 }
 468 #endif /* __cplusplus */
 469
 470 #endif
 471