wrlib/wraster.h

   1 /*
   2  *  Raster graphics library
   3  *
   4  *  Copyright (c) 1997 ~ 2000 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.21 */
  43 #define WRASTER_HEADER_VERSION  21
  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
 152     struct RHermesData *hermes_data;   /* handle for Hermes stuff */
 153 } RContext;
 154
 155
 156 typedef struct RColor {
 157     unsigned char red;
 158     unsigned char green;
 159     unsigned char blue;
 160     unsigned char alpha;
 161 } RColor;
 162
 163
 164 typedef struct RHSVColor {
 165     unsigned short hue;                /* 0-359 */
 166     unsigned char saturation;          /* 0-255 */
 167     unsigned char value;               /* 0-255 */
 168 } RHSVColor;
 169
 170
 171
 172 typedef struct RPoint {
 173     int x, y;
 174 } RPoint;
 175
 176
 177 typedef struct RSegment {
 178     int x1, y1, x2, y2;
 179 } RSegment;
 180
 181
 182
 183 /* image formats */
 184 enum RImageFormat {
 185     RRGBFormat,
 186     RRGBAFormat
 187 };
 188
 189
 190 /*
 191  * internal 24bit+alpha image representation
 192  */
 193 typedef struct RImage {
 194     unsigned char *data;               /* image data RGBA or RGB */
 195     int width, height;         /* size of the image */
 196     enum RImageFormat format;
 197     RColor background;                 /* background color */
 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(char *file);
 302
 303 /*
 304  * Xlib contexts
 305  */
 306 RContext *RCreateContext(Display *dpy, int screen_number,
 307                          RContextAttributes *attribs);
 308
 309 void RDestroyContext(RContext *context);
 310
 311 Bool RGetClosestXColor(RContext *context, 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, char *file, int index);
 324
 325
 326 void RDestroyImage(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 RCombineImagesWithOpaqueness(RImage *image, RImage *src, int opaqueness);
 351
 352 void RCombineAreaWithOpaqueness(RImage *image, RImage *src, int sx, int sy,
 353                                unsigned width, unsigned height, int dx, int dy,
 354                                int opaqueness);
 355
 356 RImage *RScaleImage(RImage *image, unsigned new_width, unsigned new_height);
 357
 358 RImage *RSmoothScaleImage(RImage *src, unsigned new_width,
 359                           unsigned new_height);
 360
 361 RImage *RRotateImage(RImage *image, float angle);
 362
 363
 364 RImage *RMakeTiledImage(RImage *tile, unsigned width, unsigned height);
 365
 366 RImage* RMakeCenteredImage(RImage *image, unsigned width, unsigned height,
 367                            RColor *color);
 368
 369 /*
 370  * Drawing
 371  */
 372 Bool RGetPixel(RImage *image, int x, int y, RColor *color);
 373
 374 void RPutPixel(RImage *image, int x, int y, RColor *color);
 375
 376 void ROperatePixel(RImage *image, int operation, int x, int y, RColor *color);
 377
 378 void RPutPixels(RImage *image, RPoint *points, int npoints, int mode,
 379                 RColor *color);
 380
 381 void ROperatePixels(RImage *image, int operation, RPoint *points,
 382                     int npoints, int mode, RColor *color);
 383
 384 int RDrawLine(RImage *image, int x0, int y0, int x1, int y1, RColor *color);
 385
 386 int ROperateLine(RImage *image, int operation, int x0, int y0, int x1, int y1,
 387                  RColor *color);
 388
 389 void RDrawLines(RImage *image, RPoint *points, int npoints, int mode,
 390                 RColor *color);
 391
 392 void ROperateLines(RImage *image, int operation, RPoint *points, int npoints,
 393                    int mode, RColor *color);
 394
 395 void RDrawSegments(RImage *image, RSegment *segs, int nsegs, RColor *color);
 396
 397 void ROperateSegments(RImage *image, int operation, RSegment *segs, int nsegs,
 398                       RColor *color);
 399
 400 /*
 401  * Color convertion
 402  */
 403 void RRGBtoHSV(RColor *color, RHSVColor *hsv);
 404 void RHSVtoRGB(RHSVColor *hsv, RColor *rgb);
 405
 406 /*
 407  * Painting
 408  */
 409 void RClearImage(RImage *image, RColor *color);
 410
 411 void RFillImage(RImage *image, RColor *color);
 412
 413 void RBevelImage(RImage *image, int bevel_type);
 414
 415 RImage *RRenderGradient(unsigned width, unsigned height, RColor *from,
 416                         RColor *to, int style);
 417
 418
 419 RImage *RRenderMultiGradient(unsigned width, unsigned height, RColor **colors,
 420                              int style);
 421
 422
 423 RImage *RRenderInterwovenGradient(unsigned width, unsigned height,
 424                                   RColor colors1[2], int thickness1,
 425                                   RColor colors2[2], int thickness2);
 426
 427
 428 /*
 429  * Convertion into X Pixmaps
 430  */
 431 int RConvertImage(RContext *context, RImage *image, Pixmap *pixmap);
 432
 433 int RConvertImageMask(RContext *context, RImage *image, Pixmap *pixmap,
 434                       Pixmap *mask, int threshold);
 435
 436
 437 /*
 438  * misc. utilities
 439  */
 440 RXImage *RCreateXImage(RContext *context, int depth,
 441                        unsigned width, unsigned height);
 442
 443 RXImage *RGetXImage(RContext *context, Drawable d, int x, int y,
 444                     unsigned width, unsigned height);
 445
 446 void RDestroyXImage(RContext *context, RXImage *ximage);
 447
 448 void RPutXImage(RContext *context, Drawable d, GC gc, RXImage *ximage,
 449                 int src_x, int src_y, int dest_x, int dest_y,
 450                 unsigned width, unsigned height);
 451
 452 /* do not free the returned string! */
 453 const char *RMessageForError(int errorCode);
 454
 455 int RBlurImage(RImage *image);
 456
 457 /****** Global Variables *******/
 458
 459 extern int RErrorCode;
 460
 461 #ifdef __cplusplus
 462 }
 463 #endif /* __cplusplus */
 464
 465 #endif