-
Notifications
You must be signed in to change notification settings - Fork 1
/
_image__control.html
182 lines (180 loc) · 11.4 KB
/
_image__control.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Kodi Development: Image Control</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="kodi-dev.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Kodi Development
 <span id="projectnumber">20.0</span>
</div>
<div id="projectbrief">for Binary and Script based Add-Ons</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_image__control.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">Image Control </div> </div>
</div><!--header-->
<div class="contents">
<div class="toc"><h3>Table of Contents</h3>
<ul><li class="level1"><a href="#Image_Control_sect1">Example</a></li>
<li class="level1"><a href="#Image_Control_sect2">Image Size and Type Restrictions</a><ul><li class="level2"><a href="#Image_Control_sect2_1">Size</a></li>
<li class="level2"><a href="#Image_Control_sect2_2">Formats</a></li>
</ul>
</li>
<li class="level1"><a href="#Image_Control_sect3">Available tags and attributes</a></li>
<li class="level1"><a href="#Image_Control_sect4">See also</a></li>
</ul>
</div>
<div class="textblock"><p><b>Used to show an image.</b></p>
<p>The image control is used for displaying images in Kodi. You can choose the position, size, transparency and contents of the image to be displayed.</p>
<hr />
<h1><a class="anchor" id="Image_Control_sect1"></a>
Example</h1>
<div class="fragment"><div class="line"><control type=<span class="stringliteral">"image"</span> <span class="keywordtype">id</span>=<span class="stringliteral">"1"</span>></div>
<div class="line"> <description>My first image control</description></div>
<div class="line"> <posx>80</posx></div>
<div class="line"> <posy>60</posy></div>
<div class="line"> <width>250</width></div>
<div class="line"> <height>200</height></div>
<div class="line"> <visible><span class="keyword">true</span></visible></div>
<div class="line"> <colordiffuse>FFFFFFFF</colordiffuse></div>
<div class="line"> <fadetime>200</fadetime></div>
<div class="line"> <texture border=<span class="stringliteral">"5"</span> flipy=<span class="stringliteral">"true"</span> flipx=<span class="stringliteral">"false"</span>>mytexture.png</texture></div>
<div class="line"> <bordertexture border=<span class="stringliteral">"5"</span>>mybordertexture.png</bordertexture></div>
<div class="line"> <bordersize>5</bordersize></div>
<div class="line"> <texture>$INFO[MusicPlayer.Cover]</texture></div>
<div class="line"> <aspectratio>keep</aspectratio></div>
<div class="line"></control></div>
</div><!-- fragment --><hr />
<h1><a class="anchor" id="Image_Control_sect2"></a>
Image Size and Type Restrictions</h1>
<p>For the <b><code><texture></code></b> tags, and for all <b><code><texture></code></b> tags in other controls, there is a small set of rules that you should follow if at all possible:</p>
<h2><a class="anchor" id="Image_Control_sect2_1"></a>
Size</h2>
<p>Images can be any size, though some graphics cards allow only power of 2 textures, so this may be a consideration. For the most case, it doesn't really matter what size things are - Kodi will quite happily load most files.</p>
<h2><a class="anchor" id="Image_Control_sect2_2"></a>
Formats</h2>
<p>If you wish to use transparency, then use PNG. It is suggested that you use PNG and JPG as much as possible. Note that once the images are injected into Textures.xbt, they are not stored as JPG or PNG – rather they are stored in a native format used for GPUs for faster loading, such as ARGB or DXTc textures. The size of the images (in kb) is therefore not as important as the size of the images in pixels – so feel free to store them in a lossless (eg PNG) manner if you wish.</p>
<p>The only exception to this is if you require an animated texture. In this case, we support only animated GIF. There are also some animated gifs that may not work. Use ImageReady CS and make sure you set the gif-anim to “restore to background” and they should work fine.</p>
<hr />
<h1><a class="anchor" id="Image_Control_sect3"></a>
Available tags and attributes</h1>
<p>In addition to the <a href="http://kodi.wiki/view/Default_Control_Tags">Default Control Tags</a> the following tags are available. Note that each tag is <b>lower case</b> only. This is important, as <code>xml</code> tags are case-sensitive.</p>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadRight">Tag </th><th class="markdownTableHeadLeft">Description </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyRight">aspectratio </td><td class="markdownTableBodyLeft">This specifies how the image will be drawn inside the box defined by <b><code><width></code></b> and <b><code><height></code></b>. <a href="http://kodi.wiki/view/Aspect_Ratio">See here for more information</a>. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyRight">texture </td><td class="markdownTableBodyLeft">Specifies the image file which should be displayed. <a href="http://kodi.wiki/view/Texture_Attributes">See here for additional information about textures</a>. </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyRight">bordertexture </td><td class="markdownTableBodyLeft">Specifies the image file which should be displayed as a border around the image. Use the <b><code><bordersize></code></b> to specify the size of the border. The <b><code><width></code></b>, <b><code><height></code></b> box specifies the size of the image plus border. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyRight">bordersize </td><td class="markdownTableBodyLeft">Specifies the size of the border. A single number specifies the border should be the same size all the way around the image, whereas a comma separated list of 4 values indicates left,top,right,bottom values. </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyRight">info </td><td class="markdownTableBodyLeft">Specifies the information that this image control is presenting. Kodi will select the texture to use based on this tag. <a href="http://kodi.wiki/view/InfoLabels">See here for more information</a>. </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyRight">fadetime </td><td class="markdownTableBodyLeft">This specifies a crossfade time that will be used whenever the underlying <b><code><texture></code></b> filename changes. The previous image will be held until the new image is ready, and then they will be crossfaded. This is particularly useful for a large thumbnail image showing the focused item in a list, or for fanart or other large backdrops. </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyRight">background </td><td class="markdownTableBodyLeft">For images inside a container, you can specify background="true" to load the textures in a background worker thread. <a href="http://kodi.wiki/view/Background_Image_Loader">See here for additional information about background loading</a>. </td></tr>
</table>
<hr />
<h1><a class="anchor" id="Image_Control_sect4"></a>
See also</h1>
<h4>Development:</h4>
<ul>
<li><a href="http://kodi.wiki/view/Add-on_development">Add-on development</a></li>
<li><a href="http://kodi.wiki/view/Skinning">Skinning</a> </li>
</ul>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>