HOW-TO:Modify dirty regions - Revision history

Karellen: Text replacement - "userdata folder" to "userdata folder"

2020-07-19T10:19:25Z

Text replacement - "userdata folder" to "userdata folder"

← Older revision		Revision as of 10:19, 19 July 2020
Line 44:		Line 44:
	\| Step3 = Change the values between the tags to fit your situation. See '''[[#Settings explained]]''' for details.		\| Step3 = Change the values between the tags to fit your situation. See '''[[#Settings explained]]''' for details.
	<br>		<br>
	\| Step4 = Save this file in your [[userdata folder]]:		\| Step4 = Save this file in your [[Userdata\|userdata folder]]:
	:{{#lst:userdata\|location all}}		:{{#lst:userdata\|location all}}
	}}		}}

Karellen: Updated for v18

2019-11-18T03:14:36Z

Updated for v18

← Older revision		Revision as of 03:14, 18 November 2019
Line 2:		Line 2:
	<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" />		<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" />

	~~{{TOC limit\|2}}~~

	== Steps ==
			= 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.		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		{{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".		\| 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:		\| 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">		:<syntaxhighlight lang="xml" enclose="div">
	<advancedsettings>		<advancedsettings>
	<gui>		<gui>
	<algorithmdirtyregions>3</algorithmdirtyregions>		<algorithmdirtyregions>3</algorithmdirtyregions>
	~~<nofliptimeout>0</nofliptimeout>~~
	</gui>		</gui>
	</advancedsettings>		</advancedsettings>
	</syntaxhighlight>		</syntaxhighlight>
			<br>
	\| Step3 = Change the values between the tags to fit your situation. See '''[[#Settings explained]]''' for details.		\| Step3 = Change the values between the tags to fit your situation. See '''[[#Settings explained]]''' for details.
			<br>
	\| Step4 = Save this file in your [[userdata folder]]:		\| Step4 = Save this file in your [[userdata folder]]:
	:{{#lst:userdata\|location all}}		:{{#lst:userdata\|location all}}
	~~{{note\|If you have an existing advancedsettings.xml file, make sure the <gui></gui> tags, and settings we'll add between them, are between the main <advancedsettings></advancedsettings> tags.}}~~

	}}		}}

	~~== Settings explained ==~~
	~~{\| class="prettytable"~~
	~~! advancedsettings.xml tag !! what it does~~
	\|-
	~~\| <code><algorithmdirtyregions>'''3'''</algorithmdirtyregions></code>~~

	~~\| {{big\|'''Dirty regions mode'''}}~~

	~~{{#lst:advancedsettings.xml\|algorithmdirtyregions}}~~

	\|-
	~~\| <code><visualizedirtyregions>'''false'''</visualizedirtyregions></code>~~

	~~\| {{big\|'''Visualized dirty regions'''}}~~

	~~{{#lst:advancedsettings.xml\|visualizedirtyregions}}~~

	\|}

	== Examples ==		= Examples =

	=== Example 1 ===		== Example 1 ==

	;advancedsettings.xml		;advancedsettings.xml
Line 56:		Line 59:
	<gui>		<gui>
	<algorithmdirtyregions>1</algorithmdirtyregions>		<algorithmdirtyregions>1</algorithmdirtyregions>
	~~<nofliptimeout>1000</nofliptimeout>~~
	</gui>		</gui>
	</advancedsettings>		</advancedsettings>
	</syntaxhighlight>		</syntaxhighlight>

	== History ==

			= 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.		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]'''		For more information see: '''[http://kodi.tv/working-with-dirty-regions/ Working with dirty regions]'''

	~~{{Updated\|17}}~~

			{{Top}}


			{{updated\|18}}

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

Ned Scott at 08:52, 2 October 2017

2017-10-02T08:52:20Z

← Older revision		Revision as of 08:52, 2 October 2017
Line 66:		Line 66:
	For more information see: '''[http://kodi.tv/working-with-dirty-regions/ Working with dirty regions]'''		For more information see: '''[http://kodi.tv/working-with-dirty-regions/ Working with dirty regions]'''

	{{Updated\|16}}		{{Updated\|17}}

	[[Category:Advanced topics]]		[[Category:Advanced topics]]
	[[Category:How-to]]		[[Category:How-to]]

Ned Scott: /* Settings explained */ outdated tag

2017-10-02T08:52:04Z

Settings explained: outdated tag

← Older revision		Revision as of 08:52, 2 October 2017
Line 37:		Line 37:

	{{#lst:advancedsettings.xml\|algorithmdirtyregions}}		{{#lst:advancedsettings.xml\|algorithmdirtyregions}}

	\|-
	~~\| <code><nofliptimeout>'''0'''</nofliptimeout></code><br />{{future note\|17\|nofliptimeout will be removed from Kodi v17.}}~~

	~~\| {{big\|'''No flip timeout'''}}~~

	~~{{#lst:advancedsettings.xml\|nofliptimeout}}~~

	\|-		\|-

Gamester17: /* Settings explained */

2017-02-02T20:35:33Z

Settings explained

← Older revision		Revision as of 20:35, 2 February 2017
Line 39:		Line 39:

	\|-		\|-
	\| <code><nofliptimeout>'''0'''</nofliptimeout></code><br />{{future note\|17\|nofliptimeout will be removed from ~~the upcoming~~ Kodi v17.}}		\| <code><nofliptimeout>'''0'''</nofliptimeout></code><br />{{future note\|17\|nofliptimeout will be removed from Kodi v17.}}

	\| {{big\|'''No flip timeout'''}}		\| {{big\|'''No flip timeout'''}}

Ned Scott at 09:03, 5 June 2016

2016-06-05T09:03:30Z

← Older revision		Revision as of 09:03, 5 June 2016
Line 71:		Line 71:
	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.		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~~.~~org~~/working-with-dirty-regions/ Working with dirty regions]'''		For more information see: '''[http://kodi.tv/working-with-dirty-regions/ Working with dirty regions]'''

	{{Updated\|16}}		{{Updated\|16}}

Ned Scott at 09:03, 5 June 2016

2016-06-05T09:03:16Z

← Older revision		Revision as of 09:03, 5 June 2016
Line 1:		Line 1:
	{{mininav\| [[advancedsettings.xml]] }}		{{mininav\| [[advancedsettings.xml]] }}
	<section begin="intro" />Dirty regions is an advanced setting and interface rendering method that can help speed up the GUI in ~~XBMC~~ 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 ~~XBMC~~ v11 (Eden) or higher.<section end="intro" />		<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" />

	{{TOC limit\|2}}		{{TOC limit\|2}}

	== Steps ==		== Steps ==
	If you don't already have an [[advancedsettings.xml]] file, it's very simple to make. ~~XBMC~~ 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.		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		{{how-to
Line 69:		Line 69:

	== History ==		== History ==
	~~XBMC~~ 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 ~~XBMC’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), ~~XBMC~~ now has the ability to only render what has changed.		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://~~xbmc~~.org/working-with-dirty-regions/ Working with dirty regions]'''		For more information see: '''[http://Kodi.org/working-with-dirty-regions/ Working with dirty regions]'''

	{{~~Gotham updated~~}}		{{Updated\|16}}

	[[Category:Advanced topics]]		[[Category:Advanced topics]]
	[[Category:How-to]]		[[Category:How-to]]

Ned Scott: /* Settings explained */

2016-06-05T09:02:40Z

Settings explained

← Older revision		Revision as of 09:02, 5 June 2016
Line 39:		Line 39:

	\|-		\|-
	\| <code><nofliptimeout>'''0'''</nofliptimeout></code>		\| <code><nofliptimeout>'''0'''</nofliptimeout></code><br />{{future note\|17\|nofliptimeout will be removed from the upcoming Kodi v17.}}

	\| {{big\|'''No flip timeout'''}}		\| {{big\|'''No flip timeout'''}}

Ned Scott: /* Settings explained */

2014-05-24T23:41:57Z

Settings explained

← Older revision		Revision as of 23:41, 24 May 2014
Line 35:		Line 35:

	\| {{big\|'''Dirty regions mode'''}}		\| {{big\|'''Dirty regions mode'''}}

	{{note\|Some GPU/hardware configurations will have some minor issues (such as a visual "flicker"). For those situations try mode 2 or use the default (mode 3, which requires no advancedsetting). Almost all ARM-based devices (such as [[Android]]) willl likely have flickering issues.}}

	{{#lst:advancedsettings.xml\|algorithmdirtyregions}}		{{#lst:advancedsettings.xml\|algorithmdirtyregions}}
Line 45:		Line 43:
	\| {{big\|'''No flip timeout'''}}		\| {{big\|'''No flip timeout'''}}

	Specifies the timeout in milliseconds after which XBMC will not flip the graphics buffers anymore when nothing has been rendered, this lowers both CPU and GPU usage. Sometimes adjusting this value can help prevent flickering.		{{#lst:advancedsettings.xml\|nofliptimeout}}

	* -1: disabled
	* 0 or higher: timeout in milliseconds '''(Default)'''

	\|-		\|-
Line 55:		Line 50:
	\| {{big\|'''Visualized dirty regions'''}}		\| {{big\|'''Visualized dirty regions'''}}

	~~Enable dirty-region visualization. Paints a rectangle over marked controls.~~		{{#lst:advancedsettings.xml\|visualizedirtyregions}}

	* true: on
	* false: off '''(Default)'''

	{{~~note~~\|~~This is only a development mode and isn't of use to normal users.~~}}

	\|}		\|}

Ned Scott: Ned Scott moved page Dirty regions to HOW-TO:Modify dirty regions

2014-05-24T23:35:57Z

Ned Scott moved page Dirty regions to HOW-TO:Modify dirty regions

← Older revision	Revision as of 23:35, 24 May 2014
(No difference)