-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathgroup__cpp__kodi__addon__screensaver___c_b.html
376 lines (348 loc) · 14 KB
/
group__cpp__kodi__addon__screensaver___c_b.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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
<!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: Information functions</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('group__cpp__kodi__addon__screensaver___c_b.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="header">
<div class="headertitle">
<div class="title">Information functions<div class="ingroups"><a class="el" href="group__cpp.html">C++</a> » <a class="el" href="group__cpp__kodi__addon.html">Interface - kodi::addon</a> » <a class="el" href="group__cpp__kodi__addon__instances.html">Addon type instances</a> » <a class="el" href="group__cpp__kodi__addon__screensaver.html">Screensaver</a></div></div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p><b>To get info about the device, display and several other parts</b> </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga8172434167b6832d9b0a16e520de0e32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8172434167b6832d9b0a16e520de0e32">◆ </a></span>Device()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">kodi::HardwareContext Device </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Device that represents the display adapter. </p>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the device</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This is only available on <b>DirectX</b>, It us unused (<code>nullptr</code>) on <b>OpenGL</b></dd></dl>
<p>This value can also be becomed by <a class="el" href="group__cpp__kodi__gui__general.html#gaec912a9f8b3b133803fc2672cb60f87f">kodi::gui::GetHWContext()</a> and is recommended to use.</p>
<hr />
<p><b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include <d3d11_1.h></span></div>
<div class="line">..</div>
<div class="line"><span class="comment">// Note: Device() there is used inside addon child class about</span></div>
<div class="line"><span class="comment">// kodi::addon::CInstanceVisualization</span></div>
<div class="line">ID3D11DeviceContext1* context = <span class="keyword">static_cast<</span>ID3D11DeviceContext1*<span class="keyword">></span>(<a class="code" href="group__cpp__kodi__addon__visualization___c_b.html#ga8172434167b6832d9b0a16e520de0e32">kodi::addon::CInstanceVisualization::Device</a>());</div>
<div class="line">..</div>
<div class="ttc" id="agroup__cpp__kodi__addon__visualization___c_b_html_ga8172434167b6832d9b0a16e520de0e32"><div class="ttname"><a href="group__cpp__kodi__addon__visualization___c_b.html#ga8172434167b6832d9b0a16e520de0e32">kodi::addon::CInstanceVisualization::Device</a></div><div class="ttdeci">kodi::HardwareContext Device()</div><div class="ttdoc">Device that represents the display adapter.</div><div class="ttdef"><b>Definition:</b> Visualization.h:750</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="gaafabadb78034330e508ebff9c58e0839"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaafabadb78034330e508ebff9c58e0839">◆ </a></span>X()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int X </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the X position of the rendering window. </p>
<dl class="section return"><dt>Returns</dt><dd>The X position, in pixels </dd></dl>
</div>
</div>
<a id="gae17c4a6c158b5533f640b52d757b5519"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae17c4a6c158b5533f640b52d757b5519">◆ </a></span>Y()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Y </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the Y position of the rendering window. </p>
<dl class="section return"><dt>Returns</dt><dd>The Y position, in pixels </dd></dl>
</div>
</div>
<a id="gad26a595463349d0214ea9c09fb31c401"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad26a595463349d0214ea9c09fb31c401">◆ </a></span>Width()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Width </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the width of the rendering window. </p>
<dl class="section return"><dt>Returns</dt><dd>The width, in pixels </dd></dl>
</div>
</div>
<a id="ga40afc903300fe3a6804393874e257170"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga40afc903300fe3a6804393874e257170">◆ </a></span>Height()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Height </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the height of the rendering window. </p>
<dl class="section return"><dt>Returns</dt><dd>The height, in pixels </dd></dl>
</div>
</div>
<a id="gaed543c2faa2875e81791a9a84b76ab56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaed543c2faa2875e81791a9a84b76ab56">◆ </a></span>PixelRatio()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">float PixelRatio </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Pixel aspect ratio (often abbreviated PAR) is a ratio that describes how the width of a pixel compares to the height of that pixel. </p>
<dl class="section return"><dt>Returns</dt><dd>The pixel aspect ratio used by the display </dd></dl>
</div>
</div>
<a id="gaea85a30f7330f34848f1ca2313fcbc62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaea85a30f7330f34848f1ca2313fcbc62">◆ </a></span>Name()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string Name </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to get the name of the add-on defined in <code>addon.xml</code>. </p>
<dl class="section return"><dt>Returns</dt><dd>The add-on name </dd></dl>
</div>
</div>
<a id="ga2664b8df9b7970b2482b362c12cfe1f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2664b8df9b7970b2482b362c12cfe1f6">◆ </a></span>Presets()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string Presets </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to get the full path where the add-on is installed. </p>
<dl class="section return"><dt>Returns</dt><dd>The add-on installation path </dd></dl>
</div>
</div>
<a id="ga85035689dc2f1796f5acd2fd25053e3d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga85035689dc2f1796f5acd2fd25053e3d">◆ </a></span>Profile()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string Profile </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to get the full path to the add-on's user profile. </p>
<dl class="section note"><dt>Note</dt><dd>The trailing folder (consisting of the add-on's ID) is not created by default. If it is needed, you must call <a class="el" href="group__cpp__kodi__vfs___directory.html#ga17aaaa3f6cdbebfe788b25a4685d1cf0" title="Make a directory.">kodi::vfs::CreateDirectory()</a> to create the folder.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>Path to the user profile </dd></dl>
</div>
</div>
</div><!-- contents -->
</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>