* include/freetype/freetype.h: Clarify `FT_Size` life cycle.
This commit is contained in:
parent
054782c48e
commit
99a940f84a
|
@ -526,9 +526,11 @@ FT_BEGIN_HEADER
|
||||||
* functions like @FT_Load_Glyph to determine the scaling transformation
|
* functions like @FT_Load_Glyph to determine the scaling transformation
|
||||||
* that in turn is used to load and hint glyphs and metrics.
|
* that in turn is used to load and hint glyphs and metrics.
|
||||||
*
|
*
|
||||||
* You can use @FT_Set_Char_Size, @FT_Set_Pixel_Sizes, @FT_Request_Size
|
* A newly created `FT_Size` object contains only meaningless zero values.
|
||||||
|
* You must use @FT_Set_Char_Size, @FT_Set_Pixel_Sizes, @FT_Request_Size
|
||||||
* or even @FT_Select_Size to change the content (i.e., the scaling
|
* or even @FT_Select_Size to change the content (i.e., the scaling
|
||||||
* values) of the active `FT_Size`.
|
* values) of the active `FT_Size`. Otherwise, the scaling and hinting
|
||||||
|
* will not be performed.
|
||||||
*
|
*
|
||||||
* You can use @FT_New_Size to create additional size objects for a given
|
* You can use @FT_New_Size to create additional size objects for a given
|
||||||
* @FT_Face, but they won't be used by other functions until you activate
|
* @FT_Face, but they won't be used by other functions until you activate
|
||||||
|
@ -2828,10 +2830,9 @@ FT_BEGIN_HEADER
|
||||||
*
|
*
|
||||||
* @note:
|
* @note:
|
||||||
* For proper scaling and hinting, the active @FT_Size object owned by
|
* For proper scaling and hinting, the active @FT_Size object owned by
|
||||||
* the face has to be meaningfully non-trivially initialized by
|
* the face has to be meaningfully initialized by calling
|
||||||
* calling @FT_Set_Char_Size before this function, for example.
|
* @FT_Set_Char_Size before this function, for example. The loaded
|
||||||
* The loaded glyph may be transformed. See @FT_Set_Transform for the
|
* glyph may be transformed. See @FT_Set_Transform for the details.
|
||||||
* details.
|
|
||||||
*
|
*
|
||||||
* For subsetted CID-keyed fonts, `FT_Err_Invalid_Argument` is returned
|
* For subsetted CID-keyed fonts, `FT_Err_Invalid_Argument` is returned
|
||||||
* for invalid CID values (this is, for CID values that don't have a
|
* for invalid CID values (this is, for CID values that don't have a
|
||||||
|
|
Loading…
Reference in New Issue