1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
/*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* The Original Code is Copyright (C) 2007 Blender Foundation
* All rights reserved.
*/
/** \file
* \ingroup imbuf
*/
#pragma once
#ifdef __cplusplus
extern "C" {
#endif
struct ImBuf;
/**
* Thumbnail creation and retrieval according to the 'Thumbnail Management Standard'
* supported by Gimp, Gnome (Nautilus), KDE etc.
* Reference: http://jens.triq.net/thumbnail-spec/index.html
*/
typedef enum ThumbSize {
THB_NORMAL,
THB_LARGE,
THB_FAIL,
} ThumbSize;
typedef enum ThumbSource {
THB_SOURCE_IMAGE,
THB_SOURCE_MOVIE,
THB_SOURCE_BLEND,
THB_SOURCE_FONT,
} ThumbSource;
/**
* Don't generate thumbs for images bigger than this (100mb).
*/
#define THUMB_SIZE_MAX (100 * 1024 * 1024)
#define PREVIEW_RENDER_DEFAULT_HEIGHT 128
#define PREVIEW_RENDER_LARGE_HEIGHT 256
/**
* Note this can also be used as versioning system,
* to force refreshing all thumbnails if e.g. we change some thumb generating code or so.
* Only used by fonts so far.
*/
#define THUMB_DEFAULT_HASH "00000000000000000000000000000000"
/**
* Create thumbnail for file and returns new imbuf for thumbnail.
*/
struct ImBuf *IMB_thumb_create(const char *path,
ThumbSize size,
ThumbSource source,
struct ImBuf *img);
/**
* Read thumbnail for file and returns new imbuf for thumbnail.
*/
struct ImBuf *IMB_thumb_read(const char *path, ThumbSize size);
/**
* Delete all thumbs for the file.
*/
void IMB_thumb_delete(const char *path, ThumbSize size);
/**
* Create the thumb if necessary and manage failed and old thumbs.
*/
struct ImBuf *IMB_thumb_manage(const char *path, ThumbSize size, ThumbSource source);
/**
* Create the necessary dirs to store the thumbnails.
*/
void IMB_thumb_makedirs(void);
/**
* Special function for loading a thumbnail embedded into a blend file.
*/
struct ImBuf *IMB_thumb_load_blend(const char *blen_path,
const char *blen_group,
const char *blen_id);
/**
* Special function for previewing fonts.
*/
struct ImBuf *IMB_thumb_load_font(const char *filename, unsigned int x, unsigned int y);
bool IMB_thumb_load_font_get_hash(char *r_hash);
void IMB_thumb_clear_translations(void);
void IMB_thumb_ensure_translations(void);
/* Threading */
void IMB_thumb_locks_acquire(void);
void IMB_thumb_locks_release(void);
void IMB_thumb_path_lock(const char *path);
void IMB_thumb_path_unlock(const char *path);
#ifdef __cplusplus
}
#endif /* __cplusplus */
|
