source/blender/blenfont/BLF_api.h

   1 /*
   2  * ***** BEGIN GPL LICENSE BLOCK *****
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software Foundation,
  16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  *
  18  * The Original Code is Copyright (C) 2009 Blender Foundation.
  19  * All rights reserved.
  20  *
  21  *
  22  * Contributor(s): Blender Foundation
  23  *
  24  * ***** END GPL LICENSE BLOCK *****
  25  */
  26
  27 /** \file blender/blenfont/BLF_api.h
  28  *  \ingroup blf
  29  */
  30
  31
  32 #ifndef __BLF_API_H__
  33 #define __BLF_API_H__
  34
  35 #include "BLI_compiler_attrs.h"
  36 #include "BLI_sys_types.h"
  37
  38 /* enable this only if needed (unused circa 2016) */
  39 #define BLF_BLUR_ENABLE 0
  40
  41 struct rctf;
  42 struct ColorManagedDisplay;
  43 struct ResultBLF;
  44
  45 int BLF_init(void);
  46 void BLF_exit(void);
  47 void BLF_default_dpi(int dpi);
  48 void BLF_default_set(int fontid);
  49 int BLF_default(void); /* get default font ID so we can pass it to other functions */
  50 void BLF_batch_reset(void); /* call when changing opengl context. */
  51
  52 void BLF_cache_clear(void);
  53
  54 int BLF_load(const char *name) ATTR_NONNULL();
  55 int BLF_load_mem(const char *name, const unsigned char *mem, int mem_size) ATTR_NONNULL();
  56
  57 int BLF_load_unique(const char *name) ATTR_NONNULL();
  58 int BLF_load_mem_unique(const char *name, const unsigned char *mem, int mem_size) ATTR_NONNULL();
  59
  60 void BLF_unload(const char *name) ATTR_NONNULL();
  61 void BLF_unload_id(int fontid);
  62
  63 /* Attach a file with metrics information from memory. */
  64 void BLF_metrics_attach(int fontid, unsigned char *mem, int mem_size);
  65
  66 void BLF_aspect(int fontid, float x, float y, float z);
  67 void BLF_position(int fontid, float x, float y, float z);
  68 void BLF_size(int fontid, int size, int dpi);
  69
  70 /* goal: small but useful color API */
  71 void BLF_color4ubv(int fontid, const unsigned char rgba[4]);
  72 void BLF_color3ubv(int fontid, const unsigned char rgb[3]);
  73 void BLF_color3ubv_alpha(int fontid, const unsigned char rgb[3], unsigned char alpha);
  74 void BLF_color3ub(int fontid, unsigned char r, unsigned char g, unsigned char b);
  75 void BLF_color4f(int fontid, float r, float g, float b, float a);
  76 void BLF_color4fv(int fontid, const float rgba[4]);
  77 void BLF_color3f(int fontid, float r, float g, float b);
  78 void BLF_color3fv_alpha(int fontid, const float rgb[3], float alpha);
  79 /* also available: UI_FontThemeColor(fontid, colorid) */
  80
  81 /* Set a 4x4 matrix to be multiplied before draw the text.
  82  * Remember that you need call BLF_enable(BLF_MATRIX)
  83  * to enable this.
  84  *
  85  * The order of the matrix is like GL:
  86  *
  87  *  | m[0]  m[4]  m[8]  m[12] |
  88  *  | m[1]  m[5]  m[9]  m[13] |
  89  *  | m[2]  m[6]  m[10] m[14] |
  90  *  | m[3]  m[7]  m[11] m[15] |
  91  *
  92  */
  93 void BLF_matrix(int fontid, const float m[16]);
  94
  95 /* Batch drawcalls together as long as
  96  * the modelview matrix and the font remain unchanged. */
  97 void BLF_batch_draw_begin(void);
  98 void BLF_batch_draw_flush(void);
  99 void BLF_batch_draw_end(void);
 100
 101 /* Draw the string using the default font, size and dpi. */
 102 void BLF_draw_default(float x, float y, float z, const char *str, size_t len) ATTR_NONNULL();
 103 void BLF_draw_default_ascii(float x, float y, float z, const char *str, size_t len) ATTR_NONNULL();
 104
 105 /* Set size and DPI, and return default font ID. */
 106 int BLF_set_default(void);
 107
 108 /* Draw the string using the current font. */
 109 void BLF_draw_ex(int fontid, const char *str, size_t len, struct ResultBLF *r_info) ATTR_NONNULL(2);
 110 void BLF_draw(int fontid, const char *str, size_t len) ATTR_NONNULL(2);
 111 void BLF_draw_ascii_ex(int fontid, const char *str, size_t len, struct ResultBLF *r_info) ATTR_NONNULL(2);
 112 void BLF_draw_ascii(int fontid, const char *str, size_t len) ATTR_NONNULL(2);
 113 int BLF_draw_mono(int fontid, const char *str, size_t len, int cwidth) ATTR_NONNULL(2);
 114
 115 /* Get the string byte offset that fits within a given width */
 116 size_t BLF_width_to_strlen(int fontid, const char *str, size_t len, float width, float *r_width) ATTR_NONNULL(2);
 117 /* Same as BLF_width_to_strlen but search from the string end */
 118 size_t BLF_width_to_rstrlen(int fontid, const char *str, size_t len, float width, float *r_width) ATTR_NONNULL(2);
 119
 120 /* This function return the bounding box of the string
 121  * and are not multiplied by the aspect.
 122  */
 123 void BLF_boundbox_ex(int fontid, const char *str, size_t len, struct rctf *box, struct ResultBLF *r_info) ATTR_NONNULL(2);
 124 void BLF_boundbox(int fontid, const char *str, size_t len, struct rctf *box) ATTR_NONNULL();
 125
 126 /* The next both function return the width and height
 127  * of the string, using the current font and both value
 128  * are multiplied by the aspect of the font.
 129  */
 130 float BLF_width_ex(int fontid, const char *str, size_t len, struct ResultBLF *r_info) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(2);
 131 float BLF_width(int fontid, const char *str, size_t len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
 132 float BLF_height_ex(int fontid, const char *str, size_t len, struct ResultBLF *r_info) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(2);
 133 float BLF_height(int fontid, const char *str, size_t len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
 134
 135 /* Return dimensions of the font without any sample text. */
 136 int BLF_height_max(int fontid) ATTR_WARN_UNUSED_RESULT;
 137 float BLF_width_max(int fontid) ATTR_WARN_UNUSED_RESULT;
 138 float BLF_descender(int fontid) ATTR_WARN_UNUSED_RESULT;
 139 float BLF_ascender(int fontid) ATTR_WARN_UNUSED_RESULT;
 140
 141 /* The following function return the width and height of the string, but
 142  * just in one call, so avoid extra freetype2 stuff.
 143  */
 144 void BLF_width_and_height(int fontid, const char *str, size_t len, float *r_width, float *r_height) ATTR_NONNULL();
 145
 146 /* For fixed width fonts only, returns the width of a
 147  * character.
 148  */
 149 float BLF_fixed_width(int fontid) ATTR_WARN_UNUSED_RESULT;
 150
 151 /* By default, rotation and clipping are disable and
 152  * have to be enable/disable using BLF_enable/disable.
 153  */
 154 void BLF_rotation(int fontid, float angle);
 155 void BLF_clipping(int fontid, float xmin, float ymin, float xmax, float ymax);
 156 void BLF_wordwrap(int fontid, int wrap_width);
 157
 158 #if BLF_BLUR_ENABLE
 159 void BLF_blur(int fontid, int size);
 160 #endif
 161
 162 void BLF_enable(int fontid, int option);
 163 void BLF_disable(int fontid, int option);
 164
 165 /* Shadow options, level is the blur level, can be 3, 5 or 0 and
 166  * the other argument are the rgba color.
 167  * Take care that shadow need to be enable using BLF_enable!!!
 168  */
 169 void BLF_shadow(int fontid, int level, const float rgba[4]) ATTR_NONNULL(3);
 170
 171 /* Set the offset for shadow text, this is the current cursor
 172  * position plus this offset, don't need call BLF_position before
 173  * this function, the current position is calculate only on
 174  * BLF_draw, so it's safe call this whenever you like.
 175  */
 176 void BLF_shadow_offset(int fontid, int x, int y);
 177
 178 /* Set the buffer, size and number of channels to draw, one thing to take care is call
 179  * this function with NULL pointer when we finish, for example:
 180  *
 181  *     BLF_buffer(my_fbuf, my_cbuf, 100, 100, 4, true, NULL);
 182  *
 183  *     ... set color, position and draw ...
 184  *
 185  *     BLF_buffer(NULL, NULL, NULL, 0, 0, false, NULL);
 186  */
 187 void BLF_buffer(int fontid, float *fbuf, unsigned char *cbuf, int w, int h, int nch, struct ColorManagedDisplay *display);
 188
 189 /* Set the color to be used for text. */
 190 void BLF_buffer_col(int fontid, const float rgba[4]) ATTR_NONNULL(2);
 191
 192 /* Draw the string into the buffer, this function draw in both buffer, float and unsigned char _BUT_
 193  * it's not necessary set both buffer, NULL is valid here.
 194  */
 195 void BLF_draw_buffer_ex(int fontid, const char *str, size_t len, struct ResultBLF *r_info) ATTR_NONNULL(2);
 196 void BLF_draw_buffer(int fontid, const char *str, size_t len) ATTR_NONNULL(2);
 197
 198 /* Add a path to the font dir paths. */
 199 void BLF_dir_add(const char *path) ATTR_NONNULL();
 200
 201 /* Remove a path from the font dir paths. */
 202 void BLF_dir_rem(const char *path) ATTR_NONNULL();
 203
 204 /* Return an array with all the font dir (this can be used for filesel) */
 205 char **BLF_dir_get(int *ndir) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
 206
 207 /* Free the data return by BLF_dir_get. */
 208 void BLF_dir_free(char **dirs, int count) ATTR_NONNULL();
 209
 210 /* blf_thumbs.c */
 211 void BLF_thumb_preview(
 212         const char *filename, const char **draw_str, const unsigned char draw_str_lines,
 213         const float font_color[4], const int font_size,
 214         unsigned char *buf, int w, int h, int channels) ATTR_NONNULL();
 215
 216 /* blf_font_i18.c */
 217 unsigned char *BLF_get_unifont(int *unifont_size);
 218 void           BLF_free_unifont(void);
 219 unsigned char *BLF_get_unifont_mono(int *unifont_size);
 220 void           BLF_free_unifont_mono(void);
 221
 222 #ifdef DEBUG
 223 void BLF_state_print(int fontid);
 224 #endif
 225
 226 /* font->flags. */
 227 #define BLF_ROTATION         (1 << 0)
 228 #define BLF_CLIPPING         (1 << 1)
 229 #define BLF_SHADOW           (1 << 2)
 230 #define BLF_KERNING_DEFAULT  (1 << 3)
 231 #define BLF_MATRIX           (1 << 4)
 232 #define BLF_ASPECT           (1 << 5)
 233 #define BLF_WORD_WRAP        (1 << 6)
 234 #define BLF_MONOCHROME       (1 << 7)  /* no-AA */
 235 #define BLF_HINTING_NONE     (1 << 8)
 236 #define BLF_HINTING_SLIGHT   (1 << 9)
 237 #define BLF_HINTING_FULL     (1 << 10)
 238
 239 #define BLF_DRAW_STR_DUMMY_MAX 1024
 240
 241 /* XXX, bad design */
 242 extern int blf_mono_font;
 243 extern int blf_mono_font_render; /* don't mess drawing with render threads. */
 244
 245 /**
 246  * Result of drawing/evaluating the string
 247  */
 248 struct ResultBLF {
 249         /**
 250          * Number of lines drawn when #BLF_WORD_WRAP is enabled (both wrapped and `\n` newline).
 251          */
 252         int lines;
 253         /**
 254          * The 'cursor' position on completion (ignoring character boundbox).
 255          */
 256         int width;
 257 };
 258
 259 #endif /* __BLF_API_H__ */