ft2.h

   1 /* Header for FreeType 2 and UTF-8 encoding support for
   2  * DarkPlaces
   3  */
   4
   5 #ifndef DP_FREETYPE2_H__
   6 #define DP_FREETYPE2_H__
   7
   8 //#include <sys/types.h>
   9
  10 #include "utf8lib.h"
  11
  12 /*
  13  * From http://www.unicode.org/Public/UNIDATA/Blocks.txt
  14  *
  15  *   E000..F8FF; Private Use Area
  16  *   F0000..FFFFF; Supplementary Private Use Area-A
  17  *
  18  * We use:
  19  *   Range E000 - E0FF
  20  *     Contains the non-FreeType2 version of characters.
  21  */
  22
  23 typedef struct ft2_font_map_s ft2_font_map_t;
  24 typedef struct ft2_attachment_s ft2_attachment_t;
  25 #define ft2_oldstyle_map ((ft2_font_map_t*)-1)
  26
  27 typedef float ft2_kernvec[2];
  28 typedef struct ft2_kerning_s
  29 {
  30         ft2_kernvec kerning[256][256]; /* kerning[left char][right char] */
  31 } ft2_kerning_t;
  32
  33 typedef struct ft2_font_s
  34 {
  35         char            name[64];
  36         qboolean        has_kerning;
  37         // last requested size loaded using Font_SetSize
  38         float           currentw;
  39         float           currenth;
  40         float           ascend;
  41         float           descend;
  42         qboolean        image_font; // only fallbacks are freetype fonts
  43
  44         // TODO: clean this up and do not expose everything.
  45
  46         unsigned char  *data; // TODO: See if FT2 actually needs it to stay... probably does
  47         //fs_offset_t     datasize;
  48         void           *face;
  49
  50         // an unordered array of ordered linked lists of glyph maps for a specific size
  51         ft2_font_map_t *font_maps[MAX_FONT_SIZES];
  52         int             num_sizes;
  53
  54         // attachments
  55         size_t            attachmentcount;
  56         ft2_attachment_t *attachments;
  57
  58         ft2_settings_t *settings;
  59
  60         // fallback mechanism
  61         struct ft2_font_s *next;
  62 } ft2_font_t;
  63
  64 void            Font_CloseLibrary(void);
  65 void            Font_Init(void);
  66 qboolean        Font_OpenLibrary(void);
  67 ft2_font_t*     Font_Alloc(void);
  68 void            Font_UnloadFont(ft2_font_t *font);
  69 // IndexForSize suggests to change the width and height if a font size is in a reasonable range
  70 // for example, you render at a size of 12.4, and a font of size 12 has been loaded
  71 // in such a case, *outw and *outh are set to 12, which is often a good alternative size
  72 int             Font_IndexForSize(ft2_font_t *font, float size, float *outw, float *outh);
  73 ft2_font_map_t *Font_MapForIndex(ft2_font_t *font, int index);
  74 qboolean        Font_LoadFont(const char *name, dp_font_t *dpfnt);
  75 qboolean        Font_GetKerningForSize(ft2_font_t *font, float w, float h, Uchar left, Uchar right, float *outx, float *outy);
  76 qboolean        Font_GetKerningForMap(ft2_font_t *font, int map_index, float w, float h, Uchar left, Uchar right, float *outx, float *outy);
  77 float           Font_VirtualToRealSize(float sz);
  78 float           Font_SnapTo(float val, float snapwidth);
  79 // since this is used on a font_map_t, let's name it FontMap_*
  80 ft2_font_map_t *FontMap_FindForChar(ft2_font_map_t *start, Uchar ch);
  81 #endif // DP_FREETYPE2_H__