SVN maintenance.
[blender.git] / source / blender / imbuf / IMB_thumbs.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) 2007 Blender Foundation
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): Andrea Weikert.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef _IMB_THUMBS_H
31 #define _IMB_THUMBS_H
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 struct ImBuf;
38
39 /** Thumbnail creation and retrieval according to the 'Thumbnail Management Standard'
40  * supported by Gimp, Gnome (Nautilus), KDE etc.
41  * Reference: http://jens.triq.net/thumbnail-spec/index.html
42  */
43
44
45 typedef enum ThumbSize {
46         THB_NORMAL,
47         THB_LARGE,
48         THB_FAIL
49 } ThumbSize;
50
51 typedef enum ThumbSource {
52         THB_SOURCE_IMAGE,
53         THB_SOURCE_MOVIE,
54         THB_SOURCE_BLEND
55 } ThumbSource;
56
57 // IB_metadata
58
59 /* create thumbnail for file and returns new imbuf for thumbnail */
60 ImBuf* IMB_thumb_create(const char* path, ThumbSize size, ThumbSource source, ImBuf *ibuf);
61
62 /* read thumbnail for file and returns new imbuf for thumbnail */
63 ImBuf* IMB_thumb_read(const char* path, ThumbSize size);
64
65 /* delete all thumbs for the file */
66 void IMB_thumb_delete(const char* path, ThumbSize size);
67
68 /* return the state of the thumb, needed to determine how to manage the thumb */
69 ImBuf* IMB_thumb_manage(const char* path, ThumbSize size, ThumbSource source);
70
71 /* create the necessary dirs to store the thumbnails */
72 void IMB_thumb_makedirs();
73
74 /* special function for loading a thumbnail embedded into a blend file */
75 ImBuf *IMB_loadblend_thumb(const char *path);
76 void IMB_overlayblend_thumb(unsigned int *thumb, int width, int height, float aspect);
77
78
79 #endif /* _IMB_THUMBS_H */
80