Repository navigation
Expand file tree
/
Copy pathgroup__flatbuffers__javascript__api.html
More file actions
519 lines (500 loc) · 32.5 KB
/
Copy pathgroup__flatbuffers__javascript__api.html
File metadata and controls
519 lines (500 loc) · 32.5 KB
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
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
<!-- HTML header for doxygen 1.8.6-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.7"/>
<title>FlatBuffers: JavaScript API</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="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="https://fonts.googleapis.com/css?family=Roboto:300,400,400italic,500,500italic,700,700italic|Roboto+Mono:400,700" rel="stylesheet">
<link href="style.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea" style="height: 110px;">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="commonprojectlogo">
<img alt="Logo" src="fpl_logo_small.png"/>
</td>
<td style="padding-left: 0.5em;">
<div id="projectname">FlatBuffers
</div>
<div style="font-size:12px;">
An open source project by <a href="https://developers.google.com/games/#Tools">FPL</a>.
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.7 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="usergroup0.html"><span>Programmer's Guide</span></a></li>
<li><a href="flatbuffers_support.html"><span>Platform / Language / Feature support</span></a></li>
<li><a href="flatbuffers_benchmarks.html"><span>Benchmarks</span></a></li>
<li><a href="flatbuffers_white_paper.html"><span>FlatBuffers white paper</span></a></li>
<li><a href="flatbuffers_internals.html"><span>FlatBuffers internals</span></a></li>
<li><a href="flatbuffers_grammar.html"><span>Grammar of the schema language</span></a></li>
<li><a href="usergroup1.html"><span>API Reference</span></a></li>
<li><a href="contributing.html"><span>Contributing</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
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.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</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">
$(document).ready(function(){initNavTree('group__flatbuffers__javascript__api.html','');});
</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)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Properties</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Pages</a></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="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">JavaScript API</div> </div>
</div><!--header-->
<div class="contents">
<p>FlatBuffers API for JavaScript.
<a href="#details">More...</a></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>FlatBuffers API for JavaScript. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:ga1c36e9d7e294c61d1d6ab0923ea91e8e"><td class="memItemLeft" align="right" valign="top">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flatbuffers__javascript__api.html#ga1c36e9d7e294c61d1d6ab0923ea91e8e">addFloat32</a></td></tr>
<tr class="memdesc:ga1c36e9d7e294c61d1d6ab0923ea91e8e"><td class="mdescLeft"> </td><td class="mdescRight">Add a <code>float32</code> to the buffer, properly aligned, and grows the buffer (if necessary). <a href="#ga1c36e9d7e294c61d1d6ab0923ea91e8e">More...</a><br /></td></tr>
<tr class="separator:ga1c36e9d7e294c61d1d6ab0923ea91e8e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga53af3baf50f96de783c06a35934d63bf"><td class="memItemLeft" align="right" valign="top">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flatbuffers__javascript__api.html#ga53af3baf50f96de783c06a35934d63bf">addFloat64</a></td></tr>
<tr class="memdesc:ga53af3baf50f96de783c06a35934d63bf"><td class="mdescLeft"> </td><td class="mdescRight">Add a <code>float64</code> to the buffer, properly aligned, and grows the buffer (if necessary). <a href="#ga53af3baf50f96de783c06a35934d63bf">More...</a><br /></td></tr>
<tr class="separator:ga53af3baf50f96de783c06a35934d63bf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8260b8431cb8b1c32b5997646cb102a9"><td class="memItemLeft" align="right" valign="top">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flatbuffers__javascript__api.html#ga8260b8431cb8b1c32b5997646cb102a9">addInt16</a></td></tr>
<tr class="memdesc:ga8260b8431cb8b1c32b5997646cb102a9"><td class="mdescLeft"> </td><td class="mdescRight">Add an <code>int16</code> to the buffer, properly aligned, and grows the buffer (if necessary). <a href="#ga8260b8431cb8b1c32b5997646cb102a9">More...</a><br /></td></tr>
<tr class="separator:ga8260b8431cb8b1c32b5997646cb102a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaba2edd0e1e53d1c2815bb1a6ee54abf5"><td class="memItemLeft" align="right" valign="top">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flatbuffers__javascript__api.html#gaba2edd0e1e53d1c2815bb1a6ee54abf5">addInt32</a></td></tr>
<tr class="memdesc:gaba2edd0e1e53d1c2815bb1a6ee54abf5"><td class="mdescLeft"> </td><td class="mdescRight">Add an <code>int32</code> to the buffer, properly aligned, and grows the buffer (if necessary). <a href="#gaba2edd0e1e53d1c2815bb1a6ee54abf5">More...</a><br /></td></tr>
<tr class="separator:gaba2edd0e1e53d1c2815bb1a6ee54abf5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga17a48cc241b10348fd6751ed3a973e2d"><td class="memItemLeft" align="right" valign="top">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flatbuffers__javascript__api.html#ga17a48cc241b10348fd6751ed3a973e2d">addInt64</a></td></tr>
<tr class="memdesc:ga17a48cc241b10348fd6751ed3a973e2d"><td class="mdescLeft"> </td><td class="mdescRight">Add an <code>int64</code> to the buffer, properly aligned, and grows the buffer (if necessary). <a href="#ga17a48cc241b10348fd6751ed3a973e2d">More...</a><br /></td></tr>
<tr class="separator:ga17a48cc241b10348fd6751ed3a973e2d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7963cbb1ae0a8589b183f9b26fb25b45"><td class="memItemLeft" align="right" valign="top">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flatbuffers__javascript__api.html#ga7963cbb1ae0a8589b183f9b26fb25b45">addInt8</a></td></tr>
<tr class="memdesc:ga7963cbb1ae0a8589b183f9b26fb25b45"><td class="mdescLeft"> </td><td class="mdescRight">Add an <code>int8</code> to the buffer, properly aligned, and grows the buffer (if necessary). <a href="#ga7963cbb1ae0a8589b183f9b26fb25b45">More...</a><br /></td></tr>
<tr class="separator:ga7963cbb1ae0a8589b183f9b26fb25b45"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga21ba7dd4c33dafd6abb89568e4d9c8b8"><td class="memItemLeft" align="right" valign="top">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flatbuffers__javascript__api.html#ga21ba7dd4c33dafd6abb89568e4d9c8b8">addOffset</a></td></tr>
<tr class="memdesc:ga21ba7dd4c33dafd6abb89568e4d9c8b8"><td class="mdescLeft"> </td><td class="mdescRight">Adds on offset, relative to where it will be written. <a href="#ga21ba7dd4c33dafd6abb89568e4d9c8b8">More...</a><br /></td></tr>
<tr class="separator:ga21ba7dd4c33dafd6abb89568e4d9c8b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga997af48d5c8f757fcb962168d67e33fb"><td class="memItemLeft" align="right" valign="top">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flatbuffers__javascript__api.html#ga997af48d5c8f757fcb962168d67e33fb">asUint8Array</a></td></tr>
<tr class="memdesc:ga997af48d5c8f757fcb962168d67e33fb"><td class="mdescLeft"> </td><td class="mdescRight">Get the bytes representing the FlatBuffer. <a href="#ga997af48d5c8f757fcb962168d67e33fb">More...</a><br /></td></tr>
<tr class="separator:ga997af48d5c8f757fcb962168d67e33fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabd00b65bbe9e9fbac55fe4982eb6cec8"><td class="memItemLeft" align="right" valign="top">flatbuffers </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a></td></tr>
<tr class="memdesc:gabd00b65bbe9e9fbac55fe4982eb6cec8"><td class="mdescLeft"> </td><td class="mdescRight">Create a FlatBufferBuilder. <a href="#gabd00b65bbe9e9fbac55fe4982eb6cec8">More...</a><br /></td></tr>
<tr class="separator:gabd00b65bbe9e9fbac55fe4982eb6cec8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8c5bb4a00c46fb6665787fa9ff52089b"><td class="memItemLeft" align="right" valign="top">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flatbuffers__javascript__api.html#ga8c5bb4a00c46fb6665787fa9ff52089b">createLong</a></td></tr>
<tr class="memdesc:ga8c5bb4a00c46fb6665787fa9ff52089b"><td class="mdescLeft"> </td><td class="mdescRight">A helper function to avoid generated code depending on this file directly. <a href="#ga8c5bb4a00c46fb6665787fa9ff52089b">More...</a><br /></td></tr>
<tr class="separator:ga8c5bb4a00c46fb6665787fa9ff52089b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa7a7bd67cb1c3190792d4b2b3e66376f"><td class="memItemLeft" align="right" valign="top">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flatbuffers__javascript__api.html#gaa7a7bd67cb1c3190792d4b2b3e66376f">createString</a></td></tr>
<tr class="memdesc:gaa7a7bd67cb1c3190792d4b2b3e66376f"><td class="mdescLeft"> </td><td class="mdescRight">Encode the string <code>s</code> in the buffer using UTF-8. <a href="#gaa7a7bd67cb1c3190792d4b2b3e66376f">More...</a><br /></td></tr>
<tr class="separator:gaa7a7bd67cb1c3190792d4b2b3e66376f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga674814e0816f06c8a29ab364d19bed60"><td class="memItemLeft" align="right" valign="top">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flatbuffers__javascript__api.html#ga674814e0816f06c8a29ab364d19bed60">dataBuffer</a></td></tr>
<tr class="memdesc:ga674814e0816f06c8a29ab364d19bed60"><td class="mdescLeft"> </td><td class="mdescRight">Get the ByteBuffer representing the FlatBuffer. <a href="#ga674814e0816f06c8a29ab364d19bed60">More...</a><br /></td></tr>
<tr class="separator:ga674814e0816f06c8a29ab364d19bed60"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga62c5cf622a7bbcfd49f21bddd8b9bef7"><td class="memItemLeft" align="right" valign="top">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flatbuffers__javascript__api.html#ga62c5cf622a7bbcfd49f21bddd8b9bef7">finish</a></td></tr>
<tr class="memdesc:ga62c5cf622a7bbcfd49f21bddd8b9bef7"><td class="mdescLeft"> </td><td class="mdescRight">Finalize a buffer, poiting to the given <code>root_table</code>. <a href="#ga62c5cf622a7bbcfd49f21bddd8b9bef7">More...</a><br /></td></tr>
<tr class="separator:ga62c5cf622a7bbcfd49f21bddd8b9bef7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0d1738111b83dffb2c2a7fc8bca19b33"><td class="memItemLeft" align="right" valign="top">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flatbuffers__javascript__api.html#ga0d1738111b83dffb2c2a7fc8bca19b33">forceDefaults</a></td></tr>
<tr class="memdesc:ga0d1738111b83dffb2c2a7fc8bca19b33"><td class="mdescLeft"> </td><td class="mdescRight">In order to save space, fields that are set to their default value don't get serialized into the buffer. <a href="#ga0d1738111b83dffb2c2a7fc8bca19b33">More...</a><br /></td></tr>
<tr class="separator:ga0d1738111b83dffb2c2a7fc8bca19b33"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Variable Documentation</h2>
<a class="anchor" id="ga1c36e9d7e294c61d1d6ab0923ea91e8e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype addFloat32</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= <span class="keyword">function</span>(value) {</div>
<div class="line"> this.prep(4, 0);</div>
<div class="line"> this.writeFloat32(value);</div>
<div class="line">}</div>
</div><!-- fragment -->
<p>Add a <code>float32</code> to the buffer, properly aligned, and grows the buffer (if necessary). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">{number}</td><td>value The <code>float32</code> to add the the buffer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga53af3baf50f96de783c06a35934d63bf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype addFloat64</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= <span class="keyword">function</span>(value) {</div>
<div class="line"> this.prep(8, 0);</div>
<div class="line"> this.writeFloat64(value);</div>
<div class="line">}</div>
</div><!-- fragment -->
<p>Add a <code>float64</code> to the buffer, properly aligned, and grows the buffer (if necessary). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">{number}</td><td>value The <code>float64</code> to add the the buffer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga8260b8431cb8b1c32b5997646cb102a9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype addInt16</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= <span class="keyword">function</span>(value) {</div>
<div class="line"> this.prep(2, 0);</div>
<div class="line"> this.writeInt16(value);</div>
<div class="line">}</div>
</div><!-- fragment -->
<p>Add an <code>int16</code> to the buffer, properly aligned, and grows the buffer (if necessary). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">{number}</td><td>value The <code>int16</code> to add the the buffer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaba2edd0e1e53d1c2815bb1a6ee54abf5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype addInt32</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= <span class="keyword">function</span>(value) {</div>
<div class="line"> this.prep(4, 0);</div>
<div class="line"> this.writeInt32(value);</div>
<div class="line">}</div>
</div><!-- fragment -->
<p>Add an <code>int32</code> to the buffer, properly aligned, and grows the buffer (if necessary). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">{number}</td><td>value The <code>int32</code> to add the the buffer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga17a48cc241b10348fd6751ed3a973e2d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype addInt64</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= <span class="keyword">function</span>(value) {</div>
<div class="line"> this.prep(8, 0);</div>
<div class="line"> this.writeInt64(value);</div>
<div class="line">}</div>
</div><!-- fragment -->
<p>Add an <code>int64</code> to the buffer, properly aligned, and grows the buffer (if necessary). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">{flatbuffers.Long}</td><td>value The <code>int64</code> to add the the buffer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga7963cbb1ae0a8589b183f9b26fb25b45"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype addInt8</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= <span class="keyword">function</span>(value) {</div>
<div class="line"> this.prep(1, 0);</div>
<div class="line"> this.writeInt8(value);</div>
<div class="line">}</div>
</div><!-- fragment -->
<p>Add an <code>int8</code> to the buffer, properly aligned, and grows the buffer (if necessary). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">{number}</td><td>value The <code>int8</code> to add the the buffer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga21ba7dd4c33dafd6abb89568e4d9c8b8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype addOffset</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= <span class="keyword">function</span>(offset) {</div>
<div class="line"> this.prep(flatbuffers.SIZEOF_INT, 0); </div>
<div class="line"> this.writeInt32(this.offset() - offset + flatbuffers.SIZEOF_INT);</div>
<div class="line">}</div>
</div><!-- fragment -->
<p>Adds on offset, relative to where it will be written. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">{flatbuffers.Offset}</td><td>offset The offset to add. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga997af48d5c8f757fcb962168d67e33fb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype asUint8Array</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= <span class="keyword">function</span>() {</div>
<div class="line"> <span class="keywordflow">return</span> this.bb.bytes().subarray(this.bb.position(), this.bb.position() + this.offset());</div>
<div class="line">}</div>
</div><!-- fragment -->
<p>Get the bytes representing the FlatBuffer. </p>
<p>Only call this after you've called finish().</p>
<dl class="section return"><dt>Returns</dt><dd>{Uint8Array} </dd></dl>
</div>
</div>
<a class="anchor" id="gabd00b65bbe9e9fbac55fe4982eb6cec8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">flatbuffers Builder</td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a FlatBufferBuilder. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">{number=}</td><td>opt_initial_size </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga8c5bb4a00c46fb6665787fa9ff52089b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype createLong</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= <span class="keyword">function</span>(low, high) {</div>
<div class="line"> <span class="keywordflow">return</span> flatbuffers.Long.create(low, high);</div>
<div class="line">}</div>
</div><!-- fragment -->
<p>A helper function to avoid generated code depending on this file directly. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">{number}</td><td>low </td></tr>
<tr><td class="paramname">{number}</td><td>high </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>{flatbuffers.Long} </dd></dl>
</div>
</div>
<a class="anchor" id="gaa7a7bd67cb1c3190792d4b2b3e66376f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype createString</td>
</tr>
</table>
</div><div class="memdoc">
<p>Encode the string <code>s</code> in the buffer using UTF-8. </p>
<p>If a Uint8Array is passed instead of a string, it is assumed to contain valid UTF-8 encoded data.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">{string|Uint8Array}</td><td>s The string to encode </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>{flatbuffers.Offset} The offset in the buffer where the encoded string starts </dd></dl>
</div>
</div>
<a class="anchor" id="ga674814e0816f06c8a29ab364d19bed60"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype dataBuffer</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= <span class="keyword">function</span>() {</div>
<div class="line"> <span class="keywordflow">return</span> this.bb;</div>
<div class="line">}</div>
</div><!-- fragment -->
<p>Get the ByteBuffer representing the FlatBuffer. </p>
<p>Only call this after you've called finish(). The actual data starts at the ByteBuffer's current position, not necessarily at 0.</p>
<dl class="section return"><dt>Returns</dt><dd>{flatbuffers.ByteBuffer} </dd></dl>
</div>
</div>
<a class="anchor" id="ga62c5cf622a7bbcfd49f21bddd8b9bef7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype finish</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= <span class="keyword">function</span>(root_table, opt_file_identifier) {</div>
<div class="line"> <span class="keywordflow">if</span> (opt_file_identifier) {</div>
<div class="line"> var file_identifier = opt_file_identifier;</div>
<div class="line"> this.prep(this.minalign, flatbuffers.SIZEOF_INT +</div>
<div class="line"> flatbuffers.FILE_IDENTIFIER_LENGTH);</div>
<div class="line"> <span class="keywordflow">if</span> (file_identifier.length != flatbuffers.FILE_IDENTIFIER_LENGTH) {</div>
<div class="line"> <span class="keywordflow">throw</span> <span class="keyword">new</span> Error(<span class="stringliteral">'FlatBuffers: file identifier must be length '</span> +</div>
<div class="line"> flatbuffers.FILE_IDENTIFIER_LENGTH);</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">for</span> (var i = flatbuffers.FILE_IDENTIFIER_LENGTH - 1; i >= 0; i--) {</div>
<div class="line"> this.writeInt8(file_identifier.charCodeAt(i));</div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line"> this.prep(this.minalign, flatbuffers.SIZEOF_INT);</div>
<div class="line"> this.<a class="code" href="group__flatbuffers__javascript__api.html#ga21ba7dd4c33dafd6abb89568e4d9c8b8">addOffset</a>(root_table);</div>
<div class="line"> this.bb.setPosition(this.space);</div>
<div class="line">}</div>
<div class="ttc" id="group__flatbuffers__javascript__api_html_ga21ba7dd4c33dafd6abb89568e4d9c8b8"><div class="ttname"><a href="group__flatbuffers__javascript__api.html#ga21ba7dd4c33dafd6abb89568e4d9c8b8">addOffset</a></div><div class="ttdeci">flatbuffers Builder prototype addOffset</div><div class="ttdoc">Adds on offset, relative to where it will be written. </div><div class="ttdef"><b>Definition:</b> flatbuffers.js:555</div></div>
</div><!-- fragment -->
<p>Finalize a buffer, poiting to the given <code>root_table</code>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">{flatbuffers.Offset}</td><td>root_table </td></tr>
<tr><td class="paramname">{string=}</td><td>opt_file_identifier </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga0d1738111b83dffb2c2a7fc8bca19b33"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">flatbuffers <a class="el" href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">Builder</a> prototype forceDefaults</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= <span class="keyword">function</span>(<a class="code" href="group__flatbuffers__javascript__api.html#ga0d1738111b83dffb2c2a7fc8bca19b33">forceDefaults</a>) {</div>
<div class="line"> this.force_defaults = <a class="code" href="group__flatbuffers__javascript__api.html#ga0d1738111b83dffb2c2a7fc8bca19b33">forceDefaults</a>;</div>
<div class="line">}</div>
<div class="ttc" id="group__flatbuffers__javascript__api_html_ga0d1738111b83dffb2c2a7fc8bca19b33"><div class="ttname"><a href="group__flatbuffers__javascript__api.html#ga0d1738111b83dffb2c2a7fc8bca19b33">forceDefaults</a></div><div class="ttdeci">flatbuffers Builder prototype forceDefaults</div><div class="ttdoc">In order to save space, fields that are set to their default value don't get serialized into the buff...</div><div class="ttdef"><b>Definition:</b> flatbuffers.js:227</div></div>
</div><!-- fragment -->
<p>In order to save space, fields that are set to their default value don't get serialized into the buffer. </p>
<p>Forcing defaults provides a way to manually disable this optimization.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">{boolean}</td><td>forceDefaults true always serializes default values </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- Google Analytics -->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-49880327-7', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>