2 Copyright (C) 1996-1997 Id Software, Inc.
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.
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.
13 See the GNU General Public License for more details.
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.
21 // draw.h -- these are the only functions outside the refresh allowed
22 // to touch the vid buffer
27 // FIXME: move this stuff to cl_screen
28 typedef struct cachepic_s
32 // this flag indicates that it should be loaded and unloaded on demand
34 // texture flags to upload with
36 // texture may be freed after a while
38 // renderer texture to use
40 // used for hash lookups
41 struct cachepic_s *chain;
42 // flags - CACHEPICFLAG_NEWPIC for example
48 // allow to override/free the texture
49 qboolean allow_free_tex;
53 typedef enum cachepicflags_e
55 CACHEPICFLAG_NOTPERSISTENT = 1,
56 CACHEPICFLAG_QUIET = 2,
57 CACHEPICFLAG_NOCOMPRESSION = 4,
58 CACHEPICFLAG_NOCLAMP = 8,
59 CACHEPICFLAG_NEWPIC = 16, // disables matching texflags check, because a pic created with Draw_NewPic should not be subject to that
60 CACHEPICFLAG_MIPMAP = 32,
61 CACHEPICFLAG_NEAREST = 64 // force nearest filtering instead of linear
65 void Draw_Init (void);
66 void Draw_Frame (void);
67 cachepic_t *Draw_CachePic_Flags (const char *path, unsigned int cachepicflags);
68 cachepic_t *Draw_CachePic (const char *path); // standard function with no options, used throughout engine
69 // create or update a pic's image
70 cachepic_t *Draw_NewPic(const char *picname, int width, int height, int alpha, unsigned char *pixels);
71 // free the texture memory used by a pic
72 void Draw_FreePic(const char *picname);
75 // each vertex is 3 floats
76 // each texcoord is 2 floats
77 // each color is 4 floats
78 typedef struct drawqueuemesh_s
84 unsigned short *data_element3s;
86 float *data_texcoord2f;
91 enum drawqueue_drawflag_e {
98 DRAWFLAG_MASK = 0xFF, // ONLY R_BeginPolygon()
99 DRAWFLAG_MIPMAP = 0x100 // ONLY R_BeginPolygon()
101 #define DRAWFLAGS_BLEND (DRAWFLAG_ADDITIVE + DRAWFLAG_MODULATE + DRAWFLAG_2XMODULATE + DRAWFLAG_SCREEN)
103 typedef struct ft2_settings_s
105 float scale, voffset;
106 // cvar parameters (only read on loadfont command)
107 int antialias, hinting;
108 float outline, blur, shadowx, shadowy, shadowz;
111 #define MAX_FONT_SIZES 16
112 #define MAX_FONT_FALLBACKS 3
113 typedef struct dp_font_s
116 float width_of[256]; // width_of[0] == max width of any char; 1.0f is base width (1/16 of texture width); therefore, all widths have to be <= 1 (does not include scale)
117 float maxwidth; // precalculated max width of the font (includes scale)
118 char texpath[MAX_QPATH];
119 char title[MAX_QPATH];
121 int req_face; // requested face index, usually 0
122 float req_sizes[MAX_FONT_SIZES]; // sizes to render the font with, 0 still defaults to 16 (backward compatibility when loadfont doesn't get a size parameter) and -1 = disabled
123 char fallbacks[MAX_FONT_FALLBACKS][MAX_QPATH];
124 int fallback_faces[MAX_FONT_FALLBACKS];
125 struct ft2_font_s *ft2;
127 ft2_settings_t settings;
131 typedef struct dp_fonts_s
137 extern dp_fonts_t dp_fonts;
139 #define MAX_FONTS 16 // fonts at the start
140 #define FONTS_EXPAND 8 // fonts grow when no free slots
141 #define FONT_DEFAULT (&dp_fonts.f[0]) // should be fixed width
142 #define FONT_CONSOLE (&dp_fonts.f[1]) // REALLY should be fixed width (ls!)
143 #define FONT_SBAR (&dp_fonts.f[2]) // must be fixed width
144 #define FONT_NOTIFY (&dp_fonts.f[3]) // free
145 #define FONT_CHAT (&dp_fonts.f[4]) // free
146 #define FONT_CENTERPRINT (&dp_fonts.f[5]) // free
147 #define FONT_INFOBAR (&dp_fonts.f[6]) // free
148 #define FONT_MENU (&dp_fonts.f[7]) // should be fixed width
149 #define FONT_USER(i) (&dp_fonts.f[8+i]) // userdefined fonts
150 #define MAX_USERFONTS (dp_fonts.maxsize - 8)
152 // shared color tag printing constants
153 #define STRING_COLOR_TAG '^'
154 #define STRING_COLOR_DEFAULT 7
155 #define STRING_COLOR_DEFAULT_STR "^7"
156 #define STRING_COLOR_RGB_TAG_CHAR 'x'
157 #define STRING_COLOR_RGB_TAG "^x"
159 // 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)
161 // draw an image (or a filled rectangle if pic == NULL)
162 void DrawQ_Pic(float x, float y, cachepic_t *pic, float width, float height, float red, float green, float blue, float alpha, int flags);
163 // draw a rotated image
164 void DrawQ_RotPic(float x, float y, cachepic_t *pic, float width, float height, float org_x, float org_y, float angle, float red, float green, float blue, float alpha, int flags);
165 // draw a filled rectangle (slightly faster than DrawQ_Pic with pic = NULL)
166 void DrawQ_Fill(float x, float y, float width, float height, float red, float green, float blue, float alpha, int flags);
167 // draw a text string,
168 // with optional color tag support,
169 // returns final unclipped x coordinate
170 // 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)
171 // the color is tinted by the provided base color
172 // 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)
173 extern float DrawQ_Color[4];
174 float DrawQ_String(float x, float y, const char *text, size_t maxlen, float scalex, float scaley, float basered, float basegreen, float baseblue, float basealpha, int flags, int *outcolor, qboolean ignorecolorcodes, const dp_font_t *fnt);
175 float DrawQ_String_Scale(float x, float y, const char *text, size_t maxlen, float sizex, float sizey, float scalex, float scaley, float basered, float basegreen, float baseblue, float basealpha, int flags, int *outcolor, qboolean ignorecolorcodes, const dp_font_t *fnt);
176 float DrawQ_TextWidth(const char *text, size_t maxlen, float w, float h, qboolean ignorecolorcodes, const dp_font_t *fnt);
177 float DrawQ_TextWidth_UntilWidth(const char *text, size_t *maxlen, float w, float h, qboolean ignorecolorcodes, const dp_font_t *fnt, float maxWidth);
178 float DrawQ_TextWidth_UntilWidth_TrackColors(const char *text, size_t *maxlen, float w, float h, int *outcolor, qboolean ignorecolorcodes, const dp_font_t *fnt, float maxwidth);
179 float DrawQ_TextWidth_UntilWidth_TrackColors_Scale(const char *text, size_t *maxlen, float w, float h, float sw, float sh, int *outcolor, qboolean ignorecolorcodes, const dp_font_t *fnt, float maxwidth);
180 // draw a very fancy pic (per corner texcoord/color control), the order is tl, tr, bl, br
181 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);
182 // draw a triangle mesh
183 void DrawQ_Mesh(drawqueuemesh_t *mesh, int flags, qboolean hasalpha);
184 // set the clipping area
185 void DrawQ_SetClipArea(float x, float y, float width, float height);
186 // reset the clipping area
187 void DrawQ_ResetClipArea(void);
189 void DrawQ_Line(float width, float x1, float y1, float x2, float y2, float r, float g, float b, float alpha, int flags);
190 // draw a lot of lines
191 void DrawQ_Lines (float width, int numlines, const float *vertex3f, const float *color4f, int flags);
193 void DrawQ_LineLoop(drawqueuemesh_t *mesh, int flags);
194 // resets r_refdef.draw2dstage
195 void DrawQ_Finish(void);
196 void DrawQ_ProcessDrawFlag(int flags, qboolean alpha); // sets GL_DepthMask and GL_BlendFunc
197 void DrawQ_RecalcView(void); // use this when changing r_refdef.view.* from e.g. csqc
199 rtexture_t *Draw_GetPicTexture(cachepic_t *pic);
201 void R_DrawGamma(void);
203 extern rtexturepool_t *drawtexturepool; // used by ft2.c