render2/render.h

   1 #ifndef __render_h__
   2 #define __render_h__
   3
   4 #include <glib.h>
   5 #include <X11/Xlib.h>
   6
   7 /* initialization */
   8
   9 struct RrInstance;
  10
  11 /*! Returns a struct to be used when calling members of the library.
  12   If the library fails to initialize, NULL is returned.
  13   @param display The X Display to use.
  14   @param screen The number of the screen to use.
  15 */
  16 struct RrInstance *RrInit(Display *display,
  17                           int screen);
  18
  19 /*! Destroys an instance of the library. The instance should not be used after
  20   calling this function.
  21   @param inst The instance to destroy.
  22 */
  23 void RrDestroy(struct RrInstance *inst);
  24
  25
  26 /* colors */
  27
  28 /*! A Color (including alpha component) for the Render library. This should be
  29   treated as an opaque data type, and be accessed only via the available
  30   functions. */
  31 struct RrColor {
  32     /*! The red component. */
  33     float r;
  34     /*! The green component. */
  35     float g;
  36     /*! The blue component. */
  37     float b;
  38     /*! The alpha component. */
  39     float a;
  40 };
  41
  42 /*! Returns the red component for an RrColor */
  43 #define RrColorRed(c) (c)->r
  44 /*! Returns the green component for an RrColor */
  45 #define RrColorGreen(c) (c)->g
  46 /*! Returns the blue component for an RrColor */
  47 #define RrColorBlue(c) (c)->b
  48 /*! Returns the alpha component for an RrColor */
  49 #define RrColorAlpha(c) (c)->a
  50
  51 /*! Sets the values of all components for an RrColor */
  52 #define RrColorSet(c, w, x, y, z) (c)->r = (w), (c)->g = (x), \
  53                                   (c)->b = (y), (c)->a = z
  54
  55
  56 /*! Gets color values from a colorname.
  57   @param inst An instance of the library
  58   @param colorname The name of the color.
  59   @param ret The RrColor to set the colorvalues in.
  60   @return nonzero if the colorname could be parsed; on error, it returns zero.
  61 */
  62 int RrColorParse(struct RrInstance *inst, const char *colorname,
  63                  struct RrColor *ret);
  64
  65 /* fonts */
  66
  67 struct RrFont;
  68
  69 struct RrFont *RrFontOpen(struct RrInstance *inst, const char *fontstring);
  70 void RrFontClose(struct RrFont *font);
  71
  72 int RrFontMeasureString(struct RrFont *font, const char *string);
  73 int RrFontHeight(struct RrFont *font);
  74 int RrFontMaxCharWidth(struct RrFont *font);
  75
  76 /* surfaces */
  77
  78 struct RrSurface;
  79
  80 enum RrSurfaceType {
  81     RR_SURFACE_PLANAR,
  82     RR_SURFACE_NONPLANAR
  83 };
  84
  85 /*! The options available for the background of an RrSurface */
  86 enum RrSurfaceColorType {
  87     /*! No rendering on the surface background, its contents will be
  88       undefined. */
  89     RR_SURFACE_NONE,
  90     /*! Solid color fill. */
  91     RR_SURFACE_SOLID,
  92     /*! Horizontal gradient. */
  93     RR_SURFACE_HORIZONTAL,
  94     /*! Vertical gradient. */
  95     RR_SURFACE_VERTICAL,
  96     /*! Diagonal (TL->BR) gradient. */
  97     RR_SURFACE_DIAGONAL,
  98     /*! Cross-Diagonal (TR->BL) gradient. */
  99     RR_SURFACE_CROSSDIAGONAL,
 100     /*! Pipecross gradient. */
 101     RR_SURFACE_PIPECROSS,
 102     /*! Rectangle gradient. */
 103     RR_SURFACE_RECTANGLE,
 104     /*! Pyramid gradient. */
 105     RR_SURFACE_PYRAMID
 106 };
 107
 108 /*! Create a new RrSurface prototype that can't render. A prototype can be
 109  copied to a new RrSurface that can render. */
 110 struct RrSurface *RrSurfaceNewProto(enum RrSurfaceType type,
 111                                     int numtex);
 112 /*! Create a new top-level RrSurface for a Window. */
 113 struct RrSurface *RrSurfaceNew(struct RrInstance *inst,
 114                                enum RrSurfaceType type,
 115                                Window win,
 116                                int numtex);
 117 /*! Create a new RrSurface which is a child of another. */
 118 struct RrSurface *RrSurfaceNewChild(enum RrSurfaceType type,
 119                                     struct RrSurface *parent,
 120                                     int numtex);
 121 /*! Copy an RrSurface, creating a new top-level RrSurface for a Window. */
 122 struct RrSurface *RrSurfaceCopy(struct RrInstance *inst,
 123                                 struct RrSurface *sur,
 124                                 Window win);
 125 /*! Copy an RrSurface, creating a nwe RrSurface which is a child of another. */
 126 struct RrSurface *RrSurfaceCopyChild(struct RrSurface *sur,
 127                                      struct RrSurface *parent);
 128 void RrSurfaceFree(struct RrSurface *sur);
 129
 130 Window RrSurfaceWindow(struct RrSurface *sur);
 131
 132 /* textures */
 133
 134 enum RrLayout {
 135     RR_TOP_LEFT,
 136     RR_TOP,
 137     RR_TOP_RIGHT,
 138     RR_LEFT,
 139     RR_CENTER,
 140     RR_RIGHT,
 141     RR_BOTTOM_LEFT,
 142     RR_BOTTOM,
 143     RR_BOTTOM_RIGHT
 144 };
 145
 146 #ifndef __LONG64
 147 typedef long RrData32;
 148 #else
 149 typedef int RrData32;
 150 #endif
 151
 152 void RrTextureSetRGBA(struct RrSurface *sur,
 153                       int texnum,
 154                       RrData32 *data,
 155                       int x,
 156                       int y,
 157                       int w,
 158                       int h);
 159 void RrTextureSetText(struct RrSurface *sur,
 160                       int texnum,
 161                       struct RrFont *font,
 162                       enum RrLayout layout,
 163                       const char *text);
 164
 165 #endif