doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / blender / blenfont / intern / blf_internal.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) 2009 Blender Foundation.
21  * All rights reserved.
22  * 
23  * Contributor(s): Blender Foundation.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef BLF_INTERNAL_H
29 #define BLF_INTERNAL_H
30
31 struct FontBLF;
32 struct GlyphBLF;
33 struct GlyphCacheBLF;
34 struct rctf;
35
36 unsigned int blf_next_p2(unsigned int x);
37 unsigned int blf_hash(unsigned int val);
38 int blf_utf8_next(unsigned char *buf, int *iindex);
39
40 char *blf_dir_search(const char *file);
41 char *blf_dir_metrics_search(const char *filename);
42 int blf_dir_split(const char *str, char *file, int *size);
43
44 int blf_font_init(void);
45 void blf_font_exit(void);
46
47 struct FontBLF *blf_font_new(const char *name, const char *filename);
48 struct FontBLF *blf_font_new_from_mem(const char *name, unsigned char *mem, int mem_size);
49 void blf_font_attach_from_mem(struct FontBLF *font, const unsigned char *mem, int mem_size);
50
51 void blf_font_size(struct FontBLF *font, int size, int dpi);
52 void blf_font_draw(struct FontBLF *font, const char *str, unsigned int len);
53 void blf_font_draw_ascii(struct FontBLF *font, const char *str, unsigned int len);
54 void blf_font_buffer(struct FontBLF *font, const char *str);
55 void blf_font_boundbox(struct FontBLF *font, const char *str, struct rctf *box);
56 void blf_font_width_and_height(struct FontBLF *font, const char *str, float *width, float *height);
57 float blf_font_width(struct FontBLF *font, const char *str);
58 float blf_font_height(struct FontBLF *font, const char *str);
59 float blf_font_fixed_width(struct FontBLF *font);
60 void blf_font_free(struct FontBLF *font);
61
62 struct GlyphCacheBLF *blf_glyph_cache_find(struct FontBLF *font, int size, int dpi);
63 struct GlyphCacheBLF *blf_glyph_cache_new(struct FontBLF *font);
64 void blf_glyph_cache_clear(struct FontBLF *font);
65 void blf_glyph_cache_free(struct GlyphCacheBLF *gc);
66
67 struct GlyphBLF *blf_glyph_search(struct GlyphCacheBLF *gc, unsigned int c);
68 struct GlyphBLF *blf_glyph_add(struct FontBLF *font, unsigned int index, unsigned int c);
69
70 void blf_glyph_free(struct GlyphBLF *g);
71 int blf_glyph_render(struct FontBLF *font, struct GlyphBLF *g, float x, float y);
72
73 #endif /* BLF_INTERNAL_H */