Documentation update.

CHANGELOG.md

@@ -55,6 +55,8 @@
 * OpenGL ES: Added an OpenGLVersion setting for choosing between OpenGL ES 3.0, 3.1 and 3.2 (has to be manually set in es_settings.xml)
 * Greatly improved the performance of shader post-processing such as scanlines and blur rendering
 * Greatly improved application startup speed by avoiding a lot of unnecessary SVG rasterizations
+* Implemented dynamic texture allocation to the font code to reduce memory usage and avoid missing glyphs
+* Large optimizations to the text wrapping code (generallly 300-400% faster)
 * Added support for texture mipmapping with trilinear filtering
 * Added on-demand texture loading to the carousel
 * Improved the renderer scaling accuracy
@@ -179,6 +181,7 @@
 
 * Multiple levels of symlinking in the ROMs directory tree could crash the application on startup
 * During some menu operations that reloaded the gamelist view, the cached background could miss some components as they were not rendered in time
+* Text wrapping did not work correctly for text that typically does not contain spaces, like Japanese
 * Changing some values using the metadata editor could lead to an incorrect sort order if the changes were done from within a grouped custom collection
 * Changing the setting "Group unthemed custom collections" could lead to incorrect custom collections sorting under some circumstances
 * Games located in subdirectories were not added back to custom collections when disabling the "Exclude from game counter" metadata option
@@ -203,6 +206,7 @@
 * ScrollableContainer faded semi-transparent text to fully opaque when resetting
 * ScrollableContainer faded in the background text color in addition to the text color when resetting
 * Text elements that had an opacity set to lower than FF via the color tag were faded in during gamelist scrolling
+* The help system was rendered on top of menus if placed at such a location on the screen
 * Theme sets were not always sorted correctly (as seen when mixing uppercase and lowercase letters in theme names)
 * The SliderComponent knob was not consistently positioned
 * The device text flickered in GuiDetectDevice when configuring a controller

CONTRIBUTING.md

@@ -71,6 +71,7 @@ The roadmap is under constant review so expect it to change from time to time. S
 * Lottie animation (vector graphics) and GIF animation support
 * OpenGL ES 3.0 renderer for use on the Raspberry Pi
 * Replace the OpenGL fixed function pipeline with a shader-based renderer
+* Improve text and font functions, e.g. dynamic texture allocation and faster and cleaner text wrapping
 * Improve the performance of the GLSL shader post-processing
 
 #### v2.1
@@ -92,7 +93,8 @@ The roadmap is under constant review so expect it to change from time to time. S
 * Proper audio mixer
 * Checksum support for the scraper for exact searches and for determining when to overwrite files
 * Support for portrait orientation, e.g. for Tate Mode arcade cabinets
-* Improved text and font functions, e.g. faster and cleaner line wrapping and more exact sizing
+* Replace the built-in Unicode functions and lookup tables with those of the ICU library
+* Add text kerning support using the HarfBuzz library
 
 #### v2.3
 

THEMES-DEV.md

@@ -1209,7 +1209,9 @@ Properties:
 * `fontPath` - type: PATH
     - Path to a TrueType font (.ttf).
 * `fontSize` - type: FLOAT
-    - Size of the font as a percentage of screen height (e.g. for a value of `0.1`, the text's height would be 10% of the screen height).
+    - Size of the font as a percentage of screen height (e.g. for a value of `0.1`, the text's height would be 10% of the screen height). This calculation is based on the font's bounding box, the actual glyphs (characters) don't normally fill this entire area.
+    - Minimum value is `0.001` and maximum value is `1.5`. Note that when running at a really low resolution, the minimum value can get clamped to a larger relative size. The font is allowed to overflow the height of the element by 100%, i.e. `fontSize` can be set to twice that of the y axis of the `size` property. Any value above that will be clamped.
+    - Default is `0.045`
 * `horizontalAlignment` - type: STRING
     - Controls alignment on the X axis.
     - Valid values are `left`, `center` or `right`
@@ -1277,7 +1279,9 @@ Properties:
 * `fontPath` - type: PATH
     - Path to a TrueType font (.ttf).
 * `fontSize` - type: FLOAT
-    - Size of the font as a percentage of screen height (e.g. for a value of `0.1`, the text's height would be 10% of the screen height).
+    - Size of the font as a percentage of screen height (e.g. for a value of `0.1`, the text's height would be 10% of the screen height). This calculation is based on the font's bounding box, the actual glyphs (characters) don't normally fill this entire area.
+    - Minimum value is `0.001` and maximum value is `1.5`. Note that when running at a really low resolution, the minimum value can get clamped to a larger relative size. The font is allowed to overflow the height of the element by 100%, i.e. `fontSize` can be set to twice that of the y axis of the `size` property. Any value above that will be clamped.
+    - Default is `0.045`
 * `horizontalAlignment` - type: STRING
     - Controls alignment on the X axis.
     - Valid values are `left`, `center` or `right`
@@ -1348,7 +1352,9 @@ Properties:
 * `fontPath` - type: PATH
     - Path to a TrueType font (.ttf).
 * `fontSize` - type: FLOAT
-    - Size of the font as a percentage of screen height (e.g. for a value of `0.1`, the text's height would be 10% of the screen height).
+    - Size of the font as a percentage of screen height (e.g. for a value of `0.1`, the text's height would be 10% of the screen height). This calculation is based on the font's bounding box, the actual glyphs (characters) don't normally fill this entire area.
+    - Minimum value is `0.001` and maximum value is `1.5`. Note that when running at a really low resolution, the minimum value can get clamped to a larger relative size. The font is allowed to overflow the height of the element by 100%, i.e. `fontSize` can be set to twice that of the y axis of the `size` property. Any value above that will be clamped.
+    - Default is `0.045`
 * `color` - type: COLOR
 * `backgroundColor` - type: COLOR
 * `horizontalAlignment` - type: STRING
@@ -1562,7 +1568,7 @@ Properties:
 * `fontPath` - type: PATH
     - Path to a TrueType font (.ttf) used as fallback if there is no `staticItem` / `itemType` image defined or found, and if `defaultItem` has not been defined.
 * `fontSize` - type: FLOAT
-    - Size of the font as a percentage of screen height (e.g. for a value of `0.1`, the text's height would be 10% of the screen height).
+    - Size of the font as a percentage of screen height (e.g. for a value of `0.1`, the text's height would be 10% of the screen height). This calculation is based on the font's bounding box, the actual glyphs (characters) don't normally fill this entire area.
     - Default is `0.085`
 * `letterCase` - type: STRING
     - Valid values are `none`, `uppercase`, `lowercase` or `capitalize`
@@ -1625,6 +1631,8 @@ Properties:
     - Secondary color; what this means depends on the text list. For example, for game lists, it is the color of a folder.
 * `fontPath` - type: PATH
 * `fontSize` - type: FLOAT
+    - Size of the font as a percentage of screen height (e.g. for a value of `0.1`, the text's height would be 10% of the screen height). This calculation is based on the font's bounding box, the actual glyphs (characters) don't normally fill this entire area.
+    - Default is `0.045`
 * `horizontalAlignment` - type: STRING
     - Controls alignment on the X axis.
     - Valid values are `left`, `center` or `right`
@@ -1706,7 +1714,8 @@ Properties:
     - Default is the same value as iconColor.
 * `fontPath` - type: PATH
 * `fontSize` - type: FLOAT
-    - This property also implicitly sets the icon size and is therefore the means to change the overall size of the helpsystem element.
+    - This property implicitly sets the icon size and is therefore the means to change the overall size of the helpsystem element.  This calculation is based on the font's bounding box, the actual glyphs (characters) don't normally fill this entire area.
+    - Minimum value is `0.001` and maximum value is `1.5`. Note that when running at a really low resolution, the minimum value can get clamped to a larger relative size.
     - Default is `0.035`
 * `entrySpacing` - type: FLOAT
     - Spacing between the help element pairs.