Game Infolabel and GUI settings update

[garbear]

Game skinning in Kodi is now fully documented: https://forum.kodi.tv/showthread.php?tid=336876

While creating this, I noticed some inconsistencies. I made the following changes:

Infolabels

• Dropped Listitem.Property(duration) (Savestate duration, left over from savestate manager)
• Added RetroPlayer.VideoFilter. Possible values:
  • nearest (Nearest-neighbor, a.k.a. pixellate)
  • linear (Bilinear filtering, a.k.a. smooth blur)
  • <path to shader> - not supported yet
• Added RetroPlayer.VideoRotation - Rotation of game in degrees CCW

GUI settings

• Changed stretch mode from int (0 through 3) to string identifier for consistency with RetroPlayer.StretchMode

<defaultgamesettings>
    <stretchmode>normal</stretchmode>
</defaultgamesettings>

Valid identifiers are:

• normal - Show the game at its correct aspect ratio
• 4:3 - Stretch the game to 4:3 aspect ratio
• fullscreen - Stretch the game to the full viewing area
• original - Shrink the game to its original size (humorous with old games on 4K displays)

Motivation and Context

For consistency with game documentation: https://forum.kodi.tv/showthread.php?tid=336876

How Has This Been Tested?

<stretchmode> gui setting migration tested on OSX. Set the value to 1, applied the patch, observed the correct behavior - old value is ignored, new value is set to normal

Types of change

• Bug fix (non-breaking change which fixes an issue)
• Clean up (non-breaking change which removes non-working, unmaintained functionality)
• Improvement (non-breaking change which improves existing functionality)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that will cause existing functionality to change)
• Cosmetic change (non-breaking change that doesn't touch code)
• None of the above (please explain below)

[enen92]

Doing a quick search on the new XML windows for games there are also references to Infolabels that are not documented, namely several options for Listitem.Property:

xbmc/addons/skin.estuary/xml/Includes_DialogSelect.xml

Lines 191 to 193 in 65f5fbb

	<videofilter>$INFO[ListItem.Property(game.videofilter)]</videofilter>
	<stretchmode>$INFO[ListItem.Property(game.stretchmode)]</stretchmode>
	<rotation>$INFO[ListItem.Property(game.videorotation)]</rotation>

Can you please also add those to the infolabels doxygen page like all the others:
https://codedocs.xyz/xbmc/xbmc/modules___general___list_of_gui_access.html#modules__General__List_of_gui_access_ListItem

Thanks

[garbear]

@enen92 pushed a fix, how's it look now?

[enen92]

Looks good thanks. Only the properties are missing but that can be done later.

[garbear]

I'll do it now, instead of duplicating list of values, how do I reference a previous infolabel?

[enen92]

Not sure I understand what you mean. Listitem.Property is repeated already several times for each property. You can however define just one new table entry and simplify it like below:

///   \table_row3{   <b>`ListItem.Property(Game.*)`</b>,
///                  \anchor ListItem_Property_Game
///                  _string_,
///     Bblablablablabla. Possible values
///     |     Property     |         Returned value      |
///     |:----------------:|:---------------------------:|
///     | game.foo         | Returns the value of foo    |
///     | game.bar         | Returns the value of bar    |
///   }

[garbear]

For example, the possible values for ListItem.Property(Game.VideoFilter) are the same as RetroPlayer.VideoFilter, so in the doxy for ListItem.Property(Game.VideoFilter) I want to say "See RetroPlayer.VideoFilter for a list of possible values" with a URL fragment that links to the RetroPlayer_VideoFilter anchor

[enen92]

Sorry for the delay. Yes you can do something like below:

See \link RetroPlayer_VideoRotation this link \endlink for available things

[garbear]

@enen92 updated

[enen92]

I'd prefer to see them grouped with all the other ListItem properties (since they refer to ListItem and not to RetroPlayer) but I guess it's a matter of taste. If you prefer to group them in the retroplayer section is fine to me too 👍

[garbear]

Grouping the listitems together would be nice, but keeping RP stuff together is less overhead for me. I'll merge when jenkins is happy.

[garbear]

jenkins build this please

[garbear]

@enen92 I completed the documentation in the forum thread. However, I don't think the Game.* infolabels are documented in the doxygen source. Can you please copy the forum documentation into the source?

[enen92]

Sure, will do