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