#include "BLI_sys_types.h"
#include "DNA_ID_enums.h"

Classes
struct	IconTextOverlay

Macros
#define	UI_NO_ICON_OVERLAY_TEXT NULL

#define	ICON_DEFAULT_HEIGHT 16

#define	ICON_DEFAULT_WIDTH 16

#define	ICON_DEFAULT_HEIGHT_TOOLBAR 32

#define	ICON_DEFAULT_HEIGHT_SCALE ((int)(UI_UNIT_Y * 0.8f))

#define	ICON_DEFAULT_WIDTH_SCALE ((int)(UI_UNIT_X * 0.8f))

#define	PREVIEW_DEFAULT_HEIGHT 128

Enumerations
enum	eAlertIcon { ALERT_ICON_NONE = -1 , ALERT_ICON_WARNING = 0 , ALERT_ICON_QUESTION = 1 , ALERT_ICON_ERROR = 2 , ALERT_ICON_INFO = 3 , ALERT_ICON_MAX }

Functions
ImBuf *	UI_icon_alert_imbuf_get (eAlertIcon icon, float size)

void	UI_icons_init ()

bool	UI_icon_get_theme_color (int icon_id, unsigned char color[4])

void	UI_icon_render_id (const bContext C, Scene scene, ID *id, enum eIconSizes size, bool use_job)

void	UI_icon_render_id_ex (const bContext C, Scene scene, ID id_to_render, const enum eIconSizes size, const bool use_job, PreviewImage r_preview_image)

int	UI_icon_preview_to_render_size (enum eIconSizes size)

void	UI_icon_draw (float x, float y, int icon_id)

void	UI_icon_draw_alpha (float x, float y, int icon_id, float alpha)

void	UI_icon_draw_preview (float x, float y, int icon_id, float aspect, float alpha, int size)

void	UI_icon_draw_ex (float x, float y, int icon_id, float aspect, float alpha, float desaturate, const uchar mono_color[4], bool mono_border, const IconTextOverlay *text_overlay, const bool inverted=false)

ImBuf *	UI_svg_icon_bitmap (uint icon_id, float size, bool multicolor=false)

void	UI_icons_free ()

void	UI_icons_free_drawinfo (void *drawinfo)

PreviewImage *	UI_icon_to_preview (int icon_id)

int	UI_icon_from_rnaptr (const bContext C, PointerRNA ptr, int rnaicon, bool big)

int	UI_icon_from_idcode (int idcode)

int	UI_icon_from_library (const ID *id)

int	UI_icon_from_object_mode (int mode)

int	UI_icon_color_from_collection (const Collection *collection)

void	UI_icon_text_overlay_init_from_count (IconTextOverlay *text_overlay, const int icon_indicator_number)

Macro Definition Documentation

◆ ICON_DEFAULT_HEIGHT

#define ICON_DEFAULT_HEIGHT 16

Definition at line 31 of file UI_interface_icons.hh.

Referenced by button2d_draw_intern(), draw_icon_centered(), get_draw_size(), icon_draw_icon(), icon_draw_size(), blender::ed::outliner::tselem_draw_icon(), ui_draw_menu_item(), widget_draw_icon(), widget_draw_icon_centered(), widget_draw_submenu_tria(), and widget_draw_text_icon().

◆ ICON_DEFAULT_HEIGHT_SCALE

#define ICON_DEFAULT_HEIGHT_SCALE ((int)(UI_UNIT_Y * 0.8f))

Definition at line 36 of file UI_interface_icons.hh.

Referenced by file_draw_list().

◆ ICON_DEFAULT_HEIGHT_TOOLBAR

#define ICON_DEFAULT_HEIGHT_TOOLBAR 32

Definition at line 34 of file UI_interface_icons.hh.

Referenced by icon_draw_size(), and widget_draw_text_icon().

◆ ICON_DEFAULT_WIDTH

#define ICON_DEFAULT_WIDTH 16

Definition at line 32 of file UI_interface_icons.hh.

Referenced by button2d_draw_intern(), screen_draw_area_drag_tip(), vicon_collection_color_draw(), vicon_layergroup_color_draw(), vicon_strip_color_draw(), vicon_strip_color_draw_library_data_indirect(), vicon_strip_color_draw_library_data_override_noneditable(), and widget_draw_submenu_tria().

◆ ICON_DEFAULT_WIDTH_SCALE

#define ICON_DEFAULT_WIDTH_SCALE ((int)(UI_UNIT_X * 0.8f))

Definition at line 37 of file UI_interface_icons.hh.

Referenced by file_draw_list().

◆ PREVIEW_DEFAULT_HEIGHT

#define PREVIEW_DEFAULT_HEIGHT 128

Definition at line 39 of file UI_interface_icons.hh.

Referenced by get_draw_size().

◆ UI_NO_ICON_OVERLAY_TEXT

Enumeration Type Documentation

◆ eAlertIcon

enum eAlertIcon

Enumerator
ALERT_ICON_NONE
ALERT_ICON_WARNING
ALERT_ICON_QUESTION
ALERT_ICON_ERROR
ALERT_ICON_INFO
ALERT_ICON_MAX

Definition at line 41 of file UI_interface_icons.hh.

Function Documentation

◆ UI_icon_alert_imbuf_get()

ImBuf * UI_icon_alert_imbuf_get	(	eAlertIcon	icon,
		float	size )

Definition at line 2054 of file interface_icons.cc.

References ALERT_ICON_ERROR, ALERT_ICON_INFO, ALERT_ICON_QUESTION, ALERT_ICON_WARNING, UI_svg_icon_bitmap(), and UNUSED_VARS.

Referenced by uiDefButAlert().

◆ UI_icon_color_from_collection()

int UI_icon_color_from_collection ( const Collection * collection )

Definition at line 1945 of file interface_icons.cc.

References COLLECTION_COLOR_NONE.

Referenced by blender::ed::object::collection_object_active_itemf(), blender::ed::object::move_to_collection_menu_create(), blender::ed::object::move_to_collection_menus_items(), rna_id_itemf(), and ui_id_icon_get().

◆ UI_icon_draw()

void UI_icon_draw	(	float	x,
		float	y,
		int	icon_id )

Draws icon with DPI scale factor.

Definition at line 1956 of file interface_icons.cc.

References UI_icon_draw_ex(), UI_INV_SCALE_FAC, and UI_NO_ICON_OVERLAY_TEXT.

Referenced by ANIM_channel_draw(), ANIM_channel_draw_widgets(), drawAutoKeyWarning(), file_draw_invalid_asset_library_hint(), file_draw_invalid_library_hint(), ui_searchbox_region_draw_cb__operator(), and ui_searchbox_region_draw_fn().

◆ UI_icon_draw_alpha()

void UI_icon_draw_alpha	(	float	x,
		float	y,
		int	icon_id,
		float	alpha )

Definition at line 1962 of file interface_icons.cc.

References UI_icon_draw_ex(), UI_INV_SCALE_FAC, and UI_NO_ICON_OVERLAY_TEXT.

Referenced by button2d_draw_intern(), and blender::ed::outliner::outliner_draw_tree_element().

◆ UI_icon_draw_ex()

void UI_icon_draw_ex	(	float	x,
		float	y,
		int	icon_id,
		float	aspect,
		float	alpha,
		float	desaturate,
		const uchar	mono_color[4],
		bool	mono_border,
		const IconTextOverlay *	text_overlay,
		const bool	inverted = false )

◆ UI_icon_draw_preview()

void UI_icon_draw_preview	(	float	x,
		float	y,
		int	icon_id,
		float	aspect,
		float	alpha,
		int	size )

Definition at line 1968 of file interface_icons.cc.

References icon_draw_size(), ICON_SIZE_PREVIEW, and UI_NO_ICON_OVERLAY_TEXT.

Referenced by widget_draw_preview().

◆ UI_icon_from_idcode()

int UI_icon_from_idcode ( int idcode )

Definition at line 1830 of file interface_icons.cc.

References ID_AC, ID_AR, ID_BR, ID_CA, ID_CF, ID_CU_LEGACY, ID_CV, ID_GD_LEGACY, ID_GP, ID_GR, ID_IM, ID_IP, ID_KE, ID_LA, ID_LI, ID_LP, ID_LS, ID_LT, ID_MA, ID_MB, ID_MC, ID_ME, ID_MSK, ID_NT, ID_OB, ID_PA, ID_PAL, ID_PC, ID_PT, ID_SCE, ID_SCR, ID_SO, ID_SPK, ID_TE, ID_TXT, ID_VF, ID_VO, ID_WM, ID_WO, and ID_WS.

Referenced by filelist_geticon_ex().

◆ UI_icon_from_library()

int UI_icon_from_library ( const ID * id )

Definition at line 1747 of file interface_icons.cc.

References ID_IS_ASSET, ID_IS_LINKED, ID_IS_OVERRIDE_LIBRARY, ID_IS_OVERRIDE_LIBRARY_REAL, ID_TAG_INDIRECT, ID_TAG_MISSING, and LIBOVERRIDE_FLAG_SYSTEM_DEFINED.

Referenced by add_collection_search_item(), id_search_add(), and blender::ed::outliner::outliner_draw_tree_element().

◆ UI_icon_from_object_mode()

int UI_icon_from_object_mode ( int mode )

Definition at line 1915 of file interface_icons.cc.

References OB_MODE_EDIT, OB_MODE_EDIT_GPENCIL_LEGACY, OB_MODE_OBJECT, OB_MODE_PAINT_GREASE_PENCIL, OB_MODE_PARTICLE_EDIT, OB_MODE_POSE, OB_MODE_SCULPT, OB_MODE_SCULPT_CURVES, OB_MODE_SCULPT_GREASE_PENCIL, OB_MODE_TEXTURE_PAINT, OB_MODE_VERTEX_GREASE_PENCIL, OB_MODE_VERTEX_PAINT, OB_MODE_WEIGHT_GREASE_PENCIL, and OB_MODE_WEIGHT_PAINT.

Referenced by blender::ed::outliner::outliner_draw_mode_column_toggle().

◆ UI_icon_from_rnaptr()

int UI_icon_from_rnaptr	(	const bContext *	C,
		PointerRNA *	ptr,
		int	rnaicon,
		bool	big )

◆ UI_icon_get_theme_color()

bool UI_icon_get_theme_color	(	int	icon_id,
		unsigned char	color[4] )

Definition at line 965 of file interface_icons.cc.

References BKE_icon_get(), DrawInfo::data, icon_ensure_drawinfo(), DrawInfo::texture, DrawInfo::theme_color, and UI_GetIconThemeColor4ubv().

Referenced by blender::ed::outliner::tselem_draw_icon(), widget_draw_icon(), and widget_draw_icon_centered().

◆ UI_icon_preview_to_render_size()

int UI_icon_preview_to_render_size ( enum eIconSizes size )

Render size for preview images and icons

Definition at line 984 of file interface_icons.cc.

References ICON_RENDER_DEFAULT_HEIGHT, ICON_SIZE_ICON, ICON_SIZE_PREVIEW, and PREVIEW_RENDER_DEFAULT_HEIGHT.

Referenced by bpy_app_preview_render_size_get(), and icon_create_rect().

◆ UI_icon_render_id()

void UI_icon_render_id	(	const bContext *	C,
		Scene *	scene,
		ID *	id,
		enum eIconSizes	size,
		bool	use_job )

Render a PreviewImage for the data block.

Note that if an ID doesn't support jobs for preview creation, use_job will be ignored.

Definition at line 1672 of file interface_icons.cc.

References BKE_previewimg_id_ensure(), Object::data, ED_preview_id_is_supported(), GS, ID_OB, and UI_icon_render_id_ex().

Referenced by ED_preview_restart_queue_work(), blender::ed::asset::generate_preview(), lib_id_generate_preview_exec(), previews_id_ensure(), and ui_id_icon_get().

◆ UI_icon_render_id_ex()

void UI_icon_render_id_ex	(	const bContext *	C,
		Scene *	scene,
		ID *	id_to_render,
		const enum eIconSizes	size,
		const bool	use_job,
		PreviewImage *	r_preview_image )