Skip to content

Commit

Permalink
Sync SDL3_ttf wiki -> header
Browse files Browse the repository at this point in the history
[ci skip]
  • Loading branch information
SDLWikiBot committed Dec 7, 2024
1 parent c182fd1 commit a670386
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions include/SDL3_ttf/SDL_ttf.h
Original file line number Diff line number Diff line change
Expand Up @@ -231,9 +231,14 @@ extern SDL_DECLSPEC TTF_Font * SDLCALL TTF_OpenFontWithProperties(SDL_Properties
*
* The following read-write properties are provided by SDL:
*
* - `TTF_PROP_FONT_OUTLINE_LINE_CAP_NUMBER`: The FT_Stroker_LineCap value used when setting the font outline, defaults to `FT_STROKER_LINECAP_ROUND`.
* - `TTF_PROP_FONT_OUTLINE_LINE_JOIN_NUMBER`: The FT_Stroker_LineJoin value used when setting the font outline, defaults to `FT_STROKER_LINEJOIN_ROUND`.
* - `TTF_PROP_FONT_OUTLINE_MITER_LIMIT_NUMBER`: The FT_Fixed miter limit used when setting the font outline, defaults to 0.
* - `TTF_PROP_FONT_OUTLINE_LINE_CAP_NUMBER`: The FT_Stroker_LineCap value
* used when setting the font outline, defaults to
* `FT_STROKER_LINECAP_ROUND`.
* - `TTF_PROP_FONT_OUTLINE_LINE_JOIN_NUMBER`: The FT_Stroker_LineJoin value
* used when setting the font outline, defaults to
* `FT_STROKER_LINEJOIN_ROUND`.
* - `TTF_PROP_FONT_OUTLINE_MITER_LIMIT_NUMBER`: The FT_Fixed miter limit used
* when setting the font outline, defaults to 0.
*
* \param font the font to query.
* \returns a valid property ID on success or 0 on failure; call
Expand Down Expand Up @@ -404,7 +409,9 @@ extern SDL_DECLSPEC int SDLCALL TTF_GetFontStyle(const TTF_Font *font);
/**
* Set a font's current outline.
*
* This uses the font properties `TTF_PROP_FONT_OUTLINE_LINE_CAP_NUMBER`, `TTF_PROP_FONT_OUTLINE_LINE_JOIN_NUMBER`, and `TTF_PROP_FONT_OUTLINE_MITER_LIMIT_NUMBER` when setting the font outline.
* This uses the font properties `TTF_PROP_FONT_OUTLINE_LINE_CAP_NUMBER`,
* `TTF_PROP_FONT_OUTLINE_LINE_JOIN_NUMBER`, and
* `TTF_PROP_FONT_OUTLINE_MITER_LIMIT_NUMBER` when setting the font outline.
*
* This updates any TTF_Text objects using this font, and clears
* already-generated glyphs, if any, from the cache.
Expand Down

0 comments on commit a670386

Please sign in to comment.