draw.h

   1 /*
   2 Copyright (C) 1996-1997 Id Software, Inc.
   3
   4 This program is free software; you can redistribute it and/or
   5 modify it under the terms of the GNU General Public License
   6 as published by the Free Software Foundation; either version 2
   7 of the License, or (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  12
  13 See the GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  18
  19 */
  20
  21 // draw.h -- these are the only functions outside the refresh allowed
  22 // to touch the vid buffer
  23
  24 #ifndef DRAW_H
  25 #define DRAW_H
  26
  27 // FIXME: move this stuff to cl_screen
  28 typedef struct cachepic_s
  29 {
  30         // size of pic
  31         int width, height;
  32         // renderer texture to use
  33         rtexture_t *tex;
  34         // used for hash lookups
  35         struct cachepic_s *chain;
  36         // name of pic
  37         char name[MAX_QPATH];
  38 }
  39 cachepic_t;
  40
  41 void Draw_Init (void);
  42 cachepic_t *Draw_CachePic (const char *path, qboolean persistent);
  43 // create or update a pic's image
  44 cachepic_t *Draw_NewPic(const char *picname, int width, int height, int alpha, unsigned char *pixels);
  45 // free the texture memory used by a pic
  46 void Draw_FreePic(const char *picname);
  47
  48 // a triangle mesh..
  49 // each vertex is 3 floats
  50 // each texcoord is 2 floats
  51 // each color is 4 floats
  52 typedef struct drawqueuemesh_s
  53 {
  54         rtexture_t *texture;
  55         int num_triangles;
  56         int num_vertices;
  57         int *data_element3i;
  58         float *data_vertex3f;
  59         float *data_texcoord2f;
  60         float *data_color4f;
  61 }
  62 drawqueuemesh_t;
  63
  64 enum drawqueue_drawflag_e {
  65 DRAWFLAG_NORMAL,
  66 DRAWFLAG_ADDITIVE,
  67 DRAWFLAG_MODULATE,
  68 DRAWFLAG_2XMODULATE,
  69 DRAWFLAG_NUMFLAGS
  70 };
  71
  72 // shared color tag printing constants
  73 #define STRING_COLOR_TAG                        '^'
  74 #define STRING_COLOR_DEFAULT            7
  75 #define STRING_COLOR_DEFAULT_STR        "^7"
  76
  77 // all of these functions will set r_defdef.draw2dstage if not in 2D rendering mode (and of course prepare for 2D rendering in that case)
  78
  79 // draw an image (or a filled rectangle if pic == NULL)
  80 void DrawQ_Pic(float x, float y, cachepic_t *pic, float width, float height, float red, float green, float blue, float alpha, int flags);
  81 // draw a filled rectangle (slightly faster than DrawQ_Pic with pic = NULL)
  82 void DrawQ_Fill(float x, float y, float width, float height, float red, float green, float blue, float alpha, int flags);
  83 // draw a text string,
  84 // with optional color tag support,
  85 // returns final unclipped x coordinate
  86 // if outcolor is provided the initial color is read from it, and it is updated at the end with the new value at the end of the text (not at the end of the clipped part)
  87 // the color is tinted by the provided base color
  88 // if r_textshadow is not zero, an additional instance of the text is drawn first at an offset with an inverted shade of gray (black text produces a white shadow, brightly colored text produces a black shadow)
  89 float DrawQ_String(float x, float y, const char *text, int maxlen, float scalex, float scaley, float basered, float basegreen, float baseblue, float basealpha, int flags, int *outcolor, qboolean ignorecolorcodes);
  90 // draw a very fancy pic (per corner texcoord/color control), the order is tl, tr, bl, br
  91 void DrawQ_SuperPic(float x, float y, cachepic_t *pic, float width, float height, float s1, float t1, float r1, float g1, float b1, float a1, float s2, float t2, float r2, float g2, float b2, float a2, float s3, float t3, float r3, float g3, float b3, float a3, float s4, float t4, float r4, float g4, float b4, float a4, int flags);
  92 // draw a triangle mesh
  93 void DrawQ_Mesh(drawqueuemesh_t *mesh, int flags);
  94 // set the clipping area
  95 void DrawQ_SetClipArea(float x, float y, float width, float height);
  96 // reset the clipping area
  97 void DrawQ_ResetClipArea(void);
  98 // draw a line
  99 void DrawQ_Line(float width, float x1, float y1, float x2, float y2, float r, float g, float b, float alpha, int flags);
 100 // draw a line loop
 101 void DrawQ_LineLoop(drawqueuemesh_t *mesh, int flags);
 102 // resets r_refdef.draw2dstage
 103 void DrawQ_Finish(void);
 104
 105 void R_DrawGamma(void);
 106
 107 #endif
 108