#include <cmath>
#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <ft2build.h>
#include "BLI_fileops.h"
#include "BLI_math_rotation.h"
#include "BLI_path_utils.hh"
#include "BLI_string.h"
#include "BLF_api.hh"
#include "IMB_colormanagement.hh"
#include "GPU_matrix.hh"
#include "GPU_state.hh"
#include "blf_internal.hh"
#include "blf_internal_types.hh"

Classes
struct	BLFBufferState

Macros
#define	BLF_RESULT_CHECK_INIT(r_info)

Functions
static FontBLF *	blf_get (int fontid)
int	BLF_init ()
void	BLF_exit ()
void	BLF_reset_fonts ()
void	BLF_cache_clear ()
static int	blf_search_by_mem_name (const char *mem_name)
static int	blf_search_by_filepath (const char *filepath)
static int	blf_search_available ()
bool	BLF_has_glyph (int fontid, uint unicode)
bool	BLF_is_loaded (const char *filepath)
bool	BLF_is_loaded_mem (const char *name)
bool	BLF_is_loaded_id (int fontid)
int	BLF_load (const char *filepath)
int	BLF_load_unique (const char *filepath)
void	BLF_metrics_attach (const int fontid, const uchar *mem, const int mem_size)
int	BLF_load_mem (const char name, const uchar mem, int mem_size)
int	BLF_load_mem_unique (const char name, const uchar mem, int mem_size)
void	BLF_unload (const char *filepath)
bool	BLF_unload_id (int fontid)
void	BLF_unload_all ()
void	BLF_addref_id (int fontid)
void	BLF_enable (int fontid, FontFlags flag)
void	BLF_disable (int fontid, FontFlags flag)
bool	BLF_is_builtin (int fontid)
void	BLF_character_weight (int fontid, int weight)
int	BLF_default_weight (int fontid)
bool	BLF_has_variable_weight (int fontid)
void	BLF_aspect (int fontid, float x, float y, float z)
void	BLF_position (int fontid, float x, float y, float z)
void	BLF_size (int fontid, float size)
void	BLF_color4ubv (int fontid, const uchar rgba[4])
void	BLF_color3ubv_alpha (int fontid, const uchar rgb[3], uchar alpha)
void	BLF_color3ubv (int fontid, const uchar rgb[3])
void	BLF_color4ub (int fontid, uchar r, uchar g, uchar b, uchar alpha)
void	BLF_color3ub (int fontid, uchar r, uchar g, uchar b)
void	BLF_color4fv (int fontid, const float rgba[4])
void	BLF_color4f (int fontid, float r, float g, float b, float a)
void	BLF_color3fv_alpha (int fontid, const float rgb[3], float alpha)
void	BLF_color3f (int fontid, float r, float g, float b)
void	BLF_batch_draw_begin ()
void	BLF_batch_draw_flush ()
void	BLF_batch_draw_end ()
static void	blf_draw_gpu__start (const FontBLF *font)
static void	blf_draw_gpu__end (const FontBLF *font)
void	BLF_draw (int fontid, const char str, const size_t str_len, ResultBLF r_info)
int	BLF_draw_mono (int fontid, const char *str, const size_t str_len, int cwidth, int tab_columns)
void	BLF_draw_svg_icon (uint icon_id, float x, float y, float size, const float color[4], float outline_alpha, bool multicolor, blender::FunctionRef< void(std::string &)> edit_source_cb)
blender::Array< uchar >	BLF_svg_icon_bitmap (uint icon_id, float size, int r_width, int r_height, bool multicolor, blender::FunctionRef< void(std::string &)> edit_source_cb)
void	BLF_boundbox_foreach_glyph (int fontid, const char str, size_t str_len, BLF_GlyphBoundsFn user_fn, void user_data)
size_t	BLF_str_offset_from_cursor_position (int fontid, const char *str, size_t str_len, int location_x)
bool	BLF_str_offset_to_glyph_bounds (int fontid, const char str, size_t str_offset, rcti r_glyph_bounds)
int	BLF_str_offset_to_cursor (int fontid, const char *str, const size_t str_len, const size_t str_offset, const int cursor_width)
blender::Vector< blender::Bounds< int > >	BLF_str_selection_boxes (int fontid, const char *str, size_t str_len, size_t sel_start, size_t sel_length)
size_t	BLF_width_to_strlen (int fontid, const char str, const size_t str_len, float width, float r_width)
size_t	BLF_width_to_rstrlen (int fontid, const char str, const size_t str_len, float width, float r_width)
void	BLF_boundbox (int fontid, const char str, const size_t str_len, rcti r_box, ResultBLF *r_info)
void	BLF_width_and_height (int fontid, const char str, const size_t str_len, float r_width, float *r_height)
float	BLF_width (int fontid, const char str, const size_t str_len, ResultBLF r_info)
float	BLF_fixed_width (int fontid)
int	BLF_glyph_advance (int fontid, const char *str)
float	BLF_height (int fontid, const char str, const size_t str_len, ResultBLF r_info)
int	BLF_height_max (int fontid)
int	BLF_width_max (int fontid)
int	BLF_descender (int fontid)
int	BLF_ascender (int fontid)
bool	BLF_bounds_max (int fontid, rctf *r_bounds)
void	BLF_rotation (int fontid, float angle)
void	BLF_clipping (int fontid, int xmin, int ymin, int xmax, int ymax)
void	BLF_wordwrap (int fontid, int wrap_width, BLFWrapMode mode)
void	BLF_shadow (int fontid, FontShadowType type, const float rgba[4])
void	BLF_shadow_offset (int fontid, int x, int y)
void	BLF_buffer (int fontid, float fbuf, uchar cbuf, int w, int h, const ColorSpace *colorspace)
BLFBufferState *	BLF_buffer_state_push (int fontid)
void	BLF_buffer_state_pop (BLFBufferState *buffer_state)
void	BLF_buffer_state_free (BLFBufferState *buffer_state)
void	BLF_buffer_col (int fontid, const float srgb_color[4])
void	blf_draw_buffer__start (FontBLF *font)
void	blf_draw_buffer__end ()
void	BLF_draw_buffer (int fontid, const char str, const size_t str_len, ResultBLF r_info)
blender::Vector< blender::StringRef >	BLF_string_wrap (int fontid, blender::StringRef str, const int max_pixel_width, BLFWrapMode mode)
char *	BLF_display_name_from_file (const char *filepath)
char *	BLF_display_name_from_id (int fontid)
bool	BLF_get_vfont_metrics (int fontid, float ascend_ratio, float em_ratio, float *scale)
bool	BLF_character_to_curves (int fontid, uint unicode, ListBase nurbsbase, const float scale, bool use_fallback, float r_advance)
void	BLF_state_print (int fontid)

Variables
FontBLF *	global_font [BLF_MAX_FONT] = {nullptr}
int	blf_mono_font = -1
int	blf_mono_font_render = -1
static blender::Mutex	g_blf_load_mutex

Detailed Description

Main BlenFont (BLF) API, public functions for font handling.

Wraps GPU display and FreeType.

Definition in file blf.cc.

Macro Definition Documentation

◆ BLF_RESULT_CHECK_INIT

#define BLF_RESULT_CHECK_INIT ( r_info )

Value:

if (r_info) { \
  memset(r_info, 0, sizeof(*(r_info))); \
} \
((void)0)

Definition at line 38 of file blf.cc.

Referenced by BLF_boundbox(), BLF_draw(), BLF_height(), and BLF_width().

Function Documentation

◆ BLF_addref_id()

void BLF_addref_id ( int fontid )

Increases font reference count.

Definition at line 311 of file blf.cc.

References blf_get(), g_blf_load_mutex, lock, and FontBLF::reference_count.

Referenced by blender::seq::strip_load_font_file(), and blender::seq::strip_load_font_mem().

◆ BLF_ascender()

int BLF_ascender ( int fontid )

Definition at line 883 of file blf.cc.

References blf_font_ascender(), and blf_get().

Referenced by BLF_str_offset_to_glyph_bounds(), blender::tests::TEST(), UI_fontstyle_draw_ex(), UI_fontstyle_draw_multiline_clipped_ex(), and UI_fontstyle_draw_rotated().

◆ BLF_aspect()

void BLF_aspect	(	int	fontid,
		float	x,
		float	y,
		float	z )

Definition at line 377 of file blf.cc.

References FontBLF::aspect, blf_get(), x, y, and z().

Referenced by blender::ed::space_node::frame_node_draw_label(), playanim_toscreen_ex(), and py_blf_aspect().

◆ BLF_batch_draw_begin()

void BLF_batch_draw_begin ( )

Batch draw-calls together as long as the model-view matrix and the font remain unchanged.

Definition at line 534 of file blf.cc.

References BLI_assert, and g_batch.

Referenced by draw_horizontal_scale_indicators(), draw_vertical_scale_indicators(), file_draw_list(), UI_block_draw(), and view3d_draw_region_info().

◆ BLF_batch_draw_end()

void BLF_batch_draw_end ( )

Definition at line 547 of file blf.cc.

References blf_batch_draw(), BLI_assert, and g_batch.

Referenced by draw_horizontal_scale_indicators(), draw_vertical_scale_indicators(), file_draw_list(), UI_block_draw(), and view3d_draw_region_info().

◆ BLF_batch_draw_flush()

void BLF_batch_draw_flush ( )

Definition at line 540 of file blf.cc.

References blf_batch_draw(), and g_batch.

Referenced by ui_draw_but_WAVEFORM().

◆ BLF_boundbox()

void BLF_boundbox	(	int	fontid,
		const char *	str,
		size_t	str_len,
		rcti *	r_box,
		ResultBLF *	r_info = nullptr )

This function return the bounding box of the string and are not multiplied by the aspect.

Definition at line 772 of file blf.cc.

References blf_font_boundbox(), blf_font_boundbox__wrap(), blf_get(), BLF_RESULT_CHECK_INIT, BLF_WORD_WRAP, FontBLF::flags, and str.

Referenced by BLF_str_offset_to_glyph_bounds(), file_draw_string_multiline(), icon_draw_rect_input_text(), and metadata_box_height_get().

◆ BLF_boundbox_foreach_glyph()

void BLF_boundbox_foreach_glyph	(	int	fontid,
		const char *	str,
		size_t	str_len,
		BLF_GlyphBoundsFn	user_fn,
		void *	user_data )

Run user_fn for each character, with the bound-box that would be used for drawing.

Parameters

user_fn	Callback that runs on each glyph, returning false early exits.
user_data	User argument passed to user_fn.

Note: The font position, clipping, matrix and rotation are not applied.

Definition at line 664 of file blf.cc.

References blf_font_boundbox_foreach_glyph(), blf_get(), BLF_WORD_WRAP, BLI_assert, FontBLF::flags, and str.

◆ BLF_bounds_max()

bool BLF_bounds_max	(	int	fontid,
		rctf *	r_bounds )

Returns the minimum bounding box that can enclose all glyphs in the font at the current size. Expect negative values as Y=0 is the baseline, X=0 is normal advance position (glyphs can have negative bearing and positioning). There should be little use for this as it is best to measure the bounds of the actual text to be drawn. These values (unscaled) are set in the font file, not calculated from the actual glyphs at load time. This should be considered correct but it is possible, although very unlikely, for a defective font to contain incorrect values.

Definition at line 894 of file blf.cc.

References blf_font_bounds_max(), and blf_get().

Referenced by BLF_str_offset_to_glyph_bounds(), and blender::seq::calc_boundbox().

◆ BLF_buffer()

void BLF_buffer	(	int	fontid,
		float *	fbuf,
		unsigned char *	cbuf,
		int	w,
		int	h,
		const ColorSpace *	colorspace )

Make font be rasterized into a given memory image/buffer. The image is assumed to have 4 color channels (RGBA) per pixel. When done, call this function with null buffer pointers.

Definition at line 956 of file blf.cc.

References blf_get(), FontBLF::buf_info, FontBufInfoBLF::cbuf, FontBufInfoBLF::colorspace, FontBufInfoBLF::dims, FontBufInfoBLF::fbuf, and w().

Referenced by BKE_image_stamp_buf(), BLF_str_offset_to_glyph_bounds(), checker_board_text(), cursor_bitmap_from_text(), blender::seq::do_text_effect(), blender::seq::draw_text_outline(), IMB_font_preview(), and py_blf_bind_imbuf_enter().

◆ BLF_buffer_col()

void BLF_buffer_col	(	int	fontid,
		const float	srgb_color[4] )

Set the color to be used for text.

Definition at line 1015 of file blf.cc.

References blf_get(), FontBLF::buf_info, FontBufInfoBLF::col_init, and copy_v4_v4().

Referenced by BKE_image_stamp_buf(), BLF_str_offset_to_glyph_bounds(), checker_board_text(), cursor_bitmap_from_text(), IMB_font_preview(), py_blf_color(), and blender::seq::text_draw().

◆ BLF_buffer_state_free()

void BLF_buffer_state_free ( BLFBufferState * buffer_state )

Free the state, only use in the rare case pop is not called (if the font itself is unloaded after pushing for example).

Definition at line 1010 of file blf.cc.

Referenced by BLF_buffer_state_pop(), BLF_str_offset_to_glyph_bounds(), and py_blf_bind_imbuf_dealloc().

◆ BLF_buffer_state_pop()

void BLF_buffer_state_pop ( BLFBufferState * buffer_state )

Pop the state (restoring the state when BLF_buffer_state_push was called).

Definition at line 993 of file blf.cc.

References BLF_buffer_state_free(), blf_get(), BLFBufferState::buf_info, FontBLF::buf_info, FontBufInfoBLF::col_init, copy_v4_v4(), BLFBufferState::font, and BLFBufferState::fontid.

Referenced by BLF_str_offset_to_glyph_bounds(), and py_blf_bind_imbuf_exit().

◆ BLF_buffer_state_push()

BLFBufferState * BLF_buffer_state_push ( int fontid )

Store the current buffer state. This state must be popped with BLF_buffer_state_pop.

Definition at line 980 of file blf.cc.

References blf_get(), BLFBufferState::buf_info, FontBLF::buf_info, BLFBufferState::font, and BLFBufferState::fontid.

Referenced by BLF_str_offset_to_glyph_bounds(), and py_blf_bind_imbuf_enter().

◆ BLF_cache_clear()

void BLF_cache_clear ( )

Definition at line 98 of file blf.cc.

References blf_glyph_cache_clear(), BLF_MAX_FONT, global_font, and i.

Referenced by ghost_event_proc(), reloadtranslation_exec(), and UI_view2d_zoom_cache_reset().

◆ BLF_character_to_curves()

bool BLF_character_to_curves	(	int	fontid,
		unsigned int	unicode,
		ListBase *	nurbsbase,
		const float	scale,
		bool	use_fallback,
		float *	r_advance )

Convert a character's outlines into curves.

Returns: success if the character was found and converted.

Definition at line 1146 of file blf.cc.

References blf_character_to_curves(), and blf_get().

Referenced by BKE_vfontdata_char_from_freetypefont().

◆ BLF_character_weight()

void BLF_character_weight	(	int	fontid,
		int	weight )

Weight class: 100 (Thin) - 400 (Normal) - 900 (Heavy).

Definition at line 347 of file blf.cc.

References blf_get(), and FontBLF::char_weight.

Referenced by fontstyle_set_ex(), and blender::tests::TEST().

◆ BLF_clipping()

void BLF_clipping	(	int	fontid,
		int	xmin,
		int	ymin,
		int	xmax,
		int	ymax )

Definition at line 912 of file blf.cc.

References blf_get(), FontBLF::clip_rec, rcti::xmax, rcti::xmin, rcti::ymax, and rcti::ymin.

Referenced by BLF_str_offset_to_glyph_bounds(), ED_region_image_metadata_draw(), ED_region_info_draw_multiline(), blender::ed::space_node::frame_node_draw_label(), py_blf_clipping(), UI_fontstyle_draw_ex(), UI_fontstyle_draw_multiline_clipped_ex(), UI_fontstyle_draw_rotated(), and UI_view2d_text_cache_draw().

◆ BLF_color3f()

void BLF_color3f	(	int	fontid,
		float	r,
		float	g,
		float	b )

Definition at line 528 of file blf.cc.

References b, and BLF_color4fv().

Referenced by blender::ed::object::voxel_size_edit_draw().

◆ BLF_color3fv_alpha()

void BLF_color3fv_alpha	(	int	fontid,
		const float	rgb[3],
		float	alpha )

Definition at line 520 of file blf.cc.

References BLF_color4fv(), and copy_v3_v3().

◆ BLF_color3ub()

void BLF_color3ub	(	int	fontid,
		uchar	r,
		uchar	g,
		uchar	b )

Definition at line 493 of file blf.cc.

References b, blf_get(), and FontBLF::color.

Referenced by ED_image_draw_info().

◆ BLF_color3ubv()

void BLF_color3ubv	(	int	fontid,
		const uchar	rgb[3] )

Definition at line 476 of file blf.cc.

References BLF_color3ubv_alpha().

Referenced by ED_image_draw_info(), blender::ed::space_node::frame_node_draw_label(), gizmo_ruler_draw(), knifetool_draw_angle(), knifetool_draw_visible_distances(), slider_draw(), and UI_panel_category_draw_all().

◆ BLF_color3ubv_alpha()

void BLF_color3ubv_alpha	(	int	fontid,
		const uchar	rgb[3],
		uchar	alpha )

Definition at line 464 of file blf.cc.

References blf_get(), and FontBLF::color.

Referenced by BLF_color3ubv().

◆ BLF_color4f()

void BLF_color4f	(	int	fontid,
		float	r,
		float	g,
		float	b,
		float	a )

Definition at line 514 of file blf.cc.

References b, and BLF_color4fv().

Referenced by playanim_toscreen_ex(), ui_draw_but_WAVEFORM(), and vectorscope_draw_target().

◆ BLF_color4fv()

void BLF_color4fv	(	int	fontid,
		const float	rgba[4] )

◆ BLF_color4ub()

void BLF_color4ub	(	int	fontid,
		uchar	r,
		uchar	g,
		uchar	b,
		uchar	alpha )

Definition at line 481 of file blf.cc.

References b, blf_get(), and FontBLF::color.

◆ BLF_color4ubv()

void BLF_color4ubv	(	int	fontid,
		const uchar	rgba[4] )

Definition at line 452 of file blf.cc.

References blf_get(), and FontBLF::color.

Referenced by draw_marker_texts(), drw_text_cache_draw_ex(), textview_draw_string(), UI_fontstyle_draw_ex(), UI_fontstyle_draw_multiline_clipped_ex(), UI_fontstyle_draw_rotated(), UI_fontstyle_draw_simple(), UI_FontThemeColor(), UI_view2d_text_cache_draw(), vicon_rgb_text_draw(), and widget_draw_text().

◆ BLF_default_weight()

int BLF_default_weight ( int fontid )

Returns: the font's default design weight (100-900).

Definition at line 355 of file blf.cc.

References blf_get(), FontBLF::metrics, and FontMetrics::weight.

Referenced by blender::tests::TEST(), and UI_update_text_styles().

◆ BLF_descender()

int BLF_descender ( int fontid )

Definition at line 872 of file blf.cc.

References blf_font_descender(), and blf_get().

Referenced by blender::seq::apply_text_alignment(), BKE_image_stamp_buf(), BLF_str_offset_to_glyph_bounds(), cursor_bitmap_from_text(), metadata_draw_imbuf(), screen_draw_area_drag_tip(), blender::tests::TEST(), blender::seq::text_effect_calc_runtime(), textview_draw(), UI_fontstyle_draw_ex(), UI_fontstyle_draw_multiline_clipped_ex(), UI_fontstyle_draw_rotated(), UI_fontstyle_draw_simple_backdrop(), and ui_tooltip_region_draw_cb().

◆ BLF_disable()

void BLF_disable	(	int	fontid,
		FontFlags	flag )

Definition at line 329 of file blf.cc.

References blf_get(), flag, and FontBLF::flags.

Referenced by BKE_image_stamp_buf(), BLF_str_offset_to_glyph_bounds(), blender::seq::build_character_info(), blender::seq::do_text_effect(), draw_vertical_scale_indicators(), drw_text_cache_draw_ex(), ED_region_image_metadata_draw(), ED_region_info_draw_multiline(), file_draw_string_multiline(), blender::ed::space_node::frame_node_draw_label(), gizmo_axis_draw(), gizmo_ruler_draw(), knifetool_draw_angle(), knifetool_draw_visible_distances(), metadata_box_height_get(), metadata_draw_imbuf(), py_blf_disable(), blender::ed::vse::sequencer_preview_draw_overlays(), blender::seq::text_draw(), text_info_row(), blender::seq::transform_image_raw_size_get(), UI_fontstyle_draw_ex(), UI_fontstyle_draw_multiline_clipped_ex(), UI_fontstyle_draw_rotated(), UI_panel_category_draw_all(), ui_tooltip_create_with_data(), ui_tooltip_region_draw_cb(), UI_view2d_text_cache_draw(), uiStyleInit(), view3d_draw_region_info(), and widget_draw_text_icon().

◆ BLF_display_name_from_file()

char * BLF_display_name_from_file ( const char * filepath )

Definition at line 1073 of file blf.cc.

References BLI_sprintfN(), and name.

Referenced by fileentry_uiname(), and blender::tests::TEST().

◆ BLF_display_name_from_id()

char * BLF_display_name_from_id ( int fontid )

Definition at line 1093 of file blf.cc.

References blf_display_name(), and blf_get().

Referenced by BKE_vfontdata_from_freetypefont(), and blender::tests::TEST().

◆ BLF_draw()

void BLF_draw	(	int	fontid,
		const char *	str,
		size_t	str_len,
		ResultBLF *	r_info = nullptr )

Draw the string using the current font.

Definition at line 585 of file blf.cc.

References blf_draw_gpu__end(), blf_draw_gpu__start(), blf_font_draw(), blf_font_draw__wrap(), blf_get(), BLF_RESULT_CHECK_INIT, BLF_WORD_WRAP, FontBLF::flags, and str.

Referenced by BLF_draw_default(), clip_draw_dopesheet_channels(), draw_marker_texts(), ED_image_draw_info(), ED_region_cache_draw_curfra_label(), ED_region_info_draw_multiline(), blender::ed::space_node::frame_node_draw_label(), gizmo_axis_draw(), gizmo_ruler_draw(), icon_draw_rect_input_text(), knifetool_draw_angle(), knifetool_draw_visible_distances(), loggerwindow_do_draw(), metadata_custom_draw_fields(), metadata_draw_imbuf(), playanim_toscreen_ex(), py_blf_draw(), radial_control_paint_cursor(), region_draw_status_text(), screen_draw_area_drag_tip(), slider_draw(), text_info_row(), UI_fontstyle_draw_ex(), UI_fontstyle_draw_multiline_clipped_ex(), UI_fontstyle_draw_rotated(), UI_fontstyle_draw_simple(), UI_fontstyle_draw_simple_backdrop(), UI_panel_category_draw_all(), vicon_rgb_text_draw(), blender::ed::object::voxel_size_edit_draw(), and widget_draw_text().

◆ BLF_draw_buffer()

void BLF_draw_buffer	(	int	fontid,
		const char *	str,
		size_t	str_len,
		ResultBLF *	r_info = nullptr )

Draw the string into the buffer, this function draw in both buffer, float and unsigned char BUT it's not necessary set both buffer, NULL is valid here.

Definition at line 1045 of file blf.cc.

References blf_draw_buffer__end(), blf_draw_buffer__start(), blf_font_draw_buffer(), blf_font_draw_buffer__wrap(), blf_get(), BLF_WORD_WRAP, FontBLF::buf_info, FontBufInfoBLF::cbuf, FontBufInfoBLF::fbuf, FontBLF::flags, and str.

Referenced by BKE_image_stamp_buf(), BLF_str_offset_to_glyph_bounds(), checker_board_text(), cursor_bitmap_from_text(), IMB_font_preview(), py_blf_draw_buffer(), and blender::seq::text_draw().

◆ blf_draw_buffer__end()

void blf_draw_buffer__end ( )

Definition at line 1043 of file blf.cc.

Referenced by BLF_draw_buffer().

◆ blf_draw_buffer__start()

void blf_draw_buffer__start ( FontBLF * font )

Definition at line 1024 of file blf.cc.

References FontBLF::buf_info, FontBufInfoBLF::col_char, FontBufInfoBLF::col_float, FontBufInfoBLF::col_init, FontBufInfoBLF::colorspace, copy_v4_v4(), IMB_colormanagement_scene_linear_to_colorspace_v3(), IMB_colormanagement_srgb_to_scene_linear_v3(), and rgba_float_to_uchar().

Referenced by BLF_draw_buffer().

◆ blf_draw_gpu__end()

void blf_draw_gpu__end ( const FontBLF * font )

static

Definition at line 578 of file blf.cc.

References BLF_ASPECT, BLF_ROTATION, FontBLF::flags, and GPU_matrix_pop().

Referenced by BLF_draw(), BLF_draw_mono(), and BLF_draw_svg_icon().

◆ blf_draw_gpu__start()

void blf_draw_gpu__start ( const FontBLF * font )

static

Definition at line 554 of file blf.cc.

References FontBLF::angle, FontBLF::aspect, BLF_ASPECT, BLF_ROTATION, FontBLF::flags, GPU_matrix_push(), GPU_matrix_rotate_2d(), GPU_matrix_scale_3fv(), GPU_matrix_translate_3f(), FontBLF::pos, and RAD2DEG.

Referenced by BLF_draw(), BLF_draw_mono(), and BLF_draw_svg_icon().

◆ BLF_draw_mono()

int BLF_draw_mono	(	int	fontid,
		const char *	str,
		const size_t	str_len,
		int	cwidth,
		int	tab_columns )

Definition at line 607 of file blf.cc.

References blf_draw_gpu__end(), blf_draw_gpu__start(), blf_font_draw_mono(), blf_get(), and str.

Referenced by text_font_draw(), text_font_draw_character(), text_font_draw_character_utf8(), and textview_draw_string().

◆ BLF_draw_svg_icon()

void BLF_draw_svg_icon	(	uint	icon_id,
		float	x,
		float	y,
		float	size,
		const float	color[4],
		float	outline_alpha,
		bool	multicolor,
		blender::FunctionRef< void(std::string &)>	edit_source_cb )

Definition at line 625 of file blf.cc.

References blf_draw_gpu__end(), blf_draw_gpu__start(), blf_draw_svg_icon(), global_font, size(), UNUSED_VARS, x, and y.

Referenced by icon_draw_icon(), and icon_draw_size().

◆ BLF_enable()

void BLF_enable	(	int	fontid,
		FontFlags	flag )

Definition at line 320 of file blf.cc.

References blf_get(), flag, and FontBLF::flags.

Referenced by BKE_image_stamp_buf(), blf_load_datafiles_dir(), BLF_load_default(), BLF_load_mono_default(), BLF_str_offset_to_glyph_bounds(), blender::seq::build_character_info(), draw_vertical_scale_indicators(), drw_text_cache_draw_ex(), ED_region_image_metadata_draw(), ED_region_info_draw_multiline(), file_draw_string_multiline(), blender::ed::space_node::frame_node_draw_label(), gizmo_axis_draw(), gizmo_ruler_draw(), knifetool_draw_angle(), knifetool_draw_visible_distances(), metadata_box_height_get(), metadata_draw_imbuf(), playanim_toscreen_ex(), py_blf_enable(), blender::ed::vse::sequencer_preview_draw_overlays(), blender::seq::text_draw(), blender::seq::text_effect_font_init(), text_info_row(), UI_fontstyle_draw_ex(), UI_fontstyle_draw_multiline_clipped_ex(), UI_fontstyle_draw_rotated(), UI_panel_category_draw_all(), ui_tooltip_create_with_data(), UI_view2d_text_cache_draw(), uiStyleInit(), and view3d_draw_region_info().

◆ BLF_exit()

void BLF_exit ( )

Definition at line 70 of file blf.cc.

References blf_font_exit(), blf_font_free(), BLF_MAX_FONT, global_font, and i.

Referenced by blender::tests::close_font(), multitestapp_free(), BlendfileLoadingBaseTest::TearDownTestCase(), WM_exit_ex(), and wm_main_playanim_intern().

◆ BLF_fixed_width()

float BLF_fixed_width ( int fontid )

For fixed width fonts only, returns the width of a character.

Definition at line 815 of file blf.cc.

References blf_font_fixed_width(), and blf_get().

Referenced by BLF_str_offset_to_glyph_bounds(), cursor_bitmap_from_text(), draw_text_main(), space_text_update_character_width(), blender::tests::TEST(), and textview_draw().

◆ blf_get()

FontBLF * blf_get ( int fontid )

static

Definition at line 53 of file blf.cc.

References BLF_MAX_FONT, and global_font.

Referenced by BLF_addref_id(), BLF_ascender(), BLF_aspect(), BLF_boundbox(), BLF_boundbox_foreach_glyph(), BLF_bounds_max(), BLF_buffer(), BLF_buffer_col(), BLF_buffer_state_pop(), BLF_buffer_state_push(), BLF_character_to_curves(), BLF_character_weight(), BLF_clipping(), BLF_color3ub(), BLF_color3ubv_alpha(), BLF_color4fv(), BLF_color4ub(), BLF_color4ubv(), BLF_default_weight(), BLF_descender(), BLF_disable(), BLF_display_name_from_id(), BLF_draw(), BLF_draw_buffer(), BLF_draw_mono(), BLF_enable(), BLF_fixed_width(), BLF_get_vfont_metrics(), BLF_glyph_advance(), BLF_has_glyph(), BLF_has_variable_weight(), BLF_height(), BLF_height_max(), BLF_is_builtin(), BLF_is_loaded_id(), BLF_metrics_attach(), BLF_position(), BLF_rotation(), BLF_shadow(), BLF_shadow_offset(), BLF_size(), BLF_state_print(), BLF_str_offset_from_cursor_position(), BLF_str_offset_to_cursor(), BLF_str_offset_to_glyph_bounds(), BLF_str_selection_boxes(), BLF_string_wrap(), BLF_unload_id(), BLF_width(), BLF_width_and_height(), BLF_width_max(), BLF_width_to_rstrlen(), BLF_width_to_strlen(), and BLF_wordwrap().

◆ BLF_get_vfont_metrics()

bool BLF_get_vfont_metrics	(	int	fontid,
		float *	ascend_ratio,
		float *	em_ratio,
		float *	scale )

Get the metrics needed for the initial sizing of text objects.

Definition at line 1103 of file blf.cc.

References blf_ensure_face(), blf_get(), BLF_VFONT_METRICS_ASCEND_RATIO_DEFAULT, BLF_VFONT_METRICS_EM_RATIO_DEFAULT, BLF_VFONT_METRICS_SCALE_DEFAULT, FontBLF::face, and float.

Referenced by BKE_vfontdata_from_freetypefont(), and blender::tests::TEST().

◆ BLF_glyph_advance()

int BLF_glyph_advance	(	int	fontid,
		const char *	str )

Returns offset for drawing next character in the string.

Definition at line 826 of file blf.cc.

References blf_font_glyph_advance(), blf_get(), and str.

Referenced by BLF_str_offset_to_glyph_bounds(), blender::seq::build_character_info(), and blender::tests::TEST().

◆ BLF_has_glyph()

bool BLF_has_glyph	(	int	fontid,
		unsigned int	unicode )

Check if font supports a particular glyph.

Definition at line 151 of file blf.cc.

References blf_get(), and blf_get_char_index().

Referenced by key_event_glyph_or_text(), and blender::tests::TEST().

◆ BLF_has_variable_weight()

bool BLF_has_variable_weight ( int fontid )

Returns: true if the font has a variable (multiple master) weight axis.

Definition at line 364 of file blf.cc.

References blf_get(), BLF_VARIATION_AXIS_WEIGHT, i, and FontBLF::variations.

Referenced by blender::tests::TEST(), and UI_update_text_styles().

◆ BLF_height()

float BLF_height	(	int	fontid,
		const char *	str,
		const size_t	str_len,
		ResultBLF *	r_info )

Definition at line 837 of file blf.cc.

References blf_font_height(), blf_get(), BLF_RESULT_CHECK_INIT, and str.

Referenced by BLF_str_offset_to_glyph_bounds(), clip_draw_dopesheet_channels(), draw_vertical_scale_indicators(), blender::ed::vse::label_rect_get(), loggerwindow_new(), blender::tests::TEST(), and UI_view2d_text_cache_draw().

◆ BLF_height_max()

int BLF_height_max ( int fontid )

Return dimensions of the font without any sample text.

Definition at line 850 of file blf.cc.

References blf_font_height_max(), and blf_get().

Referenced by BKE_image_stamp_buf(), BLF_str_offset_to_glyph_bounds(), cursor_bitmap_from_text(), draw_marker_texts(), blender::ed::space_node::frame_node_draw_label(), metadata_box_height_get(), metadata_draw_imbuf(), screen_draw_area_drag_tip(), blender::tests::TEST(), blender::seq::text_effect_calc_runtime(), UI_fontstyle_draw_ex(), UI_fontstyle_draw_multiline_clipped_ex(), UI_fontstyle_draw_simple_backdrop(), UI_fontstyle_height_max(), and ui_tooltip_create_with_data().

◆ BLF_init()

int BLF_init ( )

Definition at line 61 of file blf.cc.

References blf_font_init(), BLF_MAX_FONT, global_font, and i.

Referenced by main(), blender::tests::open_font(), BlendfileLoadingBaseTest::SetUpTestCase(), blender::tests::TEST(), WM_init(), and wm_main_playanim_intern().

◆ BLF_is_builtin()

bool BLF_is_builtin ( int fontid )

Is this font part of the default fonts in the fallback stack?

Definition at line 338 of file blf.cc.

References BLF_DEFAULT, blf_get(), and FontBLF::flags.

Referenced by BLF_str_offset_to_glyph_bounds(), blender::seq::build_character_info(), and blender::seq::text_draw().

◆ BLF_is_loaded()

bool BLF_is_loaded ( const char * filepath )

Definition at line 160 of file blf.cc.

References blf_search_by_filepath().

Referenced by blf_load_datafiles_dir(), and blender::tests::TEST().

◆ BLF_is_loaded_id()

bool BLF_is_loaded_id ( int fontid )

Definition at line 170 of file blf.cc.

References blf_get().

Referenced by BLF_default_set(), blender::seq::strip_load_font_file(), blender::seq::strip_load_font_mem(), blender::tests::TEST(), and blender::seq::text_effect_font_init().

◆ BLF_is_loaded_mem()

bool BLF_is_loaded_mem ( const char * name )

Definition at line 165 of file blf.cc.

References blf_search_by_mem_name(), and name.

◆ BLF_load()

int BLF_load ( const char * filepath )

Loads a font, or returns an already loaded font and increments its reference count.

Note that while loading fonts is thread-safe, most of font usage via BLF state modification functions is not. If you need to use fonts from multiple threads, use unique font instances for threaded parts, see BLF_load_unique.

Definition at line 175 of file blf.cc.

References BLF_load_unique(), blf_search_by_filepath(), global_font, i, and FontBLF::reference_count.

Referenced by blf_load_datafiles_dir(), blf_load_font_default(), IMB_font_preview(), blender::tests::open_font(), py_blf_load(), blender::tests::TEST(), and uiStyleInit().

◆ BLF_load_mem()

int BLF_load_mem	(	const char *	name,
		const uchar *	mem,
		int	mem_size )

Definition at line 225 of file blf.cc.

References BLF_load_mem_unique(), blf_search_by_mem_name(), i, and name.

◆ BLF_load_mem_unique()

int BLF_load_mem_unique	(	const char *	name,
		const uchar *	mem,
		int	mem_size )

Definition at line 234 of file blf.cc.

References blf_font_new_from_mem(), blf_search_available(), g_blf_load_mutex, global_font, i, lock, name, printf, and FontBLF::reference_count.

Referenced by BLF_load_mem().

◆ BLF_load_unique()

int BLF_load_unique ( const char * filepath )

Loads a font into a new font object.

Unlike BLF_load, it does not look whether a font with the same path or name is already loaded. Primary use case is when using BLF functions from a non-main thread.

Definition at line 188 of file blf.cc.

References blf_font_new_from_filepath(), blf_search_available(), BLI_exists(), g_blf_load_mutex, global_font, i, lock, printf, and FontBLF::reference_count.

Referenced by BLF_load(), blf_load_font_default(), blender::seq::strip_load_font_file(), and uiStyleInit().

◆ BLF_metrics_attach()

void BLF_metrics_attach	(	int	fontid,
		const unsigned char *	mem,
		int	mem_size )

Attach a file with metrics information from memory.

Definition at line 216 of file blf.cc.

References blf_font_attach_from_mem(), and blf_get().

◆ BLF_position()

void BLF_position	(	int	fontid,
		float	x,
		float	y,
		float	z )

Definition at line 388 of file blf.cc.

References FontBLF::aspect, BLF_ASPECT, blf_get(), FontBLF::flags, floorf, FontBLF::pos, round_fl_to_int(), x, y, and z().

Referenced by BKE_image_stamp_buf(), BLF_draw_default(), checker_board_text(), clip_draw_dopesheet_channels(), cursor_bitmap_from_text(), draw_marker_texts(), ED_image_draw_info(), ED_region_cache_draw_curfra_label(), ED_region_info_draw_multiline(), blender::ed::space_node::frame_node_draw_label(), gizmo_axis_draw(), gizmo_ruler_draw(), icon_draw_rect_input_text(), IMB_font_preview(), knifetool_draw_angle(), knifetool_draw_visible_distances(), loggerwindow_do_draw(), metadata_custom_draw_fields(), metadata_draw_imbuf(), playanim_toscreen_ex(), py_blf_position(), radial_control_paint_cursor(), region_draw_status_text(), screen_draw_area_drag_tip(), slider_draw(), blender::seq::text_draw(), text_font_draw(), text_font_draw_character(), text_font_draw_character_utf8(), text_info_row(), textview_draw_string(), UI_fontstyle_draw_ex(), UI_fontstyle_draw_multiline_clipped_ex(), UI_fontstyle_draw_rotated(), UI_fontstyle_draw_simple(), UI_fontstyle_draw_simple_backdrop(), UI_panel_category_draw_all(), vicon_rgb_text_draw(), blender::ed::object::voxel_size_edit_draw(), and widget_draw_text().

◆ BLF_reset_fonts()

void BLF_reset_fonts ( )

Close any user-loaded fonts that are not used by the Interface. Call when loading new blend files so that the old fonts are not still taking resources.

Definition at line 83 of file blf.cc.

References BLF_DEFAULT, BLF_default(), blf_font_free(), BLF_MAX_FONT, blf_mono_font, blf_mono_font_render, ELEM, FontBLF::flags, global_font, and i.

Referenced by WM_file_read(), and wm_homefile_read_exec().

◆ BLF_rotation()

void BLF_rotation	(	int	fontid,
		float	angle )

By default, rotation and clipping are disable and have to be enable/disable using BLF_enable/disable.

Definition at line 903 of file blf.cc.

References angle(), FontBLF::angle, and blf_get().

Referenced by BLF_str_offset_to_glyph_bounds(), gizmo_ruler_draw(), knifetool_draw_angle(), knifetool_draw_visible_distances(), py_blf_rotation(), slider_draw(), UI_fontstyle_draw_rotated(), and UI_panel_category_draw_all().

◆ blf_search_available()

int blf_search_available ( )

static

Definition at line 140 of file blf.cc.

References BLF_MAX_FONT, global_font, and i.

Referenced by BLF_load_mem_unique(), and BLF_load_unique().

◆ blf_search_by_filepath()

int blf_search_by_filepath ( const char * filepath )

static

Definition at line 124 of file blf.cc.

References BLF_MAX_FONT, BLI_path_cmp, FontBLF::filepath, g_blf_load_mutex, global_font, i, and lock.

Referenced by BLF_is_loaded(), and BLF_load().

◆ blf_search_by_mem_name()

int blf_search_by_mem_name ( const char * mem_name )

static

Definition at line 108 of file blf.cc.

References BLF_MAX_FONT, g_blf_load_mutex, global_font, i, lock, FontBLF::mem_name, and STREQ.

Referenced by BLF_is_loaded_mem(), and BLF_load_mem().

◆ BLF_shadow()

void BLF_shadow	(	int	fontid,
		FontShadowType	type,
		const float	rgba[4] = nullptr )

Note that shadow needs to be enabled with BLF_enable.

Definition at line 934 of file blf.cc.

References blf_get(), rgba_float_to_uchar(), FontBLF::shadow, and FontBLF::shadow_color.

Referenced by BLF_str_offset_to_glyph_bounds(), draw_vertical_scale_indicators(), blender::ed::transform::drawAutoKeyWarning(), drw_text_cache_draw_ex(), py_blf_shadow(), blender::ed::vse::sequencer_preview_draw_overlays(), text_info_row(), UI_fontstyle_draw_ex(), UI_fontstyle_draw_multiline_clipped_ex(), UI_fontstyle_draw_rotated(), UI_panel_category_draw_all(), and view3d_draw_region_info().

◆ BLF_shadow_offset()

void BLF_shadow_offset	(	int	fontid,
		int	x,
		int	y )

Set the offset for shadow text, this is the current cursor position plus this offset, don't need call BLF_position before this function, the current position is calculate only on BLF_draw, so it's safe call this whenever you like.

Definition at line 946 of file blf.cc.

References blf_get(), FontBLF::shadow_x, FontBLF::shadow_y, x, and y.

Referenced by BLF_str_offset_to_glyph_bounds(), draw_vertical_scale_indicators(), drw_text_cache_draw_ex(), py_blf_shadow_offset(), blender::ed::vse::sequencer_preview_draw_overlays(), text_info_row(), UI_fontstyle_draw_ex(), UI_fontstyle_draw_multiline_clipped_ex(), UI_fontstyle_draw_rotated(), UI_panel_category_draw_all(), and view3d_draw_region_info().

◆ BLF_size()

void BLF_size	(	int	fontid,
		float	size )

Definition at line 443 of file blf.cc.

References blf_font_size(), blf_get(), and size().

◆ BLF_state_print()

void BLF_state_print ( int fontid )

Definition at line 1161 of file blf.cc.

References BLF_ASPECT, blf_get(), BLF_ROTATION, printf, and UNPACK3.

◆ BLF_str_offset_from_cursor_position()

size_t BLF_str_offset_from_cursor_position	(	int	fontid,
		const char *	str,
		size_t	str_len,
		int	location_x )

Get the byte offset within a string, selected by mouse at a horizontal location.

Definition at line 680 of file blf.cc.

References blf_get(), blf_str_offset_from_cursor_position(), and str.

Referenced by ui_textedit_set_cursor_pos().

◆ BLF_str_offset_to_cursor()

int BLF_str_offset_to_cursor	(	int	fontid,
		const char *	str,
		size_t	str_len,
		size_t	str_offset,
		int	cursor_width )

Return left edge of text cursor (caret), given a character offset and cursor width.

Definition at line 705 of file blf.cc.

References blf_get(), blf_str_offset_to_cursor(), and str.

Referenced by BLF_str_offset_to_glyph_bounds(), and widget_draw_text().

◆ BLF_str_offset_to_glyph_bounds()

bool BLF_str_offset_to_glyph_bounds	(	int	fontid,
		const char *	str,
		size_t	str_offset,
		rcti *	r_glyph_bounds )

Definition at line 692 of file blf.cc.

References blf_get(), blf_str_offset_to_glyph_bounds(), and str.

◆ BLF_str_selection_boxes()

blender::Vector< blender::Bounds< int > > BLF_str_selection_boxes	(	int	fontid,
		const char *	str,
		size_t	str_len,
		size_t	sel_start,
		size_t	sel_length )

Return bounds of selection boxes. There is just one normally but there could be more for multi-line and when containing text of differing directions.

Definition at line 718 of file blf.cc.

References blf_get(), blf_str_selection_boxes(), and str.

Referenced by BLF_str_offset_to_glyph_bounds(), and widget_draw_text().

◆ BLF_string_wrap()

blender::Vector< blender::StringRef > BLF_string_wrap	(	int	fontid,
		blender::StringRef	str,
		const int	max_pixel_width,
		BLFWrapMode	mode )

◆ BLF_svg_icon_bitmap()

blender::Array< uchar > BLF_svg_icon_bitmap	(	uint	icon_id,
		float	size,
		int *	r_width,
		int *	r_height,
		bool	multicolor,
		blender::FunctionRef< void(std::string &)>	edit_source_cb )