Blender V5.3
BKE_preview_image.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2006-2007 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include <array>
12#include <memory>
13#include <optional>
14
15#include "DNA_ID_enums.h"
16
17namespace blender {
18
19struct BlendDataReader;
20struct BlendWriter;
21class StringRefNull;
22namespace gpu {
23class Texture;
24}
25struct ID;
26struct ImBuf;
27struct PreviewImage;
28
29enum ThumbSource : int8_t;
30
31namespace bke {
32
34
37 int icon_id = 0;
39
45 int user_count = 0;
46
47 std::array<gpu::Texture *, NUM_ICON_SIZES> gputexture = {};
48
50 std::unique_ptr<PreviewDeferredLoadingData> deferred_loading_data;
54};
55
56} // namespace bke
57
60
65
70
75
81
83
87void BKE_previewimg_id_custom_set(ID *id, const char *filepath);
88
93
98
103
108void BKE_previewimg_id_copy(ID *new_id, const ID *old_id);
109
114
119void BKE_previewimg_ensure(PreviewImage *prv, int size);
120
140std::optional<StringRefNull> BKE_previewimg_deferred_filepath_get(const PreviewImage *prv);
148std::optional<int> BKE_previewimg_deferred_thumb_source_get(const PreviewImage *prv);
149
154ImBuf *BKE_previewimg_to_imbuf(const PreviewImage *prv, int size);
155
156/*
157 * Preview rendering.
158 */
164
165void BKE_previewimg_render_start(PreviewImage *prv, int size, bool using_job);
166void BKE_previewimg_render_end(PreviewImage *prv, int size, PreviewImageRenderEndStatus status);
167bool BKE_previewimg_render_restart(PreviewImage *prv, int size);
168bool BKE_previewimg_is_rendering(const PreviewImage *prv, int size);
169bool BKE_previewimg_is_finished(const PreviewImage *prv, int size);
170
175bool BKE_previewimg_is_invalid(const PreviewImage *prv, int size);
176
177PreviewImage *BKE_previewimg_cached_get(const char *name);
178
182PreviewImage *BKE_previewimg_cached_ensure(const char *name);
183
184/* TODO rename this. */
193PreviewImage *BKE_previewimg_cached_thumbnail_read(const char *name,
194 const char *filepath,
195 int source,
196 bool force_update,
197 bool count_users = false);
198/* TODO rename this. */
210PreviewImage *BKE_previewimg_online_thumbnail_read(const char *name,
211 const char *dst_filepath,
212 bool force_update,
213 bool count_users = false);
214
215void BKE_previewimg_cached_release(const char *name);
216
217void BKE_previewimg_blend_write(BlendWriter *writer, const PreviewImage *prv);
218void BKE_previewimg_blend_read(BlendDataReader *reader, PreviewImage *prv);
219
220} // namespace blender
Enumerations for DNA_ID.h.
static DBVT_INLINE btScalar size(const btDbvtVolume &a)
Definition btDbvt.cpp:52
BMesh Iterators.
void BKE_previewimg_id_custom_set(ID *id, const char *filepath)
void BKE_previewimg_id_free(ID *id)
void BKE_preview_images_init()
PreviewImage * BKE_previewimg_cached_thumbnail_read(const char *name, const char *filepath, int source, bool force_update, bool count_users=false)
bool BKE_previewimg_render_restart(PreviewImage *prv, int size)
void BKE_previewimg_clear(PreviewImage *prv)
@ NUM_ICON_SIZES
void BKE_previewimg_blend_read(BlendDataReader *reader, PreviewImage *prv)
void BKE_previewimg_clear_single(PreviewImage *prv, enum eIconSizes size)
bool BKE_previewimg_is_online(const PreviewImage *prv)
void BKE_previewimg_render_end(PreviewImage *prv, int size, PreviewImageRenderEndStatus status)
std::optional< int > BKE_previewimg_deferred_thumb_source_get(const PreviewImage *prv)
void BKE_previewimg_blend_write(BlendWriter *writer, const PreviewImage *prv)
bool BKE_previewimg_is_invalid(const PreviewImage *prv, int size)
PreviewImage * BKE_previewimg_online_thumbnail_read(const char *name, const char *dst_filepath, bool force_update, bool count_users=false)
void BKE_preview_images_free()
PreviewImage * BKE_previewimg_cached_ensure(const char *name)
bool BKE_previewimg_id_supports_jobs(const ID *id)
void BKE_previewimg_render_start(PreviewImage *prv, int size, bool using_job)
PreviewImage ** BKE_previewimg_id_get_p(const ID *id)
@ PRV_RENDER_STATUS_CANCELLED
PreviewImage * BKE_previewimg_id_ensure(ID *id)
void BKE_previewimg_free(PreviewImage **prv)
PreviewImage * BKE_previewimg_id_get(const ID *id)
bool BKE_previewimg_is_finished(const PreviewImage *prv, int size)
PreviewImage * BKE_previewimg_create()
PreviewImage * BKE_previewimg_cached_get(const char *name)
void BKE_previewimg_id_copy(ID *new_id, const ID *old_id)
bool BKE_previewimg_is_rendering(const PreviewImage *prv, int size)
std::optional< StringRefNull > BKE_previewimg_deferred_filepath_get(const PreviewImage *prv)
PreviewImage * BKE_previewimg_copy(const PreviewImage *prv)
void BKE_previewimg_cached_release(const char *name)
ImBuf * BKE_previewimg_to_imbuf(const PreviewImage *prv, int size)
void BKE_previewimg_ensure(PreviewImage *prv, int size)
signed char int8_t
Definition BKE_text.h:76
signed short int16_t
Definition BKE_text.h:77
std::unique_ptr< PreviewDeferredLoadingData > deferred_loading_data
std::array< gpu::Texture *, NUM_ICON_SIZES > gputexture