doxygen: editor entry
[blender.git] / source / blender / blenlib / BLI_vfontdata.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * 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 Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef BLI_VFONTDATA_H
31 #define BLI_VFONTDATA_H
32
33 /** \file BLI_vfontdata.h
34  *  \ingroup bli
35  *  \brief A structure to represent vector fonts, 
36  *   and to load them from PostScript fonts.
37  */
38
39 #include "DNA_listBase.h"
40
41 struct PackedFile;
42 struct VFont;
43
44 #define MAX_VF_CHARS 256
45
46 typedef struct VFontData {
47         ListBase characters;
48         // ListBase nurbsbase[MAX_VF_CHARS];
49         // float            resol[MAX_VF_CHARS];
50         // float            width[MAX_VF_CHARS];
51         // float            *points[MAX_VF_CHARS];
52          char           name[128];      
53 } VFontData;
54
55 typedef struct VChar {
56         struct VChar    *next, *prev;
57          ListBase        nurbsbase;
58         intptr_t   index;
59         float           resol;
60         float           width;
61         float           *points;
62 } VChar;
63
64 struct TmpFont
65 {
66         struct TmpFont *next, *prev;
67         struct PackedFile *pf;
68         struct VFont *vfont;
69 };
70
71 /**
72  * Construct a new VFontData structure from 
73  * Freetype font data in a PackedFile.
74  * 
75  * @param pf The font data.
76  * @retval A new VFontData structure, or NULL
77  * if unable to load.
78  */
79         VFontData*
80 BLI_vfontdata_from_freetypefont(
81         struct PackedFile *pf);
82
83         int
84 BLI_vfontchar_from_freetypefont(
85         struct VFont *vfont, unsigned long character);
86
87 #endif
88