Skip to content

Commit 485fd99

Browse files
committed
Sync SDL3_ttf wiki -> header
[ci skip]
1 parent dd1add2 commit 485fd99

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

include/SDL3_ttf/SDL_ttf.h

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -186,10 +186,12 @@ extern SDL_DECLSPEC TTF_Font * SDLCALL TTF_OpenFontIO(SDL_IOStream *src, bool cl
186186
*
187187
* - `TTF_PROP_FONT_CREATE_FILENAME_STRING`: the font file to open, if an
188188
* SDL_IOStream isn't being used. This is required if
189-
* `TTF_PROP_FONT_CREATE_IOSTREAM_POINTER` and `TTF_PROP_FONT_CREATE_EXISTING_FONT` aren't set.
189+
* `TTF_PROP_FONT_CREATE_IOSTREAM_POINTER` and
190+
* `TTF_PROP_FONT_CREATE_EXISTING_FONT` aren't set.
190191
* - `TTF_PROP_FONT_CREATE_IOSTREAM_POINTER`: an SDL_IOStream containing the
191192
* font to be opened. This should not be closed until the font is closed.
192-
* This is required if `TTF_PROP_FONT_CREATE_FILENAME_STRING` and `TTF_PROP_FONT_CREATE_EXISTING_FONT` aren't set.
193+
* This is required if `TTF_PROP_FONT_CREATE_FILENAME_STRING` and
194+
* `TTF_PROP_FONT_CREATE_EXISTING_FONT` aren't set.
193195
* - `TTF_PROP_FONT_CREATE_IOSTREAM_OFFSET_NUMBER`: the offset in the iostream
194196
* for the beginning of the font, defaults to 0.
195197
* - `TTF_PROP_FONT_CREATE_IOSTREAM_AUTOCLOSE_BOOLEAN`: true if closing the
@@ -206,7 +208,9 @@ extern SDL_DECLSPEC TTF_Font * SDLCALL TTF_OpenFontIO(SDL_IOStream *src, bool cl
206208
* - `TTF_PROP_FONT_CREATE_VERTICAL_DPI_NUMBER`: the vertical DPI to use for
207209
* font rendering, defaults to `TTF_PROP_FONT_CREATE_HORIZONTAL_DPI_NUMBER`
208210
* if set, or 72 otherwise.
209-
* - `TTF_PROP_FONT_CREATE_EXISTING_FONT`: an optional TTF_Font that, if set, will be used as the font data source and the initial size and style of the new font.
211+
* - `TTF_PROP_FONT_CREATE_EXISTING_FONT`: an optional TTF_Font that, if set,
212+
* will be used as the font data source and the initial size and style of
213+
* the new font.
210214
*
211215
* \param props the properties to use.
212216
* \returns a valid TTF_Font, or NULL on failure; call SDL_GetError() for more
@@ -233,7 +237,8 @@ extern SDL_DECLSPEC TTF_Font * SDLCALL TTF_OpenFontWithProperties(SDL_Properties
233237
/**
234238
* Create a copy of an existing font.
235239
*
236-
* The copy will be distinct from the original, but will share the font file and have the same size and style as the original.
240+
* The copy will be distinct from the original, but will share the font file
241+
* and have the same size and style as the original.
237242
*
238243
* When done with the returned TTF_Font, use TTF_CloseFont() to dispose of it.
239244
*

0 commit comments

Comments
 (0)