Cleanup: naming and const parameter.
[blender-staging.git] / source / blender / blenkernel / BKE_icons.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2006-2007 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef __BKE_ICONS_H__
29 #define __BKE_ICONS_H__
30
31 /** \file BKE_icons.h
32  *  \ingroup bke
33  *
34  * Resizable Icons for Blender
35  */
36
37 typedef void (*DrawInfoFreeFP)(void *drawinfo);
38
39 struct Icon {
40         void *drawinfo;
41         void *obj;
42         short type;
43         DrawInfoFreeFP drawinfo_free;
44 };
45
46 typedef struct Icon Icon;
47
48 struct PreviewImage;
49 struct ID;
50
51 enum eIconSizes;
52
53 void BKE_icons_init(int first_dyn_id);
54
55 /* return icon id for library object or create new icon if not found */
56 int BKE_icon_id_ensure(struct ID *id);
57
58 int BKE_icon_preview_ensure(struct ID *id, struct PreviewImage *preview);
59
60 /* retrieve icon for id */
61 struct Icon *BKE_icon_get(const int icon_id);
62
63 /* set icon for id if not already defined */
64 /* used for inserting the internal icons */
65 void BKE_icon_set(const int icon_id, struct Icon *icon);
66
67 /* remove icon and free data if library object becomes invalid */
68 void BKE_icon_id_delete(struct ID *id);
69
70 void BKE_icon_delete(const int icon_id);
71
72 /* report changes - icon needs to be recalculated */
73 void BKE_icon_changed(const int icon_id);
74
75 /* free all icons */
76 void BKE_icons_free(void);
77
78 /* free the preview image for use in list */
79 void BKE_previewimg_freefunc(void *link);
80
81 /* free the preview image */
82 void BKE_previewimg_free(struct PreviewImage **prv);
83
84 /* clear the preview image or icon, but does not free it */
85 void BKE_previewimg_clear(struct PreviewImage *prv);
86
87 /* clear the preview image or icon at a specific size */
88 void BKE_previewimg_clear_single(struct PreviewImage *prv, enum eIconSizes size);
89
90 /* get the preview from any pointer */
91 struct PreviewImage **BKE_previewimg_id_get_p(const struct ID *id);
92
93 /* free the preview image belonging to the id */
94 void BKE_previewimg_id_free(struct ID *id);
95
96 /* create a new preview image */
97 struct PreviewImage *BKE_previewimg_create(void);
98
99 /* create a copy of the preview image */
100 struct PreviewImage *BKE_previewimg_copy(const struct PreviewImage *prv);
101
102 void BKE_previewimg_id_copy(struct ID *new_id, const struct ID *old_id);
103
104 /* retrieve existing or create new preview image */
105 struct PreviewImage *BKE_previewimg_id_ensure(struct ID *id);
106
107 void BKE_previewimg_ensure(struct PreviewImage *prv, const int size);
108
109 struct PreviewImage *BKE_previewimg_cached_get(const char *name);
110
111 struct PreviewImage *BKE_previewimg_cached_ensure(const char *name);
112
113 struct PreviewImage *BKE_previewimg_cached_thumbnail_read(
114         const char *name, const char *path, const int source, bool force_update);
115
116 void BKE_previewimg_cached_release(const char *name);
117 void BKE_previewimg_cached_release_pointer(struct PreviewImage *prv);
118
119 #define ICON_RENDER_DEFAULT_HEIGHT 32
120
121 #endif /*  __BKE_ICONS_H__ */