-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathgroup__cpp__kodi__addon__game___serialization_operations.html
268 lines (257 loc) · 15.3 KB
/
group__cpp__kodi__addon__game___serialization_operations.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
<!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: 5. Serialization operations</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__game___serialization_operations.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="summary">
<a href="#groups">Modules</a> </div>
<div class="headertitle">
<div class="title">5. Serialization operations<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__game.html">Game</a></div></div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p><b>Serialization operations</b> </p>
<hr />
<p><b>Serialization operation parts in interface:</b><br />
Copy this to your project and extend with your parts or leave functions complete away where not used or supported.</p>
<p><em>Header parts:</em> </p><div class="fragment"><div class="line"><span class="keywordtype">size_t</span> <a class="code" href="group__cpp__kodi__addon__game___serialization_operations.html#gaf0254c7fbd753075e9c0bc12e3ecfb0b">SerializeSize</a>() <span class="keyword">override</span>;</div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> <a class="code" href="group__cpp__kodi__addon__game___serialization_operations.html#gac1698fb22cc7e719995e4bc71418c2ae">Serialize</a>(uint8_t* data, <span class="keywordtype">size_t</span> size) <span class="keyword">override</span>;</div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> <a class="code" href="group__cpp__kodi__addon__game___serialization_operations.html#ga7b93aa80da19bedc83c5711f86ed087a">Deserialize</a>(<span class="keyword">const</span> uint8_t* data, <span class="keywordtype">size_t</span> size) <span class="keyword">override</span>;</div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___defs_html_gad0fb9f502cf7b3a84f8edb0dc6cbd6ef"><div class="ttname"><a href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a></div><div class="ttdeci">GAME_ERROR</div><div class="ttdoc">Game add-on error codes</div><div class="ttdef"><b>Definition:</b> game.h:34</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___serialization_operations_html_ga7b93aa80da19bedc83c5711f86ed087a"><div class="ttname"><a href="group__cpp__kodi__addon__game___serialization_operations.html#ga7b93aa80da19bedc83c5711f86ed087a">kodi::addon::CInstanceGame::Deserialize</a></div><div class="ttdeci">virtual GAME_ERROR Deserialize(const uint8_t *data, size_t size)</div><div class="ttdoc">Deserialize the game from the given state.</div><div class="ttdef"><b>Definition:</b> Game.h:884</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___serialization_operations_html_gac1698fb22cc7e719995e4bc71418c2ae"><div class="ttname"><a href="group__cpp__kodi__addon__game___serialization_operations.html#gac1698fb22cc7e719995e4bc71418c2ae">kodi::addon::CInstanceGame::Serialize</a></div><div class="ttdeci">virtual GAME_ERROR Serialize(uint8_t *data, size_t size)</div><div class="ttdoc">Serialize the state of the game.</div><div class="ttdef"><b>Definition:</b> Game.h:870</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___serialization_operations_html_gaf0254c7fbd753075e9c0bc12e3ecfb0b"><div class="ttname"><a href="group__cpp__kodi__addon__game___serialization_operations.html#gaf0254c7fbd753075e9c0bc12e3ecfb0b">kodi::addon::CInstanceGame::SerializeSize</a></div><div class="ttdeci">virtual size_t SerializeSize()</div><div class="ttdoc">Get the number of bytes required to serialize the game.</div><div class="ttdef"><b>Definition:</b> Game.h:856</div></div>
</div><!-- fragment --><p> <em>Source parts:</em> </p><div class="fragment"><div class="line"><span class="keywordtype">size_t</span> CMyInstance::SerializeSize()</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">return</span> 0;</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> CMyInstance::Serialize(uint8_t* data, <span class="keywordtype">size_t</span> size)</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efaf397002d4590537629461eff8b98d014">GAME_ERROR_NOT_IMPLEMENTED</a>;</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> CMyInstance::Deserialize(<span class="keyword">const</span> uint8_t* data, <span class="keywordtype">size_t</span> size)</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efaf397002d4590537629461eff8b98d014">GAME_ERROR_NOT_IMPLEMENTED</a>;</div>
<div class="line">}</div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___defs_html_ggad0fb9f502cf7b3a84f8edb0dc6cbd6efaf397002d4590537629461eff8b98d014"><div class="ttname"><a href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efaf397002d4590537629461eff8b98d014">GAME_ERROR_NOT_IMPLEMENTED</a></div><div class="ttdeci">@ GAME_ERROR_NOT_IMPLEMENTED</div><div class="ttdoc">the method that the frontend called is not implemented</div><div class="ttdef"><b>Definition:</b> game.h:42</div></div>
</div><!-- fragment --> <table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__cpp__kodi__addon__game___serialization_operations__header__addon__auto__check"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__addon__game___serialization_operations__header__addon__auto__check.html">Group header include</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__cpp__kodi__addon__game___serialization_operations__source__addon__auto__check"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__addon__game___serialization_operations__source__addon__auto__check.html">Group source include</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaf0254c7fbd753075e9c0bc12e3ecfb0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf0254c7fbd753075e9c0bc12e3ecfb0b">◆ </a></span>SerializeSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t SerializeSize </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 class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of bytes required to serialize the game. </p>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes, or 0 if serialization is not supported </dd></dl>
</div>
</div>
<a id="gac1698fb22cc7e719995e4bc71418c2ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac1698fb22cc7e719995e4bc71418c2ae">◆ </a></span>Serialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> Serialize </td>
<td>(</td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Serialize the state of the game. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The buffer receiving the serialized game data </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size of the buffer</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the error, or <a class="el" href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efa51b865ee275ae8e392f3e9fd8594fa90">GAME_ERROR_NO_ERROR</a> if the game was serialized into the buffer </dd></dl>
</div>
</div>
<a id="ga7b93aa80da19bedc83c5711f86ed087a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7b93aa80da19bedc83c5711f86ed087a">◆ </a></span>Deserialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> Deserialize </td>
<td>(</td>
<td class="paramtype">const uint8_t * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Deserialize the game from the given state. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>A buffer containing the game's new state </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size of the buffer</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the error, or <a class="el" href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efa51b865ee275ae8e392f3e9fd8594fa90">GAME_ERROR_NO_ERROR</a> if the game deserialized </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>