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