draw.h

   1 /*
   2 Copyright (C) 1996-1997 Id Software, Inc.
   3 Copyright (C) 2000-2021 DarkPlaces contributors
   4
   5 This program is free software; you can redistribute it and/or
   6 modify it under the terms of the GNU General Public License
   7 as published by the Free Software Foundation; either version 2
   8 of the License, or (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  13
  14 See the GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program; if not, write to the Free Software
  18 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  19
  20 */
  21
  22 // draw.h -- these are the only functions outside the refresh allowed
  23 // to touch the vid buffer
  24
  25 #ifndef DRAW_H
  26 #define DRAW_H
  27
  28 #include <stddef.h>
  29 #include "qtypes.h"
  30 #include "r_textures.h"
  31
  32 typedef struct cachepic_s cachepic_t;
  33
  34 typedef enum cachepicflags_e
  35 {
  36         CACHEPICFLAG_NOTPERSISTENT = 1,
  37         CACHEPICFLAG_QUIET = 2,
  38         CACHEPICFLAG_NOCOMPRESSION = 4,
  39         CACHEPICFLAG_NOCLAMP = 8,
  40         CACHEPICFLAG_NEWPIC = 16, // disables matching texflags check, because a pic created with Draw_NewPic should not be subject to that
  41         CACHEPICFLAG_MIPMAP = 32,
  42         CACHEPICFLAG_NEAREST = 64, // force nearest filtering instead of linear
  43         CACHEPICFLAG_LINEAR = 128, // force linear filtering even if nearest_2d is enabled
  44         CACHEPICFLAG_FAILONMISSING = 256 // return NULL if the pic has no texture
  45 }
  46 cachepicflags_t;
  47
  48 void Draw_Frame (void);
  49 cachepic_t *Draw_CachePic_Flags (const char *path, unsigned int cachepicflags);
  50 cachepic_t *Draw_CachePic (const char *path); // standard function with no options, used throughout engine
  51 // create or update a pic's image
  52 cachepic_t *Draw_NewPic(const char *picname, int width, int height, unsigned char *pixels, textype_t textype, int texflags);
  53 // free the texture memory used by a pic (the cachepic_t itself is eternal)
  54 void Draw_FreePic(const char *picname);
  55
  56 // a triangle mesh..
  57 // each vertex is 3 floats
  58 // each texcoord is 2 floats
  59 // each color is 4 floats
  60 typedef struct drawqueuemesh_s
  61 {
  62         rtexture_t *texture;
  63         int num_triangles;
  64         int num_vertices;
  65         int *data_element3i;
  66         unsigned short *data_element3s;
  67         float *data_vertex3f;
  68         float *data_texcoord2f;
  69         float *data_color4f;
  70 }
  71 drawqueuemesh_t;
  72
  73 enum drawqueue_drawflag_e {
  74 DRAWFLAG_NORMAL,
  75 DRAWFLAG_ADDITIVE,
  76 DRAWFLAG_MODULATE,
  77 DRAWFLAG_2XMODULATE,
  78 DRAWFLAG_SCREEN,
  79 DRAWFLAG_NUMFLAGS,
  80 DRAWFLAG_MASK = 0xFF,   // ONLY R_BeginPolygon()
  81 DRAWFLAG_MIPMAP = 0x100, // ONLY R_BeginPolygon()
  82 DRAWFLAG_NOGAMMA = 0x200 // ONLY R_DrawQSuperPic()
  83 };
  84 #define DRAWFLAGS_BLEND 0xFF /* this matches all blending flags */
  85
  86 typedef struct ft2_settings_s
  87 {
  88         float scale, voffset;
  89         // cvar parameters (only read on loadfont command)
  90         int antialias, hinting;
  91         float outline, blur, shadowx, shadowy, shadowz;
  92 } ft2_settings_t;
  93
  94 #define MAX_FONT_SIZES 16
  95 #define MAX_FONT_FALLBACKS 3
  96 typedef struct dp_font_s
  97 {
  98         cachepic_t *pic;
  99         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)
 100         float maxwidth; // precalculated max width of the font (includes scale)
 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         ft2_settings_t settings;
 111 }
 112 dp_font_t;
 113
 114 typedef struct dp_fonts_s
 115 {
 116         dp_font_t *f;
 117         int maxsize;
 118 }
 119 dp_fonts_t;
 120 extern dp_fonts_t dp_fonts;
 121
 122 #define MAX_FONTS         16 // fonts at the start
 123 #define FONTS_EXPAND       8  // fonts grow when no free slots
 124 #define FONT_DEFAULT     (&dp_fonts.f[0]) // should be fixed width
 125 #define FONT_CONSOLE     (&dp_fonts.f[1]) // REALLY should be fixed width (ls!)
 126 #define FONT_SBAR        (&dp_fonts.f[2]) // must be fixed width
 127 #define FONT_NOTIFY      (&dp_fonts.f[3]) // free
 128 #define FONT_CHAT        (&dp_fonts.f[4]) // free
 129 #define FONT_CENTERPRINT (&dp_fonts.f[5]) // free
 130 #define FONT_INFOBAR     (&dp_fonts.f[6]) // free
 131 #define FONT_MENU        (&dp_fonts.f[7]) // should be fixed width
 132 #define FONT_USER(i)     (&dp_fonts.f[8+i]) // userdefined fonts
 133 #define MAX_USERFONTS    (dp_fonts.maxsize - 8)
 134
 135 // shared color tag printing constants
 136 #define STRING_COLOR_TAG                        '^'
 137 #define STRING_COLOR_DEFAULT            7
 138 #define STRING_COLOR_DEFAULT_STR        "^7"
 139 #define STRING_COLOR_RGB_TAG_CHAR       'x'
 140 #define STRING_COLOR_RGB_TAG            "^x"
 141
 142 // prepare for 2D rendering (sets r_refdef.draw2dstage = 1 and calls R_ResetViewRendering2D)
 143 void DrawQ_Start(void);
 144 // resets r_refdef.draw2dstage to 0
 145 void DrawQ_Finish(void);
 146 // batch draw the pending geometry in the CL_Mesh_UI() model and reset the model,
 147 // to be called by things like DrawQ_SetClipArea which make disruptive state changes.
 148 void DrawQ_FlushUI(void);
 149 // use this when changing r_refdef.view.* from e.g. csqc
 150 void DrawQ_RecalcView(void);
 151
 152 // draw an image (or a filled rectangle if pic == NULL)
 153 void DrawQ_Pic(float x, float y, cachepic_t *pic, float width, float height, float red, float green, float blue, float alpha, int flags);
 154 // draw a rotated image
 155 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);
 156 // draw a filled rectangle (slightly faster than DrawQ_Pic with pic = NULL)
 157 void DrawQ_Fill(float x, float y, float width, float height, float red, float green, float blue, float alpha, int flags);
 158 // draw a text string,
 159 // with optional color tag support,
 160 // returns final unclipped x coordinate
 161 // 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)
 162 // the color is tinted by the provided base color
 163 // 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)
 164 extern float DrawQ_Color[4];
 165 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, qbool ignorecolorcodes, const dp_font_t *fnt);
 166 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, qbool ignorecolorcodes, const dp_font_t *fnt);
 167 float DrawQ_TextWidth(const char *text, size_t maxlen, float w, float h, qbool ignorecolorcodes, const dp_font_t *fnt);
 168 float DrawQ_TextWidth_UntilWidth(const char *text, size_t *maxlen, float w, float h, qbool ignorecolorcodes, const dp_font_t *fnt, float maxWidth);
 169 float DrawQ_TextWidth_UntilWidth_TrackColors(const char *text, size_t *maxlen, float w, float h, int *outcolor, qbool ignorecolorcodes, const dp_font_t *fnt, float maxwidth);
 170 float DrawQ_TextWidth_UntilWidth_TrackColors_Scale(const char *text, size_t *maxlen, float w, float h, float sw, float sh, int *outcolor, qbool ignorecolorcodes, const dp_font_t *fnt, float maxwidth);
 171 // draw a very fancy pic (per corner texcoord/color control), the order is tl, tr, bl, br
 172 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);
 173 // set the clipping area
 174 void DrawQ_SetClipArea(float x, float y, float width, float height);
 175 // reset the clipping area
 176 void DrawQ_ResetClipArea(void);
 177 // draw a line
 178 void DrawQ_Line(float width, float x1, float y1, float x2, float y2, float r, float g, float b, float alpha, int flags);
 179
 180 const char *Draw_GetPicName(cachepic_t *pic);
 181 int Draw_GetPicWidth(cachepic_t *pic);
 182 int Draw_GetPicHeight(cachepic_t *pic);
 183 qbool Draw_IsPicLoaded(cachepic_t *pic);
 184 rtexture_t *Draw_GetPicTexture(cachepic_t *pic);
 185
 186 extern rtexturepool_t *drawtexturepool; // used by ft2.c
 187
 188 #endif
 189