doxygen: editor entry
[blender.git] / source / blender / editors / include / UI_interface_icons.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 /** \file UI_interface_icons.h
31  *  \ingroup editorui
32  */
33
34 #ifndef UI_INTERFACE_ICONS_H
35 #define UI_INTERFACE_ICONS_H
36
37 struct Image;
38 struct ImBuf;
39 struct World;
40 struct Tex;
41 struct Lamp;
42 struct Material;
43
44 typedef struct IconFile {
45         struct IconFile *next, *prev;
46         char filename[80];      // FILE_MAXFILE size
47         int index;
48 } IconFile;
49
50 #define ICON_DEFAULT_HEIGHT 16
51 #define ICON_DEFAULT_WIDTH      16
52 #define PREVIEW_DEFAULT_HEIGHT 96
53
54 /*
55  Resizable Icons for Blender
56 */
57 void UI_icons_init(int first_dyn_id);
58 int UI_icon_get_width(int icon_id);
59 int UI_icon_get_height(int icon_id);
60
61 void UI_icon_draw(float x, float y, int icon_id);
62 void UI_icon_draw_preview(float x, float y, int icon_id);
63 void UI_icon_draw_preview_aspect(float x, float y, int icon_id, float aspect);
64 void UI_icon_draw_preview_aspect_size(float x, float y, int icon_id, float aspect, int size);
65
66 void UI_icon_draw_aspect(float x, float y, int icon_id, float aspect, float alpha);
67 void UI_icon_draw_aspect_color(float x, float y, int icon_id, float aspect, float *rgb);
68 void UI_icon_draw_size(float x, float y, int size, int icon_id, float alpha);
69 void UI_icons_free(void);
70 void UI_icons_free_drawinfo(void *drawinfo);
71
72 struct ListBase *UI_iconfile_list(void);
73 int UI_iconfile_get_index(const char *filename);
74
75
76 #endif /*  UI_INTERFACE_ICONS_H */