fixed gfx/menuplyr handling - Draw_NewPic now flags the cachepic_t with
[xonotic/darkplaces.git] / 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         // this flag indicates that it should be loaded and unloaded on demand
33         int autoload;
34         // texture flags to upload with
35         int texflags;
36         // texture may be freed after a while
37         int lastusedframe;
38         // renderer texture to use
39         rtexture_t *tex;
40         // used for hash lookups
41         struct cachepic_s *chain;
42         // flags - CACHEPICFLAG_NEWPIC for example
43         unsigned int flags;
44         // has alpha?
45         qboolean hasalpha;
46         // name of pic
47         char name[MAX_QPATH];
48 }
49 cachepic_t;
50
51 typedef enum cachepicflags_e
52 {
53         CACHEPICFLAG_NOTPERSISTENT = 1,
54         CACHEPICFLAG_QUIET = 2,
55         CACHEPICFLAG_NOCOMPRESSION = 4,
56         CACHEPICFLAG_NOCLAMP = 8,
57         CACHEPICFLAG_NEWPIC = 16 // disables matching texflags check, because a pic created with Draw_NewPic should not be subject to that
58 }
59 cachepicflags_t;
60
61 void Draw_Init (void);
62 void Draw_Frame (void);
63 cachepic_t *Draw_CachePic_Flags (const char *path, unsigned int cachepicflags);
64 cachepic_t *Draw_CachePic (const char *path); // standard function with no options, used throughout engine
65 // create or update a pic's image
66 cachepic_t *Draw_NewPic(const char *picname, int width, int height, int alpha, unsigned char *pixels);
67 // free the texture memory used by a pic
68 void Draw_FreePic(const char *picname);
69
70 // a triangle mesh..
71 // each vertex is 3 floats
72 // each texcoord is 2 floats
73 // each color is 4 floats
74 typedef struct drawqueuemesh_s
75 {
76         rtexture_t *texture;
77         int num_triangles;
78         int num_vertices;
79         int *data_element3i;
80         unsigned short *data_element3s;
81         float *data_vertex3f;
82         float *data_texcoord2f;
83         float *data_color4f;
84 }
85 drawqueuemesh_t;
86
87 enum drawqueue_drawflag_e {
88 DRAWFLAG_NORMAL,
89 DRAWFLAG_ADDITIVE,
90 DRAWFLAG_MODULATE,
91 DRAWFLAG_2XMODULATE,
92 DRAWFLAG_SCREEN,
93 DRAWFLAG_NUMFLAGS,
94 DRAWFLAG_MASK = 0xFF,   // ONLY R_BeginPolygon()
95 DRAWFLAG_MIPMAP = 0x100 // ONLY R_BeginPolygon()
96 };
97
98 typedef struct ft2_settings_s
99 {
100         float scale, voffset;
101         // cvar parameters (only read on loadfont command)
102         int antialias, hinting;
103         float outline, blur, shadowx, shadowy, shadowz;
104 } ft2_settings_t;
105
106 #define MAX_FONT_SIZES 16
107 #define MAX_FONT_FALLBACKS 3
108 typedef struct dp_font_s
109 {
110         rtexture_t *tex;
111         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)
112         float maxwidth; // precalculated max width of the font (includes scale)
113         char texpath[MAX_QPATH];
114         char title[MAX_QPATH];
115
116         int req_face; // requested face index, usually 0
117         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
118         char fallbacks[MAX_FONT_FALLBACKS][MAX_QPATH];
119         int fallback_faces[MAX_FONT_FALLBACKS];
120         struct ft2_font_s *ft2;
121
122         ft2_settings_t settings;
123 }
124 dp_font_t;
125
126 typedef struct dp_fonts_s
127 {
128         dp_font_t *f;
129         int maxsize;
130 }
131 dp_fonts_t;
132 extern dp_fonts_t dp_fonts;
133
134 #define MAX_FONTS         16 // fonts at the start
135 #define FONTS_EXPAND       8  // fonts grow when no free slots
136 #define FONT_DEFAULT     (&dp_fonts.f[0]) // should be fixed width
137 #define FONT_CONSOLE     (&dp_fonts.f[1]) // REALLY should be fixed width (ls!)
138 #define FONT_SBAR        (&dp_fonts.f[2]) // must be fixed width
139 #define FONT_NOTIFY      (&dp_fonts.f[3]) // free
140 #define FONT_CHAT        (&dp_fonts.f[4]) // free
141 #define FONT_CENTERPRINT (&dp_fonts.f[5]) // free
142 #define FONT_INFOBAR     (&dp_fonts.f[6]) // free
143 #define FONT_MENU        (&dp_fonts.f[7]) // should be fixed width
144 #define FONT_USER(i)     (&dp_fonts.f[8+i]) // userdefined fonts
145 #define MAX_USERFONTS    (dp_fonts.maxsize - 8)
146
147 // shared color tag printing constants
148 #define STRING_COLOR_TAG                        '^'
149 #define STRING_COLOR_DEFAULT            7
150 #define STRING_COLOR_DEFAULT_STR        "^7"
151 #define STRING_COLOR_RGB_TAG_CHAR       'x'
152 #define STRING_COLOR_RGB_TAG            "^x"
153
154 // 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)
155
156 // draw an image (or a filled rectangle if pic == NULL)
157 void DrawQ_Pic(float x, float y, cachepic_t *pic, float width, float height, float red, float green, float blue, float alpha, int flags);
158 // draw a rotated image
159 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);
160 // draw a filled rectangle (slightly faster than DrawQ_Pic with pic = NULL)
161 void DrawQ_Fill(float x, float y, float width, float height, float red, float green, float blue, float alpha, int flags);
162 // draw a text string,
163 // with optional color tag support,
164 // returns final unclipped x coordinate
165 // 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)
166 // the color is tinted by the provided base color
167 // 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)
168 extern float DrawQ_Color[4];
169 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);
170 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);
171 float DrawQ_TextWidth(const char *text, size_t maxlen, float w, float h, qboolean ignorecolorcodes, const dp_font_t *fnt);
172 float DrawQ_TextWidth_UntilWidth(const char *text, size_t *maxlen, float w, float h, qboolean ignorecolorcodes, const dp_font_t *fnt, float maxWidth);
173 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);
174 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);
175 // draw a very fancy pic (per corner texcoord/color control), the order is tl, tr, bl, br
176 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);
177 // draw a triangle mesh
178 void DrawQ_Mesh(drawqueuemesh_t *mesh, int flags, qboolean hasalpha);
179 // set the clipping area
180 void DrawQ_SetClipArea(float x, float y, float width, float height);
181 // reset the clipping area
182 void DrawQ_ResetClipArea(void);
183 // draw a line
184 void DrawQ_Line(float width, float x1, float y1, float x2, float y2, float r, float g, float b, float alpha, int flags);
185 // draw a lot of lines
186 void DrawQ_Lines (float width, int numlines, const float *vertex3f, const float *color4f, int flags);
187 // draw a line loop
188 void DrawQ_LineLoop(drawqueuemesh_t *mesh, int flags);
189 // resets r_refdef.draw2dstage
190 void DrawQ_Finish(void);
191 void DrawQ_ProcessDrawFlag(int flags, qboolean alpha); // sets GL_DepthMask and GL_BlendFunc
192 void DrawQ_RecalcView(void); // use this when changing r_refdef.view.* from e.g. csqc
193
194 rtexture_t *Draw_GetPicTexture(cachepic_t *pic);
195
196 void R_DrawGamma(void);
197
198 extern rtexturepool_t *drawtexturepool; // used by ft2.c
199
200 #endif
201