Xargon/ES-DE
1
0
Fork 0
mirror of https://github.com/RetroDECK/ES-DE.git synced 2024-11-25 07:35:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Documentation update

Browse source
This commit is contained in:
Leon Styhre 2023-08-09 20:14:34 +02:00
parent 98482f45c9
commit b73933f1d0
2 changed files with 33 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CHANGELOG.md
View file

@ -34,11 +34,13 @@
* Improved menu system font rendering on GPUs without proper texture filtering support * Improved menu system font rendering on GPUs without proper texture filtering support
* Added a "stationary" property to all secondary elements to set them as stationary during slide transitions * Added a "stationary" property to all secondary elements to set them as stationary during slide transitions
* Added a "containerType" property to the text element to select between vertical and horizontal containers * Added a "containerType" property to the text element to select between vertical and horizontal containers
* Added new "textHorizontalScrolling", "textHorizontalScrollSpeed" and "textHorizontalScrollDelay" textlist properties * Added a number of carousel and textlist properties to control horizontally scrolling text
* Added a "textRelativeScale" property to the carousel to size text smaller than the overall item size
* Added theme support for the "manual" metadata type for the text element * Added theme support for the "manual" metadata type for the text element
* Changed the application updater to not use the scraper's transfer and connection timeout settings * Changed the application updater to not use the scraper's transfer and connection timeout settings
* Added support to MathUtil::md5Hash() for streaming files in chunks * Added support to MathUtil::md5Hash() for streaming files in chunks
* Replaced a number of homecooked functions in FileSystemUtil with those from the C++ standard library * Replaced a number of homecooked functions in FileSystemUtil with those from the C++ standard library
* Added support for fragment shader clipping to Font and TextComponent instead of using glScissor
* Added horizontal text scrolling functionality to TextComponent * Added horizontal text scrolling functionality to TextComponent
* Removed all horizontal text scrolling code from ComponentList and TextListComponent * Removed all horizontal text scrolling code from ComponentList and TextListComponent
* Refactored TextListComponent to work more like the other primary components * Refactored TextListComponent to work more like the other primary components

32
THEMES-DEV.md
View file

@ -1443,6 +1443,10 @@ Properties:
- A string literal to display if there is no `staticImage` or `defaultImage` property defined and if no image is found. - A string literal to display if there is no `staticImage` or `defaultImage` property defined and if no image is found.
- Default is the full system name. - Default is the full system name.
- This property can only be used in the `system` view as for the gamelist view the game name is always used as fallback. - This property can only be used in the `system` view as for the gamelist view the game name is always used as fallback.
* `textRelativeScale` - type: FLOAT.
- This property makes it possible to size the text relative to the overall item size. If using this and also defining a text background color using `textBackgroundColor` or `textSelectedBackgroundColor` then this color will still fill the entire item size.
- Minimum value is `0.2` and maximum value is `1`
- Default is `1`
* `textColor` - type: COLOR * `textColor` - type: COLOR
- Default is `000000FF` - Default is `000000FF`
* `textBackgroundColor` - type: COLOR * `textBackgroundColor` - type: COLOR
@ -1453,6 +1457,24 @@ Properties:
* `textSelectedBackgroundColor` - type: COLOR * `textSelectedBackgroundColor` - type: COLOR
- Sets the text background color for the currently selected item. - Sets the text background color for the currently selected item.
- Default is the same value as `textBackgroundColor` - Default is the same value as `textBackgroundColor`
* `textHorizontalScrolling` - type: BOOLEAN
- If this property is enabled then text that does not fit within the item width will scroll horizontally. If the property is disabled, the text will instead be truncated with an ellipsis (...). Using this property will automatically convert all line breaks to spaces so that a single line of text is always displayed.
- Default is `false`
* `textHorizontalScrollSpeed` - type: FLOAT
- A relative speed for how fast to scroll the text.
- Minimum value is `0.1` and maximum value is `10`
- Default is `1`
- This property can only be used when `textHorizontalScrolling` has been set to `true`
* `textHorizontalScrollDelay` - type: FLOAT
- Delay in seconds before scrolling starts.
- Minimum value is `0` and maximum value is `10`
- Default is `3`
- This property can only be used when `textHorizontalScrolling` has been set to `true`
* `textHorizontalScrollGap` - type: FLOAT
- As the scrolling text is looped, a second copy is rendered after the first one. This property defines a relative gap value to control the distance between these two text instances.
- Minimum value is `0.1` and maximum value is `5`
- Default is `1.5`
- This property can only be used when `textHorizontalScrolling` has been set to `true`
* `fontPath` - type: PATH * `fontPath` - type: PATH
- Path to a TrueType font (.ttf) used as fallback if there is no `staticImage` / `imageType` image defined or found, and if `defaultImage` has not been defined. - Path to a TrueType font (.ttf) used as fallback if there is no `staticImage` / `imageType` image defined or found, and if `defaultImage` has not been defined.
* `fontSize` - type: FLOAT * `fontSize` - type: FLOAT
@ -1770,7 +1792,8 @@ Properties:
- Background color of the highlighted entry for the secondary entry type. This follows the sizing of the selector bar and is expanded downwards so you'll probably want to adjust its position using `selectorVerticalOffset` if you have defined a custom selector height using `selectorHeight` - Background color of the highlighted entry for the secondary entry type. This follows the sizing of the selector bar and is expanded downwards so you'll probably want to adjust its position using `selectorVerticalOffset` if you have defined a custom selector height using `selectorHeight`
- Default is the same value as `selectedBackgroundColor` - Default is the same value as `selectedBackgroundColor`
* `textHorizontalScrolling` - type: BOOLEAN * `textHorizontalScrolling` - type: BOOLEAN
- If this property is enabled then text that does not fit within the element width (minus margins) will scroll horizontally. If the property is disabled, the text will instead be truncated with an ellipsis (...) if it exceeds the width. - If this property is enabled then text that does not fit within the element width (minus margins) will scroll horizontally. If the property is disabled, the text will instead be truncated with an ellipsis (...). Using this property will automatically convert all line breaks to spaces so that a single line of text is always displayed.
- Valid values are `vertical` or `horizontal`
- Default is `true` - Default is `true`
* `textHorizontalScrollSpeed` - type: FLOAT * `textHorizontalScrollSpeed` - type: FLOAT
- A relative speed for how fast to scroll the text. - A relative speed for how fast to scroll the text.
@ -1782,6 +1805,11 @@ Properties:
- Minimum value is `0` and maximum value is `10` - Minimum value is `0` and maximum value is `10`
- Default is `3` - Default is `3`
- This property can only be used when `textHorizontalScrolling` has been set to `true` - This property can only be used when `textHorizontalScrolling` has been set to `true`
* `textHorizontalScrollGap` - type: FLOAT
- As the scrolling text is looped, a second copy is rendered after the first one. This property defines a relative gap value to control the distance between these two text instances.
- Minimum value is `0.1` and maximum value is `5`
- Default is `1.5`
- This property can only be used when `textHorizontalScrolling` has been set to `true`
* `fontPath` - type: PATH * `fontPath` - type: PATH
* `fontSize` - type: FLOAT * `fontSize` - type: FLOAT
- Size of the font as a percentage of screen height for horizontally oriented screens or screen width for vertically oriented screens (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 reference 'S' character so other glyphs may not fill this area, or they may exceed this area. - Size of the font as a percentage of screen height for horizontally oriented screens or screen width for vertically oriented screens (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 reference 'S' character so other glyphs may not fill this area, or they may exceed this area.
@ -2434,7 +2462,7 @@ Properties:
- Whether the text should be placed inside a scrollable container. - Whether the text should be placed inside a scrollable container.
- Default is `true` if `metadata` is set to `description`, otherwise `false` - Default is `true` if `metadata` is set to `description`, otherwise `false`
* `containerType` - type: STRING * `containerType` - type: STRING
- If `container` has been set, then it's possible to select between a vertically or horizontally scrolling type using this property. If choosing the horizontal container then all line breaks in the text will be automatically converted to spaces. - If `container` has been set, then it's possible to select between a vertically or horizontally scrolling type using this property. If selecting the horizontal container then all line breaks in the text will be automatically converted to spaces. If selecting the vertical container then any value defined for `rotation` will be ignored as this container type can't be rotated.
- Valid values are `vertical` or `horizontal` - Valid values are `vertical` or `horizontal`
- Default is `vertical` - Default is `vertical`
- This property can only be used when `container` has been explicitly set to `true` - This property can only be used when `container` has been explicitly set to `true`