Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / draw / intern / draw_manager_text.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * Copyright 2016, Blender Foundation.
17  */
18
19 /** \file \ingroup draw
20  */
21
22 #ifndef __DRAW_MANAGER_TEXT_H__
23 #define __DRAW_MANAGER_TEXT_H__
24
25 struct DRWTextStore;
26
27 struct DRWTextStore *DRW_text_cache_create(void);
28 void DRW_text_cache_destroy(struct DRWTextStore *dt);
29
30 void DRW_text_cache_add(
31         struct DRWTextStore *dt,
32         const float co[3],
33         const char *str, const int str_len,
34         short xoffs, short yoffs, short flag,
35         const uchar col[4]);
36
37 void DRW_text_cache_draw(struct DRWTextStore *dt, struct ARegion *ar);
38
39 enum {
40         DRW_TEXT_CACHE_ASCII        = (1 << 0),
41         DRW_TEXT_CACHE_GLOBALSPACE  = (1 << 1),
42         DRW_TEXT_CACHE_LOCALCLIP    = (1 << 2),
43         /* reference the string by pointer */
44         DRW_TEXT_CACHE_STRING_PTR   = (1 << 3),
45 };
46
47 /* draw_manager.c */
48 struct DRWTextStore *DRW_text_cache_ensure(void);
49
50 #endif /* __DRAW_MANAGER_TEXT_H__ */