Docs: comment text scale behavior

Avoid misunderstanding that caused T77609.
This commit is contained in:
Campbell Barton
2020-06-09 15:17:13 +10:00
parent 70a27d0a63
commit 0c4bc09092

View File

@@ -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:
*