diff options
author | Campbell Barton <ideasman42@gmail.com> | 2020-06-09 08:17:13 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2020-06-09 08:19:31 +0300 |
commit | 0c4bc09092de6a948a6cc46da3b2f1fcc31ed8f7 (patch) | |
tree | d40f298f1678bd243765aec75af123dd5c6688b8 /source/blender/blenkernel | |
parent | 70a27d0a638665007b45e5d80d2f758d25ed246b (diff) |
Docs: comment text scale behavior
Avoid misunderstanding that caused T77609.
Diffstat (limited to 'source/blender/blenkernel')
-rw-r--r-- | source/blender/blenkernel/intern/font.c | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/source/blender/blenkernel/intern/font.c b/source/blender/blenkernel/intern/font.c index 34bb328bde0..5f59666a28a 100644 --- a/source/blender/blenkernel/intern/font.c +++ b/source/blender/blenkernel/intern/font.c @@ -673,6 +673,16 @@ struct TempLineInfo { int wspace_nr; /* number of whitespaces of line */ }; +/* -------------------------------------------------------------------- */ +/** \name VFont Scale Overflow + * + * Scale the font to fit inside #TextBox bounds. + * + * - Scale horizontally when #TextBox.h is zero, + * otherwise scale vertically, allowing the text to wrap horizontally. + * - Never increase scale to fit, only ever scale on overflow. + * \{ */ + typedef struct VFontToCurveIter { int iteraction; float scale_to_fit; @@ -694,6 +704,8 @@ enum { #define FONT_TO_CURVE_SCALE_ITERATIONS 20 #define FONT_TO_CURVE_SCALE_THRESHOLD 0.0001f +/** \} */ + /** * Font metric values explained: * |