#include "BLI_compiler_attrs.h"

Classes
struct	Icon

struct	Icon_Geom

Macros
#define	ICON_RENDER_DEFAULT_HEIGHT 32

Typedefs
typedef void(*	DrawInfoFreeFP) (void *drawinfo)

typedef struct Icon	Icon

Enumerations
enum	{ ICON_DATA_ID = 0 , ICON_DATA_IMBUF , ICON_DATA_PREVIEW , ICON_DATA_GEOM , ICON_DATA_STUDIOLIGHT , ICON_DATA_GPLAYER }

Functions
void	BKE_icons_init (int first_dyn_id)

int	BKE_icon_id_ensure (struct ID *id)

int	BKE_icon_gplayer_color_ensure (struct bGPDlayer *gpl)

int	BKE_icon_preview_ensure (struct ID id, struct PreviewImage preview)

int	BKE_icon_imbuf_create (struct ImBuf *ibuf) ATTR_WARN_UNUSED_RESULT

struct ImBuf *	BKE_icon_imbuf_get_buffer (int icon_id) ATTR_WARN_UNUSED_RESULT

struct Icon *	BKE_icon_get (const int icon_id)

void	BKE_icon_set (const int icon_id, struct Icon *icon)

void	BKE_icon_id_delete (struct ID *id)

bool	BKE_icon_delete (const int icon_id)

bool	BKE_icon_delete_unmanaged (const int icon_id)

void	BKE_icon_changed (const int icon_id)

void	BKE_icons_free (void)

void	BKE_icons_deferred_free (void)

void	BKE_previewimg_freefunc (void *link)

void	BKE_previewimg_free (struct PreviewImage **prv)

void	BKE_previewimg_clear (struct PreviewImage *prv)

void	BKE_previewimg_clear_single (struct PreviewImage *prv, enum eIconSizes size)

struct PreviewImage **	BKE_previewimg_id_get_p (const struct ID *id)

struct PreviewImage *	BKE_previewimg_id_get (const struct ID *id)

bool	BKE_previewimg_id_supports_jobs (const struct ID *id)

void	BKE_previewimg_id_custom_set (struct ID id, const char path)

void	BKE_previewimg_id_free (struct ID *id)

struct PreviewImage *	BKE_previewimg_create (void)

struct PreviewImage *	BKE_previewimg_copy (const struct PreviewImage *prv)

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

struct PreviewImage *	BKE_previewimg_id_ensure (struct ID *id)

void	BKE_previewimg_ensure (struct PreviewImage *prv, const int size)

struct ImBuf *	BKE_previewimg_to_imbuf (struct PreviewImage *prv, const int size)

void	BKE_previewimg_finish (struct PreviewImage *prv, const int size)

bool	BKE_previewimg_is_finished (const struct PreviewImage *prv, const int size)

struct PreviewImage *	BKE_previewimg_cached_get (const char *name)

struct PreviewImage *	BKE_previewimg_cached_ensure (const char *name)

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

void	BKE_previewimg_cached_release (const char *name)

void	BKE_previewimg_deferred_release (struct PreviewImage *prv)

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

void	BKE_previewimg_blend_read (struct BlendDataReader reader, struct PreviewImage prv)

int	BKE_icon_geom_ensure (struct Icon_Geom *geom)

struct Icon_Geom *	BKE_icon_geom_from_memory (uchar *data, size_t data_len)

struct Icon_Geom *	BKE_icon_geom_from_file (const char *filename)

struct ImBuf *	BKE_icon_geom_rasterize (const struct Icon_Geom *geom, const unsigned int size_x, const unsigned int size_y)

void	BKE_icon_geom_invert_lightness (struct Icon_Geom *geom)

int	BKE_icon_ensure_studio_light (struct StudioLight *sl, int id_type)

Detailed Description

Resizable Icons for Blender

There is some thread safety for this API but it is rather weak. Registering or unregistering icons is thread safe, changing data of icons from multiple threads is not. Practically this should be fine since only the main thread modifies icons. Should that change, more locks or a different design need to be introduced.

Definition in file BKE_icons.h.

Macro Definition Documentation

◆ ICON_RENDER_DEFAULT_HEIGHT

#define ICON_RENDER_DEFAULT_HEIGHT 32

Definition at line 202 of file BKE_icons.h.

Typedef Documentation

◆ DrawInfoFreeFP

typedef void(* DrawInfoFreeFP) (void *drawinfo)

Definition at line 39 of file BKE_icons.h.

◆ Icon

typedef struct Icon Icon

Definition at line 39 of file BKE_icons.h.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
ICON_DATA_ID	ID preview: obj is ID.
ICON_DATA_IMBUF	Arbitrary Image buffer: obj is ImBuf
ICON_DATA_PREVIEW	Preview: obj is PreviewImage
ICON_DATA_GEOM	2D triangles: obj is Icon_Geom
ICON_DATA_STUDIOLIGHT	Studiolight
ICON_DATA_GPLAYER	GPencil Layer color preview (annotations): obj is bGPDlayer

Definition at line 41 of file BKE_icons.h.

Function Documentation

◆ BKE_icon_changed()

void BKE_icon_changed ( const int icon_id )

Definition at line 678 of file icons.cc.

References BKE_previewimg_id_get_p(), BLI_assert, G, ICON_DATA_ID, icon_ghash_lookup(), Icon_Geom::icon_id, Icon::id_type, NUM_ICON_SIZES, Icon::obj, Icon::obj_type, PRV_CHANGED, and PRV_UNFINISHED.

Referenced by area_move_apply_do(), area_split_apply(), ghost_event_proc(), icon_preview_imbuf_from_brush(), image_changed(), image_init_after_load(), image_replace_exec(), lamp_changed(), material_changed(), screen_area_join(), texture_changed(), and world_changed().

◆ BKE_icon_delete()

bool BKE_icon_delete ( const int icon_id )

Remove icon and free data.

Definition at line 940 of file icons.cc.

References BLI_ghash_popkey(), gIconMutex, gIcons, icon_free(), icon_free_data(), Icon_Geom::icon_id, and POINTER_FROM_INT.

Referenced by BKE_gpencil_layer_delete(), BKE_previewimg_deferred_release(), filelist_cache_preview_freef(), filelist_cache_previews_clear(), filelist_cache_previews_update(), and filelist_entry_clear().

◆ BKE_icon_delete_unmanaged()

bool BKE_icon_delete_unmanaged ( const int icon_id )

Definition at line 957 of file icons.cc.

References BLI_ghash_insert(), BLI_ghash_popkey(), Icon::flag, gIconMutex, gIcons, ICON_FLAG_MANAGED, icon_free(), icon_free_data(), Icon_Geom::icon_id, POINTER_FROM_INT, and UNLIKELY.

Referenced by bpy_app_icons_release().

◆ BKE_icon_ensure_studio_light()

int BKE_icon_ensure_studio_light	(	struct StudioLight *	sl,
		int	id_type
	)

Definition at line 1057 of file icons.cc.

References get_next_free_id(), icon_create(), ICON_DATA_STUDIOLIGHT, Icon_Geom::icon_id, and Icon::id_type.

Referenced by studiolight_create().

◆ BKE_icon_geom_ensure()

int BKE_icon_geom_ensure ( struct Icon_Geom * geom )

Definition at line 985 of file icons.cc.

References BLI_assert, BLI_thread_is_main(), get_next_free_id(), icon_create(), ICON_DATA_GEOM, and Icon_Geom::icon_id.

Referenced by bpy_app_icons_new_triangles(), and bpy_app_icons_new_triangles_from_file().

◆ BKE_icon_geom_from_file()

struct Icon_Geom* BKE_icon_geom_from_file ( const char * filename )

Definition at line 1040 of file icons.cc.

References BKE_icon_geom_from_memory(), BLI_assert, BLI_file_read_binary_as_mem(), BLI_thread_is_main(), and data.

Referenced by bpy_app_icons_new_triangles_from_file().

◆ BKE_icon_geom_from_memory()

struct Icon_Geom* BKE_icon_geom_from_memory	(	uchar *	data,
		size_t	data_len
	)

Definition at line 1001 of file icons.cc.

References ARRAY_SIZE, BLI_assert, BLI_thread_is_main(), Icon_Geom::colors, Icon_Geom::coords, Icon_Geom::coords_len, Icon_Geom::coords_range, data, Icon_Geom::icon_id, Icon_Geom::mem, and MEM_mallocN.

Referenced by BKE_icon_geom_from_file().

◆ BKE_icon_geom_invert_lightness()

void BKE_icon_geom_invert_lightness ( struct Icon_Geom * geom )

Definition at line 143 of file icons_rasterize.c.

References Icon_Geom::colors, Icon_Geom::coords_len, hsl_to_rgb(), length(), rgb_float_to_uchar(), rgb_to_hsl_v(), and rgb_uchar_to_float().

Referenced by icon_draw_size().

◆ BKE_icon_geom_rasterize()

struct ImBuf* BKE_icon_geom_rasterize	(	const struct Icon_Geom *	geom,
		const unsigned int	size_x,
		const unsigned int	size_y
	)

Definition at line 84 of file icons_rasterize.c.

References col, Icon_Geom::colors, Icon_Geom::coords, Icon_Geom::coords_len, max_ii(), pos, and rect_size().

Referenced by icon_draw_size().

◆ BKE_icon_get()

struct Icon* BKE_icon_get ( const int icon_id )

Definition at line 881 of file icons.cc.

References BLI_assert, BLI_thread_is_main(), CLOG_ERROR, icon_ghash_lookup(), Icon_Geom::icon_id, and LOG.

Referenced by icon_draw_size(), ui_icon_ensure_deferred(), UI_icon_get_height(), UI_icon_get_theme_color(), UI_icon_get_width(), UI_icon_to_preview(), and ui_studiolight_kill_icon_preview_job().

◆ BKE_icon_gplayer_color_ensure()

int BKE_icon_gplayer_color_ensure ( struct bGPDlayer * gpl )

Definition at line 785 of file icons.cc.

References BLI_assert, BLI_thread_is_main(), CLOG_ERROR, G, get_next_free_id(), icon_gplayer_color_ensure_create_icon(), bGPDlayer_Runtime::icon_id, LOG, and bGPDlayer::runtime.

◆ BKE_icon_id_delete()

void BKE_icon_id_delete ( struct ID * id )

Definition at line 919 of file icons.cc.

References BKE_icons_deferred_free(), BLI_ghash_remove(), BLI_thread_is_main(), gIconMutex, gIcons, icon_add_to_deferred_delete_queue(), icon_free(), Icon_Geom::icon_id, and POINTER_FROM_INT.

Referenced by image_free_data(), light_free_data(), material_free_data(), texture_free_data(), and world_free_data().

◆ BKE_icon_id_ensure()

int BKE_icon_id_ensure ( struct ID * id )

Definition at line 740 of file icons.cc.

References BKE_previewimg_id_get_p(), BLI_assert, BLI_thread_is_main(), CLOG_ERROR, ELEM, G, get_next_free_id(), ID::icon_id, icon_id_ensure_create_icon(), id, and LOG.

Referenced by icon_preview_imbuf_from_brush(), image_changed(), image_init_after_load(), image_replace_exec(), lamp_changed(), material_changed(), texture_changed(), ui_id_brush_get_icon(), ui_id_icon_get(), ui_id_screen_get_icon(), and world_changed().

◆ BKE_icon_imbuf_create()

int BKE_icon_imbuf_create ( ImBuf * ibuf )

Create an icon as owner or ibuf. The icon-ID is not stored in ibuf, it needs to be stored separately.

Note: Transforms ownership of ibuf to the newly created icon.

Definition at line 856 of file icons.cc.

References Icon::flag, get_next_free_id(), icon_create(), ICON_DATA_IMBUF, ICON_FLAG_MANAGED, and Icon_Geom::icon_id.

Referenced by filelist_cache_preview_runf(), and filelist_file_create_entry().

◆ BKE_icon_imbuf_get_buffer()

struct ImBuf* BKE_icon_imbuf_get_buffer ( int icon_id )

Definition at line 866 of file icons.cc.

References CLOG_ERROR, ICON_DATA_IMBUF, icon_ghash_lookup(), Icon_Geom::icon_id, LOG, Icon::obj, and Icon::obj_type.

Referenced by filelist_file_getimage(), and filelist_getimage().

◆ BKE_icon_preview_ensure()

int BKE_icon_preview_ensure	(	ID *	id,
		PreviewImage *	preview
	)

Return icon id of given preview, or create new icon if not found.

Definition at line 811 of file icons.cc.

References BKE_previewimg_id_ensure(), BLI_assert, CLOG_ERROR, Icon::flag, G, get_next_free_id(), icon_create(), ICON_DATA_PREVIEW, ICON_FLAG_MANAGED, ID::icon_id, PreviewImage::icon_id, icon_id_ensure_create_icon(), id, and LOG.

◆ BKE_icon_set()

void BKE_icon_set	(	const int	icon_id,
		struct Icon *	icon
	)

Definition at line 897 of file icons.cc.

References BLI_ghash_ensure_p(), CLOG_ERROR, gIconMutex, gIcons, Icon_Geom::icon_id, LOG, and POINTER_FROM_INT.

Referenced by def_internal_icon(), and def_internal_vicon().

◆ BKE_icons_deferred_free()

void BKE_icons_deferred_free ( void )

Definition at line 229 of file icons.cc.

References BLI_ghash_remove(), BLI_linklist_lockfree_begin(), BLI_linklist_lockfree_clear(), g_icon_delete_queue, gIconMutex, gIcons, icon_free(), MEM_freeN, node, and POINTER_FROM_INT.

Referenced by BKE_icon_id_delete().

◆ BKE_icons_free()

void BKE_icons_free ( void )

Definition at line 212 of file icons.cc.

References BKE_previewimg_freefunc(), BLI_assert, BLI_ghash_free(), BLI_linklist_lockfree_free(), BLI_thread_is_main(), g_icon_delete_queue, gCachedPreviews, gIcons, icon_free(), and MEM_freeN.

Referenced by UI_icons_free().

◆ BKE_icons_init()

void BKE_icons_init ( int first_dyn_id )

Definition at line 195 of file icons.cc.

References BLI_assert, BLI_ghash_int_new(), BLI_ghash_str_new(), BLI_linklist_lockfree_init(), BLI_thread_is_main(), g_icon_delete_queue, gCachedPreviews, gFirstIconId, gIcons, and gNextIconId.

Referenced by WM_init().

◆ BKE_previewimg_blend_read()

void BKE_previewimg_blend_read	(	struct BlendDataReader *	reader,
		struct PreviewImage *	prv
	)

◆ BKE_previewimg_blend_write()

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

Referenced by action_blend_write(), BKE_collection_blend_write_nolib(), image_blend_write(), light_blend_write(), material_blend_write(), object_blend_write(), scene_blend_write(), screen_blend_write(), texture_blend_write(), and world_blend_write().

◆ BKE_previewimg_cached_ensure()

struct PreviewImage* BKE_previewimg_cached_ensure ( const char * name )

Generate an empty PreviewImage, if not yet existing.

Definition at line 464 of file icons.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()

struct PreviewImage* BKE_previewimg_cached_get ( const char * name )

Definition at line 455 of file icons.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 530 of file icons.cc.

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

◆ BKE_previewimg_cached_thumbnail_read()

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

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

Definition at line 485 of file icons.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(), PRV_DEFERRED_DATA, and STREQ.