Merge branch 'master' into blender2.8
[blender.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 enum {
40         /** ID preview: obj is #ID. */
41         ICON_DATA_ID = 0,
42         /** Preview: obj is #PreviewImage */
43         ICON_DATA_PREVIEW,
44         /** 2D triangles: obj is #Icon_Geom */
45         ICON_DATA_GEOM,
46 };
47
48 struct Icon {
49         void *drawinfo;
50         /**
51          * Data defined by #obj_type
52          * \note for #ICON_DATA_GEOM the memory is owned by the icon,
53          * could be made into a flag if we want that to be optional.
54          */
55         void *obj;
56         char  obj_type;
57         /** Internal use only. */
58         char flag;
59         /** #ID_Type or 0 when not used for ID preview. */
60         short id_type;
61         DrawInfoFreeFP drawinfo_free;
62 };
63
64 /** Used for #ICON_DATA_GEOM, assigned to #Icon.obj. */
65 struct Icon_Geom {
66         int icon_id;
67         int coords_len;
68         int coords_range[2];
69         const unsigned char (*coords)[2];
70         const unsigned char (*colors)[4];
71         /* when not NULL, the memory of coords and colors is a sub-region of this pointer. */
72         const void *mem;
73 };
74
75 typedef struct Icon Icon;
76
77 struct ImBuf;
78 struct PreviewImage;
79 struct ID;
80
81 enum eIconSizes;
82
83 void BKE_icons_init(int first_dyn_id);
84
85 /* return icon id for library object or create new icon if not found */
86 int BKE_icon_id_ensure(struct ID *id);
87
88 int BKE_icon_preview_ensure(struct ID *id, struct PreviewImage *preview);
89
90 /* retrieve icon for id */
91 struct Icon *BKE_icon_get(const int icon_id);
92
93 /* set icon for id if not already defined */
94 /* used for inserting the internal icons */
95 void BKE_icon_set(const int icon_id, struct Icon *icon);
96
97 /* remove icon and free data if library object becomes invalid */
98 void BKE_icon_id_delete(struct ID *id);
99
100 bool BKE_icon_delete(const int icon_id);
101 bool BKE_icon_delete_unmanaged(const int icon_id);
102
103 /* report changes - icon needs to be recalculated */
104 void BKE_icon_changed(const int icon_id);
105
106 /* free all icons */
107 void BKE_icons_free(void);
108
109 /* free all icons marked for deferred deletion */
110 void BKE_icons_deferred_free(void);
111
112 /* free the preview image for use in list */
113 void BKE_previewimg_freefunc(void *link);
114
115 /* free the preview image */
116 void BKE_previewimg_free(struct PreviewImage **prv);
117
118 /* clear the preview image or icon, but does not free it */
119 void BKE_previewimg_clear(struct PreviewImage *prv);
120
121 /* clear the preview image or icon at a specific size */
122 void BKE_previewimg_clear_single(struct PreviewImage *prv, enum eIconSizes size);
123
124 /* get the preview from any pointer */
125 struct PreviewImage **BKE_previewimg_id_get_p(const struct ID *id);
126
127 /* free the preview image belonging to the id */
128 void BKE_previewimg_id_free(struct ID *id);
129
130 /* create a new preview image */
131 struct PreviewImage *BKE_previewimg_create(void);
132
133 /* create a copy of the preview image */
134 struct PreviewImage *BKE_previewimg_copy(const struct PreviewImage *prv);
135
136 void BKE_previewimg_id_copy(struct ID *new_id, const struct ID *old_id);
137
138 /* retrieve existing or create new preview image */
139 struct PreviewImage *BKE_previewimg_id_ensure(struct ID *id);
140
141 void BKE_previewimg_ensure(struct PreviewImage *prv, const int size);
142
143 struct PreviewImage *BKE_previewimg_cached_get(const char *name);
144
145 struct PreviewImage *BKE_previewimg_cached_ensure(const char *name);
146
147 struct PreviewImage *BKE_previewimg_cached_thumbnail_read(
148         const char *name, const char *path, const int source, bool force_update);
149
150 void BKE_previewimg_cached_release(const char *name);
151 void BKE_previewimg_cached_release_pointer(struct PreviewImage *prv);
152
153 int BKE_icon_geom_ensure(struct Icon_Geom *geom);
154 struct Icon_Geom *BKE_icon_geom_from_memory(const uchar *data, size_t data_len);
155 struct Icon_Geom *BKE_icon_geom_from_file(const char *filename);
156
157 struct ImBuf *BKE_icon_geom_rasterize(
158         const struct Icon_Geom *geom,
159         const unsigned int size_x, const unsigned int size_y);
160
161 #define ICON_RENDER_DEFAULT_HEIGHT 32
162
163 #endif /*  __BKE_ICONS_H__ */