View source for HOW-TO:Modify dirty regions

{{mininav| [[advancedsettings.xml]] }}
<section begin="intro" />Dirty regions is an advanced setting and interface rendering method that can help speed up the GUI in Kodi and decrease the demand on your CPU and GPU. Dirty regions has no effect during video playback unless there are GUI elements (on screen buttons) visible. Using dirty regions requires Kodi v11 (Eden) or higher.<section end="intro" />



= Settings explained =
The following settings are available


== algorithmdirtyregions ==
<syntaxhighlight lang="xml">
<algorithmdirtyregions>3</algorithmdirtyregions>
</syntaxhighlight>
{{#lst:advancedsettings.xml|algorithmdirtyregions}}


== visualizedirtyregions ==
<syntaxhighlight lang="xml">
<visualizedirtyregions>false</visualizedirtyregions>
</syntaxhighlight>
{{#lst:advancedsettings.xml|visualizedirtyregions}}

== nofliptimeout ==
This tag was removed in v17 and no longer has any effect.




= Steps =
If you don't already have an [[advancedsettings.xml]] file, it's very simple to make. Kodi uses this file for advanced settings and features that normal users shouldn't modify without first knowing what they do, as well as for experimental features.

{{how-to
| Step1 = Create a '''plain text file''' (no rich text formatting, don't use .doc, etc) and save it as '''advancedsettings.xml'''. Make sure that the file extension is ".xml" and {{color|red|'''not'''}} ".txt" or ".xml.txt".
<br>
| Step2 = Cut and paste this into your new plain text file. Do not duplicate any tags if they already exist in your advancedsettings.xml file:
:<syntaxhighlight lang="xml" enclose="div">
<advancedsettings>
  <gui>
    <algorithmdirtyregions>3</algorithmdirtyregions>
  </gui>
</advancedsettings>
</syntaxhighlight>
<br>
| Step3 = Change the values between the tags to fit your situation. See '''[[#Settings explained]]''' for details.
<br>
| Step4 = Save this file in your [[Userdata|userdata folder]]:
:{{#lst:userdata|location all}}
}}



= Examples =

== Example 1 ==

;advancedsettings.xml
<syntaxhighlight lang="xml" enclose="div">
<advancedsettings>
  <gui>
    <algorithmdirtyregions>1</algorithmdirtyregions>
  </gui>
</advancedsettings>
</syntaxhighlight>



= History =
Kodi started as a project for the original XBOX where things were very different. After the move to desktops and embedded environments, many of the legacy procedures remained. One of these procedures, and a long-time thorn in Kodi’s side has long been its rendering model in which where every frame is rendered by the GPU in its entirety, typically at 60fps. As you can imagine, this is incredibly intensive and very unfriendly to low-power platforms. This is where dirty-region rendering comes in. Thanks to the work of Tobias and Jonathan (jmarshall), Kodi now has the ability to only render what has changed.

For more information see: '''[http://kodi.tv/working-with-dirty-regions/ Working with dirty regions]'''


{{Top}}


{{updated|18}}

[[Category:Index]]
[[Category:Manual]]
[[Category:How-to]]
[[Category:Video library]]
[[Category:Advanced topics]]