Blender V5.3
blf_internal.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2009 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include "BLI_array.hh"
12#include "BLI_bounds_types.hh"
13#include "BLI_function_ref.hh"
14#include "BLI_string_ref.hh"
15#include "BLI_vector.hh"
16
17#include "DNA_listBase.h"
18
19namespace blender {
20
21struct FontBLF;
22struct GlyphBLF;
23struct GlyphCacheBLF;
24struct Nurb;
25struct ResultBLF;
26struct rcti;
27struct rctf;
28enum class BLFWrapMode;
29
34#define BLF_MAX_FONT 64
35
39#define BLF_SUBPIXEL_POSITION
40
44#define BLF_SUBPIXEL_AA
45
47#define BLF_CACHE_MAX_FACES 8
49#define BLF_CACHE_MAX_SIZES 16
51#define BLF_CACHE_BYTES 0x100000
52
57#define BLF_ICON_OFFSET 0x100000L
58
65#define BLF_DPI 72
66
68extern FontBLF *global_font[BLF_MAX_FONT];
69
70void blf_batch_draw_begin(FontBLF *font);
71void blf_batch_draw();
72
77char *blf_dir_metrics_search(const char *filepath);
78
79int blf_font_init();
80void blf_font_exit();
81
85uint blf_get_char_index(FontBLF *font, uint charcode);
86
90bool blf_ensure_face(FontBLF *font);
91void blf_ensure_size(FontBLF *font);
92
93void blf_draw_buffer__start(FontBLF *font);
95
96FontBLF *blf_font_new_from_filepath(const char *filepath);
97FontBLF *blf_font_new_from_mem(const char *mem_name, const unsigned char *mem, size_t mem_size);
98void blf_font_attach_from_mem(FontBLF *font, const unsigned char *mem, size_t mem_size);
99
103bool blf_font_size(FontBLF *font, float size);
104
105void blf_font_draw(FontBLF *font, const char *str, size_t str_len, ResultBLF *r_info);
106void blf_font_draw__wrap(FontBLF *font, const char *str, size_t str_len, ResultBLF *r_info);
107
111void blf_draw_svg_icon(FontBLF *font,
112 uint icon_id,
113 float size,
114 const float color[4] = nullptr,
115 float outline_alpha = 1.0f,
116 bool multicolor = false,
117 FunctionRef<void(std::string &)> edit_source_cb = nullptr);
118
119Array<uchar> blf_svg_icon_bitmap(FontBLF *font,
120 uint icon_id,
121 float size,
122 int *r_width,
123 int *r_height,
124 bool multicolor = false,
125 FunctionRef<void(std::string &)> edit_source_cb = nullptr);
126
127Vector<StringRef> blf_font_string_wrap(FontBLF *font,
128 StringRef str,
129 int max_pixel_width,
130 BLFWrapMode mode);
131
136 FontBLF *font, const char *str, size_t str_len, int char_width, int tab_columns);
137void blf_font_draw_buffer(FontBLF *font, const char *str, size_t str_len, ResultBLF *r_info);
138void blf_font_draw_buffer__wrap(FontBLF *font, const char *str, size_t str_len, ResultBLF *r_info);
140 FontBLF *font, const char *str, size_t str_len, int width, int *r_width);
142 FontBLF *font, const char *str, size_t str_len, int width, int *r_width);
144 FontBLF *font, const char *str, size_t str_len, rcti *r_box, ResultBLF *r_info);
146 FontBLF *font, const char *str, size_t str_len, rcti *r_box, ResultBLF *r_info);
147void blf_font_width_and_height(FontBLF *font,
148 const char *str,
149 size_t str_len,
150 float *r_width,
151 float *r_height,
152 ResultBLF *r_info);
153float blf_font_width(FontBLF *font, const char *str, size_t str_len, ResultBLF *r_info);
154float blf_font_height(FontBLF *font, const char *str, size_t str_len, ResultBLF *r_info);
155float blf_font_fixed_width(FontBLF *font);
156int blf_font_glyph_advance(FontBLF *font, const char *str);
157int blf_font_height_max(FontBLF *font);
158int blf_font_width_max(FontBLF *font);
159int blf_font_descender(FontBLF *font);
160int blf_font_ascender(FontBLF *font);
161bool blf_font_bounds_max(FontBLF *font, rctf *r_bounds);
162
163char *blf_display_name(FontBLF *font);
164
166 FontBLF *font,
167 const char *str,
168 size_t str_len,
169 bool (*user_fn)(const char *str, size_t str_step_ofs, const rcti *bounds, void *user_data),
170 void *user_data);
171
173 FontBLF *font,
174 const char *str,
175 size_t str_len,
176 FunctionRef<void(int index, size_t byte_offset, int byte_len, int advance_x)> callback);
177
179 const char *str,
180 size_t str_len,
181 int location_x);
182
184 const char *str,
185 size_t str_offset,
186 rcti *r_glyph_bounds);
187
189 FontBLF *font, const char *str, size_t str_len, size_t sel_start, size_t sel_length);
190
192 FontBLF *font, const char *str, size_t str_len, size_t str_offset, int cursor_width);
193
194void blf_font_free(FontBLF *font);
195
199
203GlyphBLF *blf_glyph_ensure(FontBLF *font, GlyphCacheBLF *gc, uint charcode, uint8_t subpixel = 0);
204
205#ifdef BLF_SUBPIXEL_AA
207#endif
208
210 uint icon_id,
211 bool color = false,
212 FunctionRef<void(std::string &)> edit_source_cb = nullptr);
213
214/* blf_glyph.cc */
215void blf_glyph_draw(FontBLF *font, GlyphCacheBLF *gc, GlyphBLF *g, int x, int y);
216
217#ifdef FT_FREETYPE_H
218FT_UInt blf_glyph_index_from_charcode(FontBLF **font, const uint charcode);
219FT_GlyphSlot blf_glyph_render_outline(FontBLF *settings_font,
220 FontBLF *glyph_font,
221 FT_UInt glyph_index,
222 uint charcode,
223 int fixed_width);
224#endif
225
226/* blf_glyph_curves.cc */
227
233 unsigned int unicode,
234 ListBaseT<Nurb> *nurbsbase,
235 const float scale,
236 bool use_fallback,
237 float *r_advance,
238 rctf *r_bounds);
239
240} // namespace blender
241
242#ifdef WIN32
243/* `blf_font_win32_compat.cc` */
244
245# ifdef FT_FREETYPE_H
246extern FT_Error FT_New_Face__win32_compat(FT_Library library,
247 const char *pathname,
248 FT_Long face_index,
249 FT_Face *aface);
250# endif
251#endif
These structs are the foundation for all linked lists in the library system.
#define BLF_MAX_FONT
static DBVT_INLINE btScalar size(const btDbvtVolume &a)
Definition btDbvt.cpp:52
#define str(s)
float3x3 scale(float3x3 mat, float2 scale)
BMesh Iterators.
int blf_font_height_max(FontBLF *font)
Definition blf_font.cc:1737
bool blf_character_to_curves(FontBLF *font, uint unicode, ListBaseT< Nurb > *nurbsbase, const float scale, bool use_fallback, float *r_advance, rctf *r_bounds)
void blf_font_width_and_height(FontBLF *font, const char *str, const size_t str_len, float *r_width, float *r_height, ResultBLF *r_info)
Definition blf_font.cc:1126
bool blf_ensure_face(FontBLF *font)
Definition blf_font.cc:2087
unsigned int uint
Definition BKE_text.h:55
FT_GlyphSlot blf_glyph_render_outline(FontBLF *settings_font, FontBLF *glyph_font, FT_UInt glyph_index, uint charcode, int fixed_width)
void blf_glyph_cache_release(FontBLF *font)
Definition blf_glyph.cc:145
void blf_font_draw_buffer__wrap(FontBLF *font, const char *str, const size_t str_len, ResultBLF *r_info)
Definition blf_font.cc:1678
char * blf_dir_metrics_search(const char *filepath)
Definition blf_dir.cc:28
uint blf_get_char_index(FontBLF *font, const uint charcode)
Definition blf_font.cc:155
int blf_font_draw_mono(FontBLF *font, const char *str, const size_t str_len, const int char_width, const int tab_columns)
Definition blf_font.cc:632
float blf_font_fixed_width(FontBLF *font)
Definition blf_font.cc:1197
void blf_ensure_size(FontBLF *font)
Definition blf_font.cc:2310
Vector< Bounds< int > > blf_str_selection_boxes(FontBLF *font, const char *str, size_t str_len, size_t sel_start, size_t sel_length)
Definition blf_font.cc:1415
void blf_font_free(FontBLF *font)
Definition blf_font.cc:2277
void blf_glyph_draw(FontBLF *font, GlyphCacheBLF *gc, GlyphBLF *g, const int x, const int y)
void blf_font_boundbox(FontBLF *font, const char *str, const size_t str_len, rcti *r_box, ResultBLF *r_info)
Definition blf_font.cc:1118
void blf_font_boundbox__wrap(FontBLF *font, const char *str, const size_t str_len, rcti *r_box, ResultBLF *r_info)
Definition blf_font.cc:1643
float blf_font_height(FontBLF *font, const char *str, const size_t str_len, ResultBLF *r_info)
Definition blf_font.cc:1176
void blf_font_info_foreach_glyph(FontBLF *font, const char *str, size_t str_len, FunctionRef< void(int index, size_t byte_offset, int byte_len, int advance_x)> callback)
Definition blf_font.cc:1260
void blf_str_offset_to_glyph_bounds(FontBLF *font, const char *str, size_t str_offset, rcti *r_glyph_bounds)
Definition blf_font.cc:1357
Vector< StringRef > blf_font_string_wrap(FontBLF *font, StringRef str, int max_pixel_width, BLFWrapMode mode)
Definition blf_font.cc:1706
size_t blf_font_width_to_strlen(FontBLF *font, const char *str, const size_t str_len, int width, int *r_width)
Definition blf_font.cc:981
void blf_draw_buffer__end()
Definition blf.cc:1085
void blf_font_draw_buffer(FontBLF *font, const char *str, const size_t str_len, ResultBLF *r_info)
Definition blf_font.cc:930
FontBLF * blf_font_new_from_mem(const char *mem_name, const uchar *mem, const size_t mem_size)
Definition blf_font.cc:2260
GlyphCacheBLF * blf_glyph_cache_acquire(FontBLF *font)
Definition blf_glyph.cc:132
int blf_font_descender(FontBLF *font)
Definition blf_font.cc:1755
bool blf_font_bounds_max(FontBLF *font, rctf *r_bounds)
Definition blf_font.cc:1769
int blf_font_glyph_advance(FontBLF *font, const char *str)
Definition blf_font.cc:1205
int blf_str_offset_to_cursor(FontBLF *font, const char *str, const size_t str_len, const size_t str_offset, const int cursor_width)
Definition blf_font.cc:1370
FT_UInt blf_glyph_index_from_charcode(FontBLF **font, const uint charcode)
Definition blf_glyph.cc:795
FontBLF * blf_font_new_from_filepath(const char *filepath)
Definition blf_font.cc:2255
unsigned char uint8_t
Definition BKE_text.h:79
void blf_font_draw__wrap(FontBLF *font, const char *str, const size_t str_len, ResultBLF *r_info)
Definition blf_font.cc:1617
int blf_font_init()
Definition blf_font.cc:1796
GlyphBLF * blf_glyph_ensure(FontBLF *font, GlyphCacheBLF *gc, const uint charcode, uint8_t subpixel)
GlyphBLF * blf_glyph_ensure_icon(GlyphCacheBLF *gc, const uint icon_id, bool color, FunctionRef< void(std::string &)> edit_source_cb)
void blf_font_draw(FontBLF *font, const char *str, const size_t str_len, ResultBLF *r_info)
Definition blf_font.cc:625
void blf_font_boundbox_foreach_glyph(FontBLF *font, const char *str, const size_t str_len, BLF_GlyphBoundsFn user_fn, void *user_data)
Definition blf_font.cc:1222
size_t blf_str_offset_from_cursor_position(FontBLF *font, const char *str, size_t str_len, int location_x)
Definition blf_font.cc:1307
FontBLF * global_font[BLF_MAX_FONT]
Definition blf.cc:46
int blf_font_width_max(FontBLF *font)
Definition blf_font.cc:1750
void blf_draw_svg_icon(FontBLF *font, const uint icon_id, const float size, const float color[4], const float outline_alpha, const bool multicolor, FunctionRef< void(std::string &)> edit_source_cb)
Definition blf_font.cc:671
signed int int32_t
Definition BKE_text.h:78
Array< uchar > blf_svg_icon_bitmap(FontBLF *font, const uint icon_id, const float size, int *r_width, int *r_height, const bool multicolor, FunctionRef< void(std::string &)> edit_source_cb)
Definition blf_font.cc:713
size_t blf_font_width_to_rstrlen(FontBLF *font, const char *str, const size_t str_len, int width, int *r_width)
Definition blf_font.cc:1010
void blf_batch_draw_begin(FontBLF *font)
Definition blf_font.cc:207
bool blf_font_size(FontBLF *font, float size)
Definition blf_font.cc:2332
void blf_glyph_cache_clear(FontBLF *font)
Definition blf_glyph.cc:161
float blf_font_width(FontBLF *font, const char *str, const size_t str_len, ResultBLF *r_info)
Definition blf_font.cc:1155
void blf_draw_buffer__start(FontBLF *font)
Definition blf.cc:1066
void blf_font_attach_from_mem(FontBLF *font, const uchar *mem, const size_t mem_size)
Definition blf_font.cc:2265
void blf_batch_draw()
Definition blf_font.cc:307
GlyphBLF * blf_glyph_ensure_subpixel(FontBLF *font, GlyphCacheBLF *gc, GlyphBLF *g, int32_t pen_x)
void blf_font_exit()
Definition blf_font.cc:1817
int blf_font_ascender(FontBLF *font)
Definition blf_font.cc:1762
char * blf_display_name(FontBLF *font)
Definition blf_font.cc:1782