libretro/scummvm
1
0
Fork 0
mirror of https://github.com/libretro/scummvm.git synced 2025-01-19 08:25:35 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

COMMON: Explain new params for wordWrapText()

Browse Source
This commit is contained in:
Thanasis Antoniou 2019-07-31 16:48:44 +03:00 committed by Eugene Sandulenko
parent 1bca3de594
commit 4630895ccc
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
graphics/font.h
View File

@ -173,6 +173,8 @@ public:
* @param maxWidth the maximum width a line may have
* @param lines the string list to which the text lines from str are appended
* @param initWidth the starting width of the first line, for partially filled lines (optional)
* @param evenWidthLinesModeEnabled if enabled, the resulting line segments will be close to the same width (optional)
* @param wrapOnExplicitNewLines if enabled, forces wrapping on new line characters, otherwise treats them as single white space (optional)
* @return the maximal width of any of the lines added to lines
*/
int wordWrapText(const Common::String &str, int maxWidth, Common::Array<Common::String> &lines, int initWidth = 0, bool evenWidthLinesModeEnabled = false, bool wrapOnExplicitNewLines = true) const;