blob: 2c1ebfdd9bf3f9afb2abc396344e3085494f200a [file] [log] [blame]
<!-- 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: flatbuffers.js File Reference</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&#160;Page</span></a></li>
<li><a href="usergroup0.html"><span>Programmer's&#160;Guide</span></a></li>
<li><a href="flatbuffers_support.html"><span>Platform&#160;/&#160;Language&#160;/&#160;Feature&#160;support</span></a></li>
<li><a href="flatbuffers_benchmarks.html"><span>Benchmarks</span></a></li>
<li><a href="flatbuffers_white_paper.html"><span>FlatBuffers&#160;white&#160;paper</span></a></li>
<li><a href="flatbuffers_internals.html"><span>FlatBuffers&#160;internals</span></a></li>
<li><a href="flatbuffers_grammar.html"><span>Grammar&#160;of&#160;the&#160;schema&#160;language</span></a></li>
<li><a href="usergroup2.html"><span>API&#160;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('flatbuffers_8js.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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Properties</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</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">flatbuffers.js File Reference</div> </div>
</div><!--header-->
<div class="contents">
<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&#160;</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">&#160;</td><td class="mdescRight">Add a <code>float32</code> to the buffer, properly aligned, and grows the buffer (if necessary). <a href="group__flatbuffers__javascript__api.html#ga1c36e9d7e294c61d1d6ab0923ea91e8e">More...</a><br /></td></tr>
<tr class="separator:ga1c36e9d7e294c61d1d6ab0923ea91e8e"><td class="memSeparator" colspan="2">&#160;</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&#160;</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">&#160;</td><td class="mdescRight">Add a <code>float64</code> to the buffer, properly aligned, and grows the buffer (if necessary). <a href="group__flatbuffers__javascript__api.html#ga53af3baf50f96de783c06a35934d63bf">More...</a><br /></td></tr>
<tr class="separator:ga53af3baf50f96de783c06a35934d63bf"><td class="memSeparator" colspan="2">&#160;</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&#160;</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">&#160;</td><td class="mdescRight">Add an <code>int16</code> to the buffer, properly aligned, and grows the buffer (if necessary). <a href="group__flatbuffers__javascript__api.html#ga8260b8431cb8b1c32b5997646cb102a9">More...</a><br /></td></tr>
<tr class="separator:ga8260b8431cb8b1c32b5997646cb102a9"><td class="memSeparator" colspan="2">&#160;</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&#160;</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">&#160;</td><td class="mdescRight">Add an <code>int32</code> to the buffer, properly aligned, and grows the buffer (if necessary). <a href="group__flatbuffers__javascript__api.html#gaba2edd0e1e53d1c2815bb1a6ee54abf5">More...</a><br /></td></tr>
<tr class="separator:gaba2edd0e1e53d1c2815bb1a6ee54abf5"><td class="memSeparator" colspan="2">&#160;</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&#160;</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">&#160;</td><td class="mdescRight">Add an <code>int64</code> to the buffer, properly aligned, and grows the buffer (if necessary). <a href="group__flatbuffers__javascript__api.html#ga17a48cc241b10348fd6751ed3a973e2d">More...</a><br /></td></tr>
<tr class="separator:ga17a48cc241b10348fd6751ed3a973e2d"><td class="memSeparator" colspan="2">&#160;</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&#160;</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">&#160;</td><td class="mdescRight">Add an <code>int8</code> to the buffer, properly aligned, and grows the buffer (if necessary). <a href="group__flatbuffers__javascript__api.html#ga7963cbb1ae0a8589b183f9b26fb25b45">More...</a><br /></td></tr>
<tr class="separator:ga7963cbb1ae0a8589b183f9b26fb25b45"><td class="memSeparator" colspan="2">&#160;</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&#160;</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">&#160;</td><td class="mdescRight">Adds on offset, relative to where it will be written. <a href="group__flatbuffers__javascript__api.html#ga21ba7dd4c33dafd6abb89568e4d9c8b8">More...</a><br /></td></tr>
<tr class="separator:ga21ba7dd4c33dafd6abb89568e4d9c8b8"><td class="memSeparator" colspan="2">&#160;</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&#160;</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">&#160;</td><td class="mdescRight">Get the bytes representing the FlatBuffer. <a href="group__flatbuffers__javascript__api.html#ga997af48d5c8f757fcb962168d67e33fb">More...</a><br /></td></tr>
<tr class="separator:ga997af48d5c8f757fcb962168d67e33fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabd00b65bbe9e9fbac55fe4982eb6cec8"><td class="memItemLeft" align="right" valign="top">flatbuffers&#160;</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">&#160;</td><td class="mdescRight">Create a FlatBufferBuilder. <a href="group__flatbuffers__javascript__api.html#gabd00b65bbe9e9fbac55fe4982eb6cec8">More...</a><br /></td></tr>
<tr class="separator:gabd00b65bbe9e9fbac55fe4982eb6cec8"><td class="memSeparator" colspan="2">&#160;</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&#160;</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">&#160;</td><td class="mdescRight">A helper function to avoid generated code depending on this file directly. <a href="group__flatbuffers__javascript__api.html#ga8c5bb4a00c46fb6665787fa9ff52089b">More...</a><br /></td></tr>
<tr class="separator:ga8c5bb4a00c46fb6665787fa9ff52089b"><td class="memSeparator" colspan="2">&#160;</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&#160;</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">&#160;</td><td class="mdescRight">Encode the string <code>s</code> in the buffer using UTF-8. <a href="group__flatbuffers__javascript__api.html#gaa7a7bd67cb1c3190792d4b2b3e66376f">More...</a><br /></td></tr>
<tr class="separator:gaa7a7bd67cb1c3190792d4b2b3e66376f"><td class="memSeparator" colspan="2">&#160;</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&#160;</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">&#160;</td><td class="mdescRight">Get the ByteBuffer representing the FlatBuffer. <a href="group__flatbuffers__javascript__api.html#ga674814e0816f06c8a29ab364d19bed60">More...</a><br /></td></tr>
<tr class="separator:ga674814e0816f06c8a29ab364d19bed60"><td class="memSeparator" colspan="2">&#160;</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&#160;</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">&#160;</td><td class="mdescRight">Finalize a buffer, poiting to the given <code>root_table</code>. <a href="group__flatbuffers__javascript__api.html#ga62c5cf622a7bbcfd49f21bddd8b9bef7">More...</a><br /></td></tr>
<tr class="separator:ga62c5cf622a7bbcfd49f21bddd8b9bef7"><td class="memSeparator" colspan="2">&#160;</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&#160;</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">&#160;</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="group__flatbuffers__javascript__api.html#ga0d1738111b83dffb2c2a7fc8bca19b33">More...</a><br /></td></tr>
<tr class="separator:ga0d1738111b83dffb2c2a7fc8bca19b33"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</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>