Blender V4.5
BKE_preview_image.hh File Reference
#include <array>
#include <memory>
#include <optional>
#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)
PreviewImageBKE_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)
PreviewImageBKE_previewimg_create ()
PreviewImageBKE_previewimg_copy (const PreviewImage *prv)
void BKE_previewimg_id_copy (ID *new_id, const ID *old_id)
PreviewImageBKE_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)
ImBufBKE_previewimg_to_imbuf (const PreviewImage *prv, int size)
void BKE_previewimg_finish (PreviewImage *prv, int size)
bool BKE_previewimg_is_finished (const PreviewImage *prv, int size)
bool BKE_previewimg_is_invalid (const PreviewImage *prv)
PreviewImageBKE_previewimg_cached_get (const char *name)
PreviewImageBKE_previewimg_cached_ensure (const char *name)
PreviewImageBKE_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 ( )

◆ BKE_preview_images_init()

void BKE_preview_images_init ( )

◆ BKE_previewimg_blend_read()

◆ BKE_previewimg_blend_write()

◆ BKE_previewimg_cached_ensure()

PreviewImage * BKE_previewimg_cached_ensure ( const char * name)

◆ BKE_previewimg_cached_get()

PreviewImage * BKE_previewimg_cached_get ( const char * name)

◆ BKE_previewimg_cached_release()

◆ BKE_previewimg_cached_thumbnail_read()

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

◆ BKE_previewimg_clear()

◆ BKE_previewimg_clear_single()

◆ BKE_previewimg_copy()

PreviewImage * BKE_previewimg_copy ( const PreviewImage * prv)

◆ BKE_previewimg_create()

◆ BKE_previewimg_deferred_filepath_get()

const char * BKE_previewimg_deferred_filepath_get ( const PreviewImage * prv)

◆ BKE_previewimg_deferred_release()

◆ BKE_previewimg_deferred_thumb_source_get()

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

◆ BKE_previewimg_ensure()

◆ BKE_previewimg_finish()

◆ BKE_previewimg_free()

◆ BKE_previewimg_freefunc()

void BKE_previewimg_freefunc ( void * link)

Free the preview image for use in list.

Definition at line 120 of file preview_image.cc.

References BKE_previewimg_free(), and BKE_previewimg_freefunc().

Referenced by BKE_preview_images_free(), BKE_previewimg_freefunc(), and imb_thumb_load_from_blend_id().

◆ BKE_previewimg_id_copy()

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

◆ BKE_previewimg_id_custom_set()

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

◆ BKE_previewimg_id_ensure()

◆ BKE_previewimg_id_free()

void BKE_previewimg_id_free ( ID * id)

◆ BKE_previewimg_id_get()

◆ BKE_previewimg_id_get_p()

◆ BKE_previewimg_id_supports_jobs()

bool BKE_previewimg_id_supports_jobs ( const ID * id)

◆ BKE_previewimg_is_finished()

◆ BKE_previewimg_is_invalid()

bool BKE_previewimg_is_invalid ( const PreviewImage * prv)

Deferred preview images may fail to load, e.g. because the image couldn't be found on disk.

Returns
true of a deferred preview image could not be loaded.

Definition at line 467 of file preview_image.cc.

References BKE_previewimg_is_invalid(), PRV_TAG_DEFFERED_INVALID, and PreviewImage::runtime.

Referenced by blender::ed::asset::asset_preview_icon_id(), BKE_previewimg_is_invalid(), and ui_id_preview_image_render_size().

◆ BKE_previewimg_to_imbuf()

ImBuf * BKE_previewimg_to_imbuf ( const 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 439 of file preview_image.cc.

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

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