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