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

Documentation update

Browse source
This commit is contained in:
Leon Styhre 2023-09-30 16:47:03 +02:00
parent 2d4886a4e1
commit be106ff361
2 changed files with 28 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
CHANGELOG.md
View file

@ -81,7 +81,7 @@
* Added a download percentage indicator to the application updater * Added a download percentage indicator to the application updater
* Made the miximage offline generator GUI sizing more consistent across different display aspect ratios * Made the miximage offline generator GUI sizing more consistent across different display aspect ratios
* Removed the es_log.txt entry when an es_systems.cfg legacy systems configuration file was found on startup * Removed the es_log.txt entry when an es_systems.cfg legacy systems configuration file was found on startup
* Improved menu system font rendering on GPUs without proper texture filtering support * Improved font rendering quality and always enabled linear texture interpolation for both minification and magnification
* Improved the blur shaders to run faster at higher resolutions and to look identical regardless of display resolution * Improved the blur shaders to run faster at higher resolutions and to look identical regardless of display resolution
* Improved the blur shaders rendering quality when rotating the screen 90 or 270 degrees * Improved the blur shaders rendering quality when rotating the screen 90 or 270 degrees
* Added rounded corner support to the image, video, animation, carousel and grid elements * Added rounded corner support to the image, video, animation, carousel and grid elements
@ -90,6 +90,12 @@
* Added a number of carousel, grid, textlist and text properties to control horizontally scrolling text * Added a number of carousel, grid, textlist and text properties to control horizontally scrolling text
* Added a "textRelativeScale" property to the carousel to size text smaller than the overall item size * Added a "textRelativeScale" property to the carousel to size text smaller than the overall item size
* Added an "imageInterpolation" property to the grid element * Added an "imageInterpolation" property to the grid element
* Added "rotation" and "rotationOrigin" properties to the video element
* Changed the "interpolation" property for the video element to also apply to the video texture
* Added debug overlay rendering for the actual video stream in addition to the static image
* Added an "interpolation" property to the badge element
* Added support for the "interpolation" property to the animation element when using Lottie files
* Changed default interpolation to linear on arbitrary rotation for the image, video, animation, badges and rating elements
* Added "iterationCount" and "onIterationsDone" properties to the video element * Added "iterationCount" and "onIterationsDone" properties to the video element
* Changed the "path" property for the video element to consider the set value even if it points to a non-existing file * Changed the "path" property for the video element to consider the set value even if it points to a non-existing file
* Made it possible to set the defaultImage property for the carousel and grid elements using variables * Made it possible to set the defaultImage property for the carousel and grid elements using variables

32
THEMES-DEV.md
View file

@ -1336,7 +1336,7 @@ Properties:
- Valid values are `contain`, `fill` or `cover` - Valid values are `contain`, `fill` or `cover`
- Default is `contain` - Default is `contain`
* `imageInterpolation` - type: STRING * `imageInterpolation` - type: STRING
- Interpolation method to use when scaling up images. Nearest neighbor (`nearest`) preserves sharp pixels and linear filtering (`linear`) makes the image smoother. The effect of this property is primarily visible for raster graphic images, but it has a limited effect also when using scalable vector graphics (SVG) images as these are rasterized at a set resolution and then scaled using the GPU. - Interpolation method to use when scaling and rotating images. Nearest neighbor (`nearest`) preserves sharp pixels and linear filtering (`linear`) makes the image smoother. This property has limited effect on scalable vector graphics (SVG) images unless rotation is applied.
- Valid values are `nearest` or `linear` - Valid values are `nearest` or `linear`
- Default is `linear` - Default is `linear`
* `imageCornerRadius` - type: FLOAT * `imageCornerRadius` - type: FLOAT
@ -1610,7 +1610,7 @@ Properties:
- Valid values are `contain`, `fill` or `cover` - Valid values are `contain`, `fill` or `cover`
- Default is `contain` - Default is `contain`
* `imageInterpolation` - type: STRING * `imageInterpolation` - type: STRING
- Interpolation method to use when scaling up images. Nearest neighbor (`nearest`) preserves sharp pixels and linear filtering (`linear`) makes the image smoother. - Interpolation method to use when scaling images. Nearest neighbor (`nearest`) preserves sharp pixels and linear filtering (`linear`) makes the image smoother. This property has limited effect on scalable vector graphics (SVG) images.
- Valid values are `nearest` or `linear` - Valid values are `nearest` or `linear`
- Default is `linear` - Default is `linear`
* `imageRelativeScale` - type: FLOAT. * `imageRelativeScale` - type: FLOAT.
@ -2000,9 +2000,9 @@ Properties:
- Valid values are `top` or `bottom` - Valid values are `top` or `bottom`
- Default is `bottom` - Default is `bottom`
* `interpolation` - type: STRING * `interpolation` - type: STRING
- Interpolation method to use when scaling up. Nearest neighbor (`nearest`) preserves sharp pixels and linear filtering (`linear`) makes the image smoother. This property has limited effect on scalable vector graphics (SVG) images unless rotation is applied. - Interpolation method to use when scaling and rotating images. Nearest neighbor (`nearest`) preserves sharp pixels and linear filtering (`linear`) makes the image smoother. This property has limited effect on scalable vector graphics (SVG) images unless rotation is applied.
- Valid values are `nearest` or `linear` - Valid values are `nearest` or `linear`
- Default is `nearest` - Default is `nearest` if `rotation` is `0`, `90`, `180` or `270` degrees, otherwise it's `linear`
* `cornerRadius` - type: FLOAT * `cornerRadius` - type: FLOAT
- Setting this property higher than zero applies rounded corners to the image. The radius is a percentage of the screen width and not directly related to the image size. This makes it possible to apply identically sized corners regardless of image dimensions. Note that the maximum allowed value is quite arbitrary as the renderer will in practice limit the maximum roundness so it can never go beyond half the width or height. It means that setting this property sufficiently high will turn a perfectly square image into a perfectly round one. - Setting this property higher than zero applies rounded corners to the image. The radius is a percentage of the screen width and not directly related to the image size. This makes it possible to apply identically sized corners regardless of image dimensions. Note that the maximum allowed value is quite arbitrary as the renderer will in practice limit the maximum roundness so it can never go beyond half the width or height. It means that setting this property sufficiently high will turn a perfectly square image into a perfectly round one.
- Minimum value is `0` and maximum value is `0.5` - Minimum value is `0` and maximum value is `0.5`
@ -2065,6 +2065,13 @@ Properties:
- Where on the element `pos` refers to. For example, an origin of `0.5 0.5` and a `pos` of `0.5 0.5` would place the element exactly in the middle of the screen. If the position and size attributes are themeable, origin is implied. - Where on the element `pos` refers to. For example, an origin of `0.5 0.5` and a `pos` of `0.5 0.5` would place the element exactly in the middle of the screen. If the position and size attributes are themeable, origin is implied.
- Minimum value per axis is `0` and maximum value per axis is `1` - Minimum value per axis is `0` and maximum value per axis is `1`
- Default is `0 0` - Default is `0 0`
* `rotation` - type: FLOAT
- Angle in degrees that the static image and video should be rotated. Positive values will rotate clockwise, negative values will rotate counterclockwise.
- Default is `0`
* `rotationOrigin` - type: NORMALIZED_PAIR
- Point around which the static image and video will be rotated.
- Minimum value per axis is `0` and maximum value per axis is `1`
- Default is `0.5 0.5`
* `stationary` - type: STRING * `stationary` - type: STRING
- If using slide transitions, then this property can be set to keep the element stationary during transition animations. This property has no effect when using instant or fade transitions. - If using slide transitions, then this property can be set to keep the element stationary during transition animations. This property has no effect when using instant or fade transitions.
- `withinView` - Set element as stationary when navigating within the same view, i.e. from system to system or from gamelist to gamelist. - `withinView` - Set element as stationary when navigating within the same view, i.e. from system to system or from gamelist to gamelist.
@ -2114,9 +2121,9 @@ Properties:
- Whether to enable or disable audio playback for the video. For static videos in the gamelist view it's strongly recommended to set this to `false` if there is also a separate video element playing game videos. - Whether to enable or disable audio playback for the video. For static videos in the gamelist view it's strongly recommended to set this to `false` if there is also a separate video element playing game videos.
- Default is `true` - Default is `true`
* `interpolation` - type: STRING * `interpolation` - type: STRING
- Interpolation method to use when scaling up images. Nearest neighbor (`nearest`) preserves sharp pixels and linear filtering (`linear`) makes the image smoother. Note that this property only affects the static image, not the video scaling. This property also has no effect on scalable vector graphics (SVG) images. - Interpolation method to use when scaling and rotating static images and videos. Nearest neighbor (`nearest`) preserves sharp pixels and linear filtering (`linear`) makes the image and video smoother.
- Valid values are `nearest` or `linear` - Valid values are `nearest` or `linear`
- Default is `nearest` - Default is `nearest` if `rotation` is `0`, `90`, `180` or `270` degrees, otherwise it's `linear`
* `imageCornerRadius` - type: FLOAT * `imageCornerRadius` - type: FLOAT
- Setting this property higher than zero applies rounded corners to the static image. The radius is a percentage of the screen width and not directly related to the image size. This makes it possible to apply identically sized corners regardless of image dimensions. Note that the maximum allowed value is quite arbitrary as the renderer will in practice limit the maximum roundness so it can never go beyond half the width or height. It means that setting this property sufficiently high will turn a perfectly square image into a perfectly round one. - Setting this property higher than zero applies rounded corners to the static image. The radius is a percentage of the screen width and not directly related to the image size. This makes it possible to apply identically sized corners regardless of image dimensions. Note that the maximum allowed value is quite arbitrary as the renderer will in practice limit the maximum roundness so it can never go beyond half the width or height. It means that setting this property sufficiently high will turn a perfectly square image into a perfectly round one.
- Minimum value is `0` and maximum value is `0.5` - Minimum value is `0` and maximum value is `0.5`
@ -2232,10 +2239,9 @@ Properties:
- Minimum value is `0` and maximum value is `10` - Minimum value is `0` and maximum value is `10`
- Default is `0` (infinite amount of times) - Default is `0` (infinite amount of times)
* `interpolation` - type: STRING * `interpolation` - type: STRING
- Interpolation method to use when scaling up. Nearest neighbor (`nearest`) preserves sharp pixels and linear filtering (`linear`) makes the image smoother. - Interpolation method to use when scaling and rotating animations. Nearest neighbor (`nearest`) preserves sharp pixels and linear filtering (`linear`) makes the animation smoother. This property has limited effect on Lottie animations unless rotation is applied.
- Valid values are `nearest` or `linear` - Valid values are `nearest` or `linear`
- Default is `nearest` - Default is `nearest` if `rotation` is `0`, `90`, `180` or `270` degrees, otherwise it's `linear`
- This property can only be used for GIF animations.
* `cornerRadius` - type: FLOAT * `cornerRadius` - type: FLOAT
- Setting this property higher than zero applies rounded corners to the animation. The radius is a percentage of the screen width and not directly related to the animation size. This makes it possible to apply identically sized corners regardless of animation dimensions. Note that the maximum allowed value is quite arbitrary as the renderer will in practice limit the maximum roundness so it can never go beyond half the width or height. - Setting this property higher than zero applies rounded corners to the animation. The radius is a percentage of the screen width and not directly related to the animation size. This makes it possible to apply identically sized corners regardless of animation dimensions. Note that the maximum allowed value is quite arbitrary as the renderer will in practice limit the maximum roundness so it can never go beyond half the width or height.
- Minimum value is `0` and maximum value is `0.5` - Minimum value is `0` and maximum value is `0.5`
@ -2423,6 +2429,10 @@ Properties:
- The direction to apply the color shift gradient if both `folderLinkIconColor` and `folderLinkIconColorEnd` have been defined. - The direction to apply the color shift gradient if both `folderLinkIconColor` and `folderLinkIconColorEnd` have been defined.
- Valid values are `horizontal` or `vertical` - Valid values are `horizontal` or `vertical`
- Default is `horizontal` - Default is `horizontal`
* `interpolation` - type: STRING
- Interpolation method to use when scaling and rotating badge images. Nearest neighbor (`nearest`) preserves sharp pixels and linear filtering (`linear`) makes the image smoother. This property has limited effect on scalable vector graphics (SVG) images unless rotation is applied.
- Valid values are `nearest` or `linear`
- Default is `nearest` if `rotation` is `0`, `90`, `180` or `270` degrees, otherwise it's `linear`
* `opacity` - type: FLOAT * `opacity` - type: FLOAT
- Controls the level of transparency. If set to `0` the element will be disabled. - Controls the level of transparency. If set to `0` the element will be disabled.
- Minimum value is `0` and maximum value is `1` - Minimum value is `0` and maximum value is `1`
@ -2797,9 +2807,9 @@ Properties:
- Minimum value is `0` and maximum value is the value of the `gameselector` element property `gameCount` minus 1. If a value outside this range is defined, then it will be automatically clamped to a valid value. - Minimum value is `0` and maximum value is the value of the `gameselector` element property `gameCount` minus 1. If a value outside this range is defined, then it will be automatically clamped to a valid value.
- Default is `0` - Default is `0`
* `interpolation` - type: STRING * `interpolation` - type: STRING
- Interpolation method to use when scaling up images. Nearest neighbor (`nearest`) preserves sharp pixels and linear filtering (`linear`) makes the image smoother. The effect of this property is primarily visible for raster graphic images, but it has a limited effect also when using scalable vector graphics (SVG) images, and even more so if rotation is applied. - Interpolation method to use when scaling and rotating rating images. Nearest neighbor (`nearest`) preserves sharp pixels and linear filtering (`linear`) makes the image smoother. This property has limited effect on scalable vector graphics (SVG) images unless rotation is applied.
- Valid values are `nearest` or `linear` - Valid values are `nearest` or `linear`
- Default is `nearest` - Default is `nearest` if `rotation` is `0`, `90`, `180` or `270` degrees, otherwise it's `linear`
* `color` - type: COLOR * `color` - type: COLOR
- Multiply each pixel's color by this color. For example, an all-white image with `<color>FF0000</color>` would become completely red. You can also control the transparency of an image with `<color>FFFFFFAA</color>` - keeping all the pixels their normal color and only affecting the alpha channel. - Multiply each pixel's color by this color. For example, an all-white image with `<color>FF0000</color>` would become completely red. You can also control the transparency of an image with `<color>FFFFFFAA</color>` - keeping all the pixels their normal color and only affecting the alpha channel.
- Default is `FFFFFFFF` - Default is `FFFFFFFF`