add a menu/csqc field .drawfontscale to scale the font drawn by drawfont but not...
[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         // name of pic
43         char name[MAX_QPATH];
44 }
45 cachepic_t;
46
47 typedef enum cachepicflags_e
48 {
49         CACHEPICFLAG_NOTPERSISTENT = 1,
50         CACHEPICFLAG_QUIET = 2,
51         CACHEPICFLAG_NOCOMPRESSION = 4,
52         CACHEPICFLAG_NOCLAMP = 8,
53 }
54 cachepicflags_t;
55
56 void Draw_Init (void);
57 void Draw_Frame (void);
58 cachepic_t *Draw_CachePic_Flags (const char *path, unsigned int cachepicflags);
59 cachepic_t *Draw_CachePic (const char *path); // standard function with no options, used throughout engine
60 // create or update a pic's image
61 cachepic_t *Draw_NewPic(const char *picname, int width, int height, int alpha, unsigned char *pixels);
62 // free the texture memory used by a pic
63 void Draw_FreePic(const char *picname);
64
65 // a triangle mesh..
66 // each vertex is 3 floats
67 // each texcoord is 2 floats
68 // each color is 4 floats
69 typedef struct drawqueuemesh_s
70 {
71         rtexture_t *texture;
72         int num_triangles;
73         int num_vertices;
74         int *data_element3i;
75         unsigned short *data_element3s;
76         float *data_vertex3f;
77         float *data_texcoord2f;
78         float *data_color4f;
79 }
80 drawqueuemesh_t;
81
82 enum drawqueue_drawflag_e {
83 DRAWFLAG_NORMAL,
84 DRAWFLAG_ADDITIVE,
85 DRAWFLAG_MODULATE,
86 DRAWFLAG_2XMODULATE,
87 DRAWFLAG_SCREEN,
88 DRAWFLAG_NUMFLAGS,
89 DRAWFLAG_MASK = 0xFF,   // ONLY R_BeginPolygon()
90 DRAWFLAG_MIPMAP = 0x100 // ONLY R_BeginPolygon()
91 };
92
93 #define MAX_FONT_SIZES 8
94 #define MAX_FONT_FALLBACKS 3
95 typedef struct dp_font_s
96 {
97         rtexture_t *tex;
98         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)
99         float maxwidth; // precalculated max width of the font (includes scale)
100         float scale; // scales the font (without changing line height!)
101         char texpath[MAX_QPATH];
102         char title[MAX_QPATH];
103
104         int req_face; // requested face index, usually 0
105         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
106         char fallbacks[MAX_FONT_FALLBACKS][MAX_QPATH];
107         int fallback_faces[MAX_FONT_FALLBACKS];
108         struct ft2_font_s *ft2;
109 }
110 dp_font_t;
111
112 #define MAX_FONTS 16
113 extern dp_font_t dp_fonts[MAX_FONTS];
114 #define FONT_DEFAULT     (&dp_fonts[0]) // should be fixed width
115 #define FONT_CONSOLE     (&dp_fonts[1]) // REALLY should be fixed width (ls!)
116 #define FONT_SBAR        (&dp_fonts[2]) // must be fixed width
117 #define FONT_NOTIFY      (&dp_fonts[3]) // free
118 #define FONT_CHAT        (&dp_fonts[4]) // free
119 #define FONT_CENTERPRINT (&dp_fonts[5]) // free
120 #define FONT_INFOBAR     (&dp_fonts[6]) // free
121 #define FONT_MENU        (&dp_fonts[7]) // should be fixed width
122 #define FONT_USER        (&dp_fonts[8]) // userdefined fonts
123 #define MAX_USERFONTS (MAX_FONTS - (FONT_USER - dp_fonts))
124
125 // shared color tag printing constants
126 #define STRING_COLOR_TAG                        '^'
127 #define STRING_COLOR_DEFAULT            7
128 #define STRING_COLOR_DEFAULT_STR        "^7"
129 #define STRING_COLOR_RGB_TAG_CHAR       'x'
130 #define STRING_COLOR_RGB_TAG            "^x"
131
132 // 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)
133
134 // draw an image (or a filled rectangle if pic == NULL)
135 void DrawQ_Pic(float x, float y, cachepic_t *pic, float width, float height, float red, float green, float blue, float alpha, int flags);
136 // draw a rotated image
137 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);
138 // draw a filled rectangle (slightly faster than DrawQ_Pic with pic = NULL)
139 void DrawQ_Fill(float x, float y, float width, float height, float red, float green, float blue, float alpha, int flags);
140 // draw a text string,
141 // with optional color tag support,
142 // returns final unclipped x coordinate
143 // 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)
144 // the color is tinted by the provided base color
145 // 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)
146 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);
147 float DrawQ_String_Font(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);
148 float DrawQ_String_Font_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);
149 // you are STRONGLY DISCOURAGED to use a version without the _Size suffix!!!
150 /* don't use: */float DrawQ_TextWidth_Font(const char *text, size_t maxlen, qboolean ignorecolorcodes, const dp_font_t *fnt);
151 /* use this:  */float DrawQ_TextWidth_Font_Size(const char *text, float w, float h, size_t maxlen, qboolean ignorecolorcodes, const dp_font_t *fnt);
152 /* don't use: */float DrawQ_TextWidth_Font_UntilWidth(const char *text, size_t *maxlen, qboolean ignorecolorcodes, const dp_font_t *fnt, float maxWidth);
153 /* use this:  */float DrawQ_TextWidth_Font_UntilWidth_Size(const char *text, float w, float h, size_t *maxlen, qboolean ignorecolorcodes, const dp_font_t *fnt, float maxWidth);
154 /* don't use: */float DrawQ_TextWidth_Font_UntilWidth_TrackColors(const char *text, size_t *maxlen, int *outcolor, qboolean ignorecolorcodes, const dp_font_t *fnt, float maxwidth);
155 /* use this:  */float DrawQ_TextWidth_Font_UntilWidth_TrackColors_Size(const char *text, float w, float h, size_t *maxlen, int *outcolor, qboolean ignorecolorcodes, const dp_font_t *fnt, float maxwidth);
156 /* use this:  */float DrawQ_TextWidth_Font_UntilWidth_TrackColors_Size_Scale(const char *text, float w, float h, float sw, float sh, size_t *maxlen, int *outcolor, qboolean ignorecolorcodes, const dp_font_t *fnt, float maxwidth);
157 // draw a very fancy pic (per corner texcoord/color control), the order is tl, tr, bl, br
158 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);
159 // draw a triangle mesh
160 void DrawQ_Mesh(drawqueuemesh_t *mesh, int flags);
161 // set the clipping area
162 void DrawQ_SetClipArea(float x, float y, float width, float height);
163 // reset the clipping area
164 void DrawQ_ResetClipArea(void);
165 // draw a line
166 void DrawQ_Line(float width, float x1, float y1, float x2, float y2, float r, float g, float b, float alpha, int flags);
167 // draw a line loop
168 void DrawQ_LineLoop(drawqueuemesh_t *mesh, int flags);
169 // resets r_refdef.draw2dstage
170 void DrawQ_Finish(void);
171
172 void R_DrawGamma(void);
173
174 #endif
175