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 struct RrTexture;
  80
  81 enum RrSurfaceType {
  82     RR_SURFACE_PLANAR,
  83     RR_SURFACE_NONPLANAR
  84 };
  85
  86 enum RrTextureType {
  87     RR_TEXTURE_FOO
  88 };
  89
  90 /*! The options available for the background of an RrSurface */
  91 enum RrSurfaceColorType {
  92     /*! No rendering on the surface background, its contents will be
  93       undefined. */
  94     RR_SURFACE_NONE,
  95     /*! Solid color fill. */
  96     RR_SURFACE_SOLID,
  97     /*! Horizontal gradient. */
  98     RR_SURFACE_HORIZONTAL,
  99     /*! Vertical gradient. */
 100     RR_SURFACE_VERTICAL,
 101     /*! Diagonal (TL->BR) gradient. */
 102     RR_SURFACE_DIAGONAL,
 103     /*! Cross-Diagonal (TR->BL) gradient. */
 104     RR_SURFACE_CROSSDIAGONAL,
 105     /*! Pipecross gradient. */
 106     RR_SURFACE_PIPECROSS,
 107     /*! Rectangle gradient. */
 108     RR_SURFACE_RECTANGLE,
 109     /*! Pyramid gradient. */
 110     RR_SURFACE_PYRAMID
 111 };
 112
 113 /*! Create a new RrSurface prototype that can't render. A prototype can be
 114  copied to a new RrSurface that can render. */
 115 struct RrSurface *RrSurfaceNewProto(enum RrSurfaceType type,
 116                                     int numtex);
 117 /*! Create a new top-level RrSurface for a Window. */
 118 struct RrSurface *RrSurfaceNew(struct RrInstance *inst,
 119                                enum RrSurfaceType type,
 120                                Window win,
 121                                int numtex);
 122 /*! Create a new RrSurface which is a child of another. */
 123 struct RrSurface *RrSurfaceNewChild(enum RrSurfaceType type,
 124                                     struct RrSurface *parent,
 125                                     int numtex);
 126 /*! Copy an RrSurface, creating a new top-level RrSurface for a Window. */
 127 struct RrSurface *RrSurfaceCopy(struct RrInstance *inst,
 128                                 struct RrSurface *sur,
 129                                 Window win);
 130 /*! Copy an RrSurface, creating a nwe RrSurface which is a child of another. */
 131 struct RrSurface *RrSurfaceCopyChild(struct RrSurface *sur,
 132                                      struct RrSurface *parent);
 133 void RrSurfaceFree(struct RrSurface *sur);
 134
 135 Window RrSurfaceWindow(struct RrSurface *sur);
 136 struct RrTexture *RrSurfaceTexture(struct RrSurface *sur, int texnum);
 137
 138 #endif