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

Documentation update.

Browse source
This commit is contained in:
Leon Styhre 2022-12-13 21:39:04 +01:00
parent c260c929b5
commit 468d7aa09d
2 changed files with 12 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
CHANGELOG.md
View file

@ -188,6 +188,7 @@
* Added a new itemAxisHorizontal property to the carousel to keep wheel items horizontal at all times * Added a new itemAxisHorizontal property to the carousel to keep wheel items horizontal at all times
* Added carousel theme support for setting the opacity for unfocused entries * Added carousel theme support for setting the opacity for unfocused entries
* Added carousel theme support for applying image color shifts * Added carousel theme support for applying image color shifts
* Added carousel theme support for defining image saturation
* Added carousel theme support for setting item transitions to "slide" or "instant" * Added carousel theme support for setting item transitions to "slide" or "instant"
* Added carousel theme support for controlling item stacking for overlapping items * Added carousel theme support for controlling item stacking for overlapping items
* Added a fadeAbovePrimary property to control whether elements above the system view carousel and textlist should be rendered during fade transitions * Added a fadeAbovePrimary property to control whether elements above the system view carousel and textlist should be rendered during fade transitions

14
THEMES-DEV.md
View file

@ -1082,7 +1082,7 @@ Properties:
- Valid values are `nearest` or `linear` - Valid values are `nearest` or `linear`
- Default is `linear` - Default is `linear`
* `imageColor` - type: COLOR * `imageColor` - type: COLOR
- Applies a color shift to the images defined by `staticImage`, `imageType` and `defaultImage` by multiplying each pixel's color by this color value. For example, an all-white image with `FF0000` applied would become completely red. You can also control the transparency of the images by setting the value to for example `FFFFFFAA`. This keeps all pixels at their normal color and only affects the alpha channel. - Applies a color shift to the images defined by `staticImage`, `imageType` and `defaultImage` by multiplying each pixel's color by this color value. For example, an all-white image with `FF0000` applied would become completely red. You can also control the transparency of the images by setting the value to for example `FFFFFFAA`. This keeps all pixels at their normal color and only affects the alpha channel. This property is applied after `imageSaturation` so by setting that property to `0` it's possible to colorize rather than color shift.
- Default is `FFFFFFFF` (no color shift applied) - Default is `FFFFFFFF` (no color shift applied)
* `imageColorEnd` - type: COLOR * `imageColorEnd` - type: COLOR
- Works in the exact same way as `imageColor` but can be set as the end color to apply a color shift gradient. - Works in the exact same way as `imageColor` but can be set as the end color to apply a color shift gradient.
@ -1091,6 +1091,10 @@ Properties:
- The direction to apply the color gradient if both `imageColor` and `imageColorEnd` have been defined. - The direction to apply the color gradient if both `imageColor` and `imageColorEnd` have been defined.
- Valid values are `horizontal` or `vertical` - Valid values are `horizontal` or `vertical`
- Default is `horizontal` - Default is `horizontal`
* `imageSaturation` - type: FLOAT
- Controls the level of color saturation.
- Minimum value is `0` (grayscale) and maximum value is `1` (original file saturation).
- Default is `1`
* `itemTransitions` - type: STRING * `itemTransitions` - type: STRING
- How to render item transitions when navigating the carousel. By default a slide, scale and opacity fade animation will be played when moving between items (the latter two assuming `itemScale` and `unfocusedItemOpacity` have not been set to `1`) but if this property is set to `instant` then transitions will be immediate. - How to render item transitions when navigating the carousel. By default a slide, scale and opacity fade animation will be played when moving between items (the latter two assuming `itemScale` and `unfocusedItemOpacity` have not been set to `1`) but if this property is set to `instant` then transitions will be immediate.
- Valid values are `animate` or `instant` - Valid values are `animate` or `instant`
@ -1250,7 +1254,7 @@ Properties:
- Minimum value is `0.2` and maximum value is `1` - Minimum value is `0.2` and maximum value is `1`
- Default is `1` - Default is `1`
* `imageColor` - type: COLOR * `imageColor` - type: COLOR
- Applies a color shift to the images defined by `staticImage`, `imageType` and `defaultImage` by multiplying each pixel's color by this color value. For example, an all-white image with `FF0000` applied would become completely red. You can also control the transparency of the images by setting the value to for example `FFFFFFAA`. This keeps all pixels at their normal color and only affects the alpha channel. - Applies a color shift to the images defined by `staticImage`, `imageType` and `defaultImage` by multiplying each pixel's color by this color value. For example, an all-white image with `FF0000` applied would become completely red. You can also control the transparency of the images by setting the value to for example `FFFFFFAA`. This keeps all pixels at their normal color and only affects the alpha channel. This property is applied after `imageSaturation` so by setting that property to `0` it's possible to colorize rather than color shift.
* `imageColorEnd` - type: COLOR * `imageColorEnd` - type: COLOR
- Works in the exact same way as `imageColor` but can be set as the end color to apply a color shift gradient. - Works in the exact same way as `imageColor` but can be set as the end color to apply a color shift gradient.
- Default is the same value as `imageColor` - Default is the same value as `imageColor`
@ -1258,6 +1262,10 @@ Properties:
- The direction to apply the color gradient if both `imageColor` and `imageColorEnd` have been defined. - The direction to apply the color gradient if both `imageColor` and `imageColorEnd` have been defined.
- Valid values are `horizontal` or `vertical` - Valid values are `horizontal` or `vertical`
- Default is `horizontal` - Default is `horizontal`
* `imageSaturation` - type: FLOAT
- Controls the level of color saturation.
- Minimum value is `0` (grayscale) and maximum value is `1` (original file saturation).
- Default is `1`
* `backgroundImage` - type: PATH * `backgroundImage` - type: PATH
- Path to an optional background image file which will be displayed behind the image defined by `staticImage`, `imageType` or `defaultImage`. The aspect ratio for this image will not be preserved, it will be stretched or squashed to the aspect ratio set by `itemSize`. Most common extensions are supported (including .svg, .jpg, .png, and unanimated .gif). - Path to an optional background image file which will be displayed behind the image defined by `staticImage`, `imageType` or `defaultImage`. The aspect ratio for this image will not be preserved, it will be stretched or squashed to the aspect ratio set by `itemSize`. Most common extensions are supported (including .svg, .jpg, .png, and unanimated .gif).
* `backgroundRelativeScale` - type: FLOAT. * `backgroundRelativeScale` - type: FLOAT.
@ -1576,7 +1584,7 @@ Properties:
- Valid values are `nearest` or `linear` - Valid values are `nearest` or `linear`
- Default is `nearest` - Default is `nearest`
* `color` - type: COLOR * `color` - type: COLOR
- Applies a color shift to both the static image and video by multiplying each pixel's color by this color value. For example, an all-white image or video with `FF0000` applied would become completely red. You can also control the transparency of the image and video by setting the value to for example `FFFFFFAA`. This keeps all pixels at their normal color and only affects the alpha channel. This property is applied after `saturation` so by setting that property to `0` it's possible to colorize rather than color shift. - Applies a color shift to both the static image and video by multiplying each pixel's color by this color value. For example, an all-white image or video with `FF0000` applied would become completely red. It's however not recommended to use this property to control opacity as this will not look right for actual videos, instead use the `opacity` property if you want to render this element as semi-transparent. The `color` property is applied after `saturation` so by setting that property to `0` it's possible to colorize rather than color shift.
- Default is `FFFFFFFF` (no color shift applied) - Default is `FFFFFFFF` (no color shift applied)
* `colorEnd` - type: COLOR * `colorEnd` - type: COLOR
- Works in the exact same way as `color` but can be set as the end color to apply a color shift gradient. - Works in the exact same way as `color` but can be set as the end color to apply a color shift gradient.