Blender V4.3
Classes | Namespaces | Functions
BKE_preview_image.hh File Reference
#include <array>
#include <memory>
#include <optional>
#include "BLI_sys_types.h"
#include "DNA_ID_enums.h"

Go to the source code of this file.

Classes

struct  blender::bke::PreviewImageRuntime
 

Namespaces

namespace  blender
 
namespace  blender::bke
 

Functions

void BKE_preview_images_init ()
 
void BKE_preview_images_free ()
 
void BKE_previewimg_freefunc (void *link)
 
void BKE_previewimg_free (PreviewImage **prv)
 
void BKE_previewimg_clear (PreviewImage *prv)
 
void BKE_previewimg_clear_single (PreviewImage *prv, enum eIconSizes size)
 
PreviewImage ** BKE_previewimg_id_get_p (const ID *id)
 
PreviewImage * BKE_previewimg_id_get (const ID *id)
 
bool BKE_previewimg_id_supports_jobs (const ID *id)
 
void BKE_previewimg_id_custom_set (ID *id, const char *filepath)
 
void BKE_previewimg_id_free (ID *id)
 
PreviewImage * BKE_previewimg_create ()
 
PreviewImage * BKE_previewimg_copy (const PreviewImage *prv)
 
void BKE_previewimg_id_copy (ID *new_id, const ID *old_id)
 
PreviewImage * BKE_previewimg_id_ensure (ID *id)
 
void BKE_previewimg_ensure (PreviewImage *prv, int size)
 
const char * BKE_previewimg_deferred_filepath_get (const PreviewImage *prv)
 
std::optional< int > BKE_previewimg_deferred_thumb_source_get (const PreviewImage *prv)
 
ImBuf * BKE_previewimg_to_imbuf (PreviewImage *prv, int size)
 
void BKE_previewimg_finish (PreviewImage *prv, int size)
 
bool BKE_previewimg_is_finished (const PreviewImage *prv, int size)
 
PreviewImage * BKE_previewimg_cached_get (const char *name)
 
PreviewImage * BKE_previewimg_cached_ensure (const char *name)
 
PreviewImage * BKE_previewimg_cached_thumbnail_read (const char *name, const char *filepath, int source, bool force_update)
 
void BKE_previewimg_cached_release (const char *name)
 
void BKE_previewimg_deferred_release (PreviewImage *prv)
 
void BKE_previewimg_blend_write (BlendWriter *writer, const PreviewImage *prv)
 
void BKE_previewimg_blend_read (BlendDataReader *reader, PreviewImage *prv)
 

Function Documentation

◆ BKE_preview_images_free()

void BKE_preview_images_free ( )

Definition at line 114 of file preview_image.cc.

References BKE_previewimg_freefunc(), BLI_ghash_free(), gCachedPreviews, and MEM_freeN().

Referenced by UI_icons_free().

◆ BKE_preview_images_init()

void BKE_preview_images_init ( )

Definition at line 107 of file preview_image.cc.

References BLI_ghash_str_new(), and gCachedPreviews.

Referenced by WM_init().

◆ BKE_previewimg_blend_read()

void BKE_previewimg_blend_read ( BlendDataReader * reader,
PreviewImage * prv )

Definition at line 486 of file preview_image.cc.

References BLO_read_data_is_undo(), BLO_read_uint32_array(), PreviewImage::flag, PreviewImage::h, NUM_ICON_SIZES, PreviewImage::rect, PreviewImage::runtime, and PreviewImage::w.

Referenced by blender::bke::action_blend_read_data(), BKE_collection_blend_read_data(), BKE_screen_blend_read_data(), brush_blend_read_data(), image_blend_read_data(), light_blend_read_data(), material_blend_read_data(), blender::bke::node_tree_blend_read_data(), object_blend_read_data(), scene_blend_read_data(), texture_blend_read_data(), and world_blend_read_data().

◆ BKE_previewimg_blend_write()

void BKE_previewimg_blend_write ( BlendWriter * writer,
const PreviewImage * prv )

Definition at line 465 of file preview_image.cc.

References BLO_write_struct_at_address, BLO_write_uint32_array(), PreviewImage::h, PreviewImage::rect, PreviewImage::runtime, and PreviewImage::w.

Referenced by blender::bke::action_blend_write(), BKE_collection_blend_write_nolib(), brush_blend_write(), image_blend_write(), light_blend_write(), material_blend_write(), blender::bke::node_tree_blend_write(), object_blend_write(), scene_blend_write(), screen_blend_write(), texture_blend_write(), and world_blend_write().

◆ BKE_previewimg_cached_ensure()

PreviewImage * BKE_previewimg_cached_ensure ( const char * name)

Generate an empty PreviewImage, if not yet existing.

Definition at line 291 of file preview_image.cc.

References BKE_previewimg_create(), BLI_assert, BLI_ghash_ensure_p_ex(), BLI_strdup(), BLI_thread_is_main(), and gCachedPreviews.

Referenced by bpy_utils_previews_new().

◆ BKE_previewimg_cached_get()

PreviewImage * BKE_previewimg_cached_get ( const char * name)

Definition at line 285 of file preview_image.cc.

References BLI_assert, BLI_ghash_lookup(), BLI_thread_is_main(), and gCachedPreviews.

◆ BKE_previewimg_cached_release()

void BKE_previewimg_cached_release ( const char * name)

Definition at line 356 of file preview_image.cc.

References BKE_previewimg_deferred_release(), BLI_assert, BLI_ghash_popkey(), BLI_thread_is_main(), gCachedPreviews, and MEM_freeN().

Referenced by bpy_utils_previews_release().

◆ BKE_previewimg_cached_thumbnail_read()

PreviewImage * BKE_previewimg_cached_thumbnail_read ( const char * name,
const char * filepath,
int source,
bool force_update )

Generate a PreviewImage from given filepath, using thumbnails management, if not yet existing. Does not actually generate the preview, BKE_previewimg_ensure() must be called for that.

Definition at line 308 of file preview_image.cc.

References BKE_previewimg_clear(), BKE_previewimg_free(), BLI_assert, BLI_ghash_insert(), BLI_ghash_lookup_p(), BLI_strdup(), BLI_thread_is_main(), gCachedPreviews, previewimg_deferred_create(), and PreviewImage::runtime.

Referenced by bpy_utils_previews_load().

◆ BKE_previewimg_clear()

void BKE_previewimg_clear ( PreviewImage * prv)

Clear the preview image or icon, but does not free it.

Definition at line 143 of file preview_image.cc.

References BKE_previewimg_clear_single(), and NUM_ICON_SIZES.

Referenced by BKE_previewimg_cached_thumbnail_read(), blender::ed::asset::generate_preview(), lib_id_generate_preview_exec(), and previews_clear_exec().

◆ BKE_previewimg_clear_single()

void BKE_previewimg_clear_single ( PreviewImage * prv,
enum eIconSizes size )

Clear the preview image or icon at a specific size.

Definition at line 131 of file preview_image.cc.

References PreviewImage::changed_timestamp, PreviewImage::flag, GPU_texture_free(), PreviewImage::h, MEM_SAFE_FREE, PRV_CHANGED, PreviewImage::rect, PreviewImage::runtime, size(), and PreviewImage::w.

Referenced by BKE_previewimg_clear(), and ED_preview_restart_queue_work().

◆ BKE_previewimg_copy()

PreviewImage * BKE_previewimg_copy ( const PreviewImage * prv)

Create a copy of the preview image.

Definition at line 150 of file preview_image.cc.

References MEM_dupallocN, MEM_mallocN, NUM_ICON_SIZES, PreviewImage::rect, and PreviewImage::runtime.

Referenced by BKE_previewimg_id_copy(), and UI_icon_to_preview().

◆ BKE_previewimg_create()

PreviewImage * BKE_previewimg_create ( )

Create a new preview image.

Definition at line 76 of file preview_image.cc.

References PreviewImage::changed_timestamp, PreviewImage::flag, MEM_callocN, NUM_ICON_SIZES, PRV_CHANGED, and PreviewImage::runtime.

Referenced by BKE_previewimg_cached_ensure(), BKE_previewimg_id_ensure(), previewimg_deferred_create(), and UI_icon_to_preview().

◆ BKE_previewimg_deferred_filepath_get()

const char * BKE_previewimg_deferred_filepath_get ( const PreviewImage * prv)

Definition at line 419 of file preview_image.cc.

References PreviewImage::runtime.

◆ BKE_previewimg_deferred_release()

void BKE_previewimg_deferred_release ( PreviewImage * prv)

Definition at line 268 of file preview_image.cc.

References BKE_icon_delete(), BKE_previewimg_free(), PRV_TAG_DEFFERED_DELETE, PRV_TAG_DEFFERED_RENDERING, and PreviewImage::runtime.

Referenced by BKE_previewimg_cached_release(), BKE_previewimg_id_custom_set(), and icon_preview_endjob().

◆ BKE_previewimg_deferred_thumb_source_get()

std::optional< int > BKE_previewimg_deferred_thumb_source_get ( const PreviewImage * prv)

Definition at line 428 of file preview_image.cc.

References PreviewImage::runtime.

◆ BKE_previewimg_ensure()

void BKE_previewimg_ensure ( PreviewImage * prv,
int size )

Handle deferred (lazy) loading/generation of preview image, if needed. For now, only used with file thumbnails.

Definition at line 365 of file preview_image.cc.

References Box, ImBuf::byte_buffer, ImBufByteBuffer::data, blender::bke::PreviewDeferredLoadingData::filepath, PreviewImage::flag, PreviewImage::h, ICON_RENDER_DEFAULT_HEIGHT, ICON_SIZE_ICON, ICON_SIZE_PREVIEW, IMB_freeImBuf(), IMB_premultiply_alpha(), IMB_scale(), IMB_thumb_manage(), MEM_dupallocN, PRV_CHANGED, PRV_RENDERING, PRV_USER_EDITED, PreviewImage::rect, PreviewImage::runtime, blender::bke::PreviewDeferredLoadingData::source, THB_LARGE, PreviewImage::w, ImBuf::x, and ImBuf::y.

Referenced by BKE_previewimg_id_custom_set().

◆ BKE_previewimg_finish()

void BKE_previewimg_finish ( PreviewImage * prv,
int size )

Definition at line 454 of file preview_image.cc.

References atomic_fetch_and_and_int16(), PreviewImage::flag, and PRV_RENDERING.

Referenced by blo_blendhandle_read_preview_rects(), and icon_preview_endjob().

◆ BKE_previewimg_free()

void BKE_previewimg_free ( PreviewImage ** prv)

Free the preview image.

Definition at line 89 of file preview_image.cc.

References GPU_texture_free(), MEM_freeN(), and NUM_ICON_SIZES.

Referenced by blender::bke::action_free_data(), BKE_previewimg_cached_thumbnail_read(), BKE_previewimg_deferred_release(), BKE_previewimg_freefunc(), BKE_previewimg_id_free(), brush_free_data(), collection_free_data(), image_free_data(), light_free_data(), material_free_data(), blender::bke::ntree_free_data(), object_free_data(), scene_free_data(), screen_free_data(), texture_free_data(), and world_free_data().

◆ BKE_previewimg_freefunc()

void BKE_previewimg_freefunc ( void * link)

Free the preview image for use in list.

Definition at line 122 of file preview_image.cc.

References BKE_previewimg_free().

Referenced by BKE_preview_images_free(), and imb_thumb_load_from_blend_id().

◆ BKE_previewimg_id_copy()

void BKE_previewimg_id_copy ( ID * new_id,
const ID * old_id )

Duplicate preview image from id and clear icon_id, to be used by data-block copy functions.

Definition at line 170 of file preview_image.cc.

References BKE_previewimg_copy(), BKE_previewimg_id_get_p(), BLI_assert, ELEM, and ID::icon_id.

Referenced by blender::bke::action_copy_data(), brush_copy_data(), collection_copy_data(), image_copy_data(), light_copy_data(), material_copy_data(), blender::bke::ntree_copy_data(), object_copy_data(), scene_copy_data(), texture_copy_data(), and world_copy_data().

◆ BKE_previewimg_id_custom_set()

void BKE_previewimg_id_custom_set ( ID * id,
const char * filepath )

Trigger deferred loading of a custom image file into the preview buffer.

Definition at line 242 of file preview_image.cc.

References BKE_previewimg_deferred_release(), BKE_previewimg_ensure(), BKE_previewimg_id_get_p(), NUM_ICON_SIZES, previewimg_deferred_create(), PRV_USER_EDITED, and THB_SOURCE_IMAGE.

Referenced by blender::ed::sculpt_paint::brush_asset_load_preview_exec(), and lib_id_load_custom_preview_exec().

◆ BKE_previewimg_id_ensure()

PreviewImage * BKE_previewimg_id_ensure ( ID * id)

Retrieve existing or create new preview image.

Definition at line 229 of file preview_image.cc.

References BKE_previewimg_create(), and BKE_previewimg_id_get_p().

Referenced by BKE_icon_preview_ensure(), ED_preview_icon_render(), icon_draw_size(), lib_id_generate_preview_from_object_exec(), previews_clear_exec(), ui_icon_ensure_deferred(), UI_icon_render_id(), UI_icon_to_preview(), and ui_id_icon_render().

◆ BKE_previewimg_id_free()

void BKE_previewimg_id_free ( ID * id)

Free the preview image belonging to the id.

Definition at line 221 of file preview_image.cc.

References BKE_previewimg_free(), and BKE_previewimg_id_get_p().

Referenced by lib_id_generate_preview_from_object_exec().

◆ BKE_previewimg_id_get()

PreviewImage * BKE_previewimg_id_get ( const ID * id)

Definition at line 215 of file preview_image.cc.

References BKE_previewimg_id_get_p().

Referenced by BKE_asset_metadata_preview_get_from_id(), ED_preview_restart_queue_work(), blender::ed::asset::generate_preview(), lib_id_generate_preview_exec(), and memfile_undosys_unfinished_id_previews_restart().

◆ BKE_previewimg_id_get_p()

PreviewImage ** BKE_previewimg_id_get_p ( const ID * id)

Get the preview from any pointer.

Definition at line 187 of file preview_image.cc.

References GS, ID_AC, ID_BR, ID_GR, ID_IM, ID_LA, ID_MA, ID_NT, ID_OB, ID_PRV_CASE, ID_SCE, ID_SCR, ID_TE, and ID_WO.

Referenced by BKE_icon_changed(), BKE_icon_id_ensure(), BKE_previewimg_id_copy(), BKE_previewimg_id_custom_set(), BKE_previewimg_id_ensure(), BKE_previewimg_id_free(), BKE_previewimg_id_get(), ED_preview_id_is_supported(), and lib_id_preview_editing_poll().

◆ BKE_previewimg_id_supports_jobs()

bool BKE_previewimg_id_supports_jobs ( const ID * id)

Definition at line 263 of file preview_image.cc.

References ELEM, GS, ID_BR, ID_GR, ID_IM, ID_LA, ID_MA, ID_OB, ID_TE, and ID_WO.

Referenced by duplicate_ids(), ED_preview_shader_job(), and icon_set_image().

◆ BKE_previewimg_is_finished()

bool BKE_previewimg_is_finished ( const PreviewImage * prv,
int size )

Definition at line 460 of file preview_image.cc.

References PreviewImage::flag, and PRV_RENDERING.

Referenced by filelist_cache_previews_push(), filelist_file_create_entry(), icon_preview_startjob_all_sizes(), and memfile_undosys_unfinished_id_previews_restart().

◆ BKE_previewimg_to_imbuf()

ImBuf * BKE_previewimg_to_imbuf ( PreviewImage * prv,
int size )

Create an ImBuf holding a copy of the preview image buffer in prv.

Note
The returned image buffer has to be freed (IMB_freeImBuf()).

Definition at line 437 of file preview_image.cc.

References ImBuf::byte_buffer, ImBufByteBuffer::data, PreviewImage::h, IB_rect, IMB_allocImBuf(), PreviewImage::rect, size(), PreviewImage::w, and w().

Referenced by filelist_cache_previews_push(), filelist_file_create_entry(), and imb_thumb_load_from_blend_id().

Generated on Thu Feb 6 2025 07:36:39 for Blender by  doxygen 1.11.0