| <!-- 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.9.1"/> |
| <title>FlatBuffers: Google\FlatBuffers\FlatbufferBuilder Class 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="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> |
| <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.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> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></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"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('class_google_1_1_flat_buffers_1_1_flatbuffer_builder.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="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Google\FlatBuffers\FlatbufferBuilder Class Reference<div class="ingroups"><a class="el" href="group__flatbuffers__php__api.html">Flatbuffers_php_api</a></div></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a5aa5323732b1efe0da24fa235a40f5d4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a5aa5323732b1efe0da24fa235a40f5d4">__construct</a> ($initial_size)</td></tr> |
| <tr class="memdesc:a5aa5323732b1efe0da24fa235a40f5d4"><td class="mdescLeft"> </td><td class="mdescRight">Create a FlatBufferBuilder with a given initial size. <a href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a5aa5323732b1efe0da24fa235a40f5d4">More...</a><br /></td></tr> |
| <tr class="separator:a5aa5323732b1efe0da24fa235a40f5d4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a723a1053d3a17d5433c37bdbd015844e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a723a1053d3a17d5433c37bdbd015844e">addBool</a> ($x)</td></tr> |
| <tr class="memdesc:a723a1053d3a17d5433c37bdbd015844e"><td class="mdescLeft"> </td><td class="mdescRight">Add a <code>bool</code> to the buffer, properly aligned, and grows the buffer (if necessary). <a href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a723a1053d3a17d5433c37bdbd015844e">More...</a><br /></td></tr> |
| <tr class="separator:a723a1053d3a17d5433c37bdbd015844e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7b78098530190cb90d315419fb1d21fc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a7b78098530190cb90d315419fb1d21fc">addByte</a> ($x)</td></tr> |
| <tr class="memdesc:a7b78098530190cb90d315419fb1d21fc"><td class="mdescLeft"> </td><td class="mdescRight">Add a <code>byte</code> to the buffer, properly aligned, and grows the buffer (if necessary). <a href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a7b78098530190cb90d315419fb1d21fc">More...</a><br /></td></tr> |
| <tr class="separator:a7b78098530190cb90d315419fb1d21fc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a23a5478774e8909117d31b62dde51e86"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a23a5478774e8909117d31b62dde51e86">addDouble</a> ($x)</td></tr> |
| <tr class="memdesc:a23a5478774e8909117d31b62dde51e86"><td class="mdescLeft"> </td><td class="mdescRight">Add a <code>double</code> to the buffer, properly aligned, and grows the buffer (if necessary). <a href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a23a5478774e8909117d31b62dde51e86">More...</a><br /></td></tr> |
| <tr class="separator:a23a5478774e8909117d31b62dde51e86"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5ce6215b65e222b8ee22d3eb4436e404"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a5ce6215b65e222b8ee22d3eb4436e404">addFloat</a> ($x)</td></tr> |
| <tr class="memdesc:a5ce6215b65e222b8ee22d3eb4436e404"><td class="mdescLeft"> </td><td class="mdescRight">Add a <code>float</code> to the buffer, properly aligned, and grows the buffer (if necessary). <a href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a5ce6215b65e222b8ee22d3eb4436e404">More...</a><br /></td></tr> |
| <tr class="separator:a5ce6215b65e222b8ee22d3eb4436e404"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a63c9d66329dff15855d11c89134599e0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a63c9d66329dff15855d11c89134599e0">addInt</a> ($x)</td></tr> |
| <tr class="memdesc:a63c9d66329dff15855d11c89134599e0"><td class="mdescLeft"> </td><td class="mdescRight">Add an <code>int</code> to the buffer, properly aligned, and grows the buffer (if necessary). <a href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a63c9d66329dff15855d11c89134599e0">More...</a><br /></td></tr> |
| <tr class="separator:a63c9d66329dff15855d11c89134599e0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8875bff7ef67af16938cabe719ceac70"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a8875bff7ef67af16938cabe719ceac70">addLong</a> ($x)</td></tr> |
| <tr class="memdesc:a8875bff7ef67af16938cabe719ceac70"><td class="mdescLeft"> </td><td class="mdescRight">Add a <code>long</code> to the buffer, properly aligned, and grows the buffer (if necessary). <a href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a8875bff7ef67af16938cabe719ceac70">More...</a><br /></td></tr> |
| <tr class="separator:a8875bff7ef67af16938cabe719ceac70"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a127fe515651f4b4347ea8e01b3951934"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a127fe515651f4b4347ea8e01b3951934">addOffset</a> ($off)</td></tr> |
| <tr class="memdesc:a127fe515651f4b4347ea8e01b3951934"><td class="mdescLeft"> </td><td class="mdescRight">Adds on offset, relative to where it will be written. <a href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a127fe515651f4b4347ea8e01b3951934">More...</a><br /></td></tr> |
| <tr class="separator:a127fe515651f4b4347ea8e01b3951934"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6add2b19644657fbe0925cb0238618c6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a6add2b19644657fbe0925cb0238618c6">addSbyte</a> ($x)</td></tr> |
| <tr class="memdesc:a6add2b19644657fbe0925cb0238618c6"><td class="mdescLeft"> </td><td class="mdescRight">Add a <code>signed byte</code> to the buffer, properly aligned, and grows the buffer (if necessary). <a href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a6add2b19644657fbe0925cb0238618c6">More...</a><br /></td></tr> |
| <tr class="separator:a6add2b19644657fbe0925cb0238618c6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1e11aa1f080749100de6e153e88f9dd5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a1e11aa1f080749100de6e153e88f9dd5">addShort</a> ($x)</td></tr> |
| <tr class="memdesc:a1e11aa1f080749100de6e153e88f9dd5"><td class="mdescLeft"> </td><td class="mdescRight">Add a <code>short</code> to the buffer, properly aligned, and grows the buffer (if necessary). <a href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a1e11aa1f080749100de6e153e88f9dd5">More...</a><br /></td></tr> |
| <tr class="separator:a1e11aa1f080749100de6e153e88f9dd5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6f4a37444fca01dcbd0922d18cf2be5c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a6f4a37444fca01dcbd0922d18cf2be5c">addUint</a> ($x)</td></tr> |
| <tr class="memdesc:a6f4a37444fca01dcbd0922d18cf2be5c"><td class="mdescLeft"> </td><td class="mdescRight">Add an <code>unsigned int</code> to the buffer, properly aligned, and grows the buffer (if necessary). <a href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a6f4a37444fca01dcbd0922d18cf2be5c">More...</a><br /></td></tr> |
| <tr class="separator:a6f4a37444fca01dcbd0922d18cf2be5c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a01be3a805c221796997b023b64e90826"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a01be3a805c221796997b023b64e90826">addUlong</a> ($x)</td></tr> |
| <tr class="memdesc:a01be3a805c221796997b023b64e90826"><td class="mdescLeft"> </td><td class="mdescRight">Add an <code>unsigned long</code> to the buffer, properly aligned, and grows the buffer (if necessary). <a href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a01be3a805c221796997b023b64e90826">More...</a><br /></td></tr> |
| <tr class="separator:a01be3a805c221796997b023b64e90826"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a570a0024a8a54e2f73374c94b8fa6c42"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a570a0024a8a54e2f73374c94b8fa6c42">addUshort</a> ($x)</td></tr> |
| <tr class="memdesc:a570a0024a8a54e2f73374c94b8fa6c42"><td class="mdescLeft"> </td><td class="mdescRight">Add an <code>unsigned short</code> to the buffer, properly aligned, and grows the buffer (if necessary). <a href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a570a0024a8a54e2f73374c94b8fa6c42">More...</a><br /></td></tr> |
| <tr class="separator:a570a0024a8a54e2f73374c94b8fa6c42"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac54a8acfac1dda020b610da53b2d9a0f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#ac54a8acfac1dda020b610da53b2d9a0f">createString</a> ($s)</td></tr> |
| <tr class="memdesc:ac54a8acfac1dda020b610da53b2d9a0f"><td class="mdescLeft"> </td><td class="mdescRight">Encode the string <code>$s</code> in the buffer using UTF-8. <a href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#ac54a8acfac1dda020b610da53b2d9a0f">More...</a><br /></td></tr> |
| <tr class="separator:ac54a8acfac1dda020b610da53b2d9a0f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae7e97c2d21da04ef483e6940d442938f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#ae7e97c2d21da04ef483e6940d442938f">dataBuffer</a> ()</td></tr> |
| <tr class="memdesc:ae7e97c2d21da04ef483e6940d442938f"><td class="mdescLeft"> </td><td class="mdescRight">Get the ByteBuffer representing the FlatBuffer. <a href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#ae7e97c2d21da04ef483e6940d442938f">More...</a><br /></td></tr> |
| <tr class="separator:ae7e97c2d21da04ef483e6940d442938f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a799f0d1cf0fff359d6d04768108cb2a5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a799f0d1cf0fff359d6d04768108cb2a5">finish</a> ($root_table, $identifier=null)</td></tr> |
| <tr class="memdesc:a799f0d1cf0fff359d6d04768108cb2a5"><td class="mdescLeft"> </td><td class="mdescRight">Finalize a buffer, pointing to the given <code>$root_table</code>. <a href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a799f0d1cf0fff359d6d04768108cb2a5">More...</a><br /></td></tr> |
| <tr class="separator:a799f0d1cf0fff359d6d04768108cb2a5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5d75bca1a17d58bb6e383a73761ba45f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a5d75bca1a17d58bb6e383a73761ba45f">forceDefaults</a> ($forceDefaults)</td></tr> |
| <tr class="memdesc:a5d75bca1a17d58bb6e383a73761ba45f"><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="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a5d75bca1a17d58bb6e383a73761ba45f">More...</a><br /></td></tr> |
| <tr class="separator:a5d75bca1a17d58bb6e383a73761ba45f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a967e7dc8f051d4e73b3155e3b281d7b4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a967e7dc8f051d4e73b3155e3b281d7b4">sizedByteArray</a> ()</td></tr> |
| <tr class="memdesc:a967e7dc8f051d4e73b3155e3b281d7b4"><td class="mdescLeft"> </td><td class="mdescRight">Utility function to copy and return the FlatBuffer data from the underlying ByteBuffer. <a href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#a967e7dc8f051d4e73b3155e3b281d7b4">More...</a><br /></td></tr> |
| <tr class="separator:a967e7dc8f051d4e73b3155e3b281d7b4"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> |
| Public Attributes</h2></td></tr> |
| <tr class="memitem:aa01f9205792614930138e19d3e310b7b"><td class="memItemLeft" align="right" valign="top"><a id="aa01f9205792614930138e19d3e310b7b"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_google_1_1_flat_buffers_1_1_flatbuffer_builder.html#aa01f9205792614930138e19d3e310b7b">$bb</a></td></tr> |
| <tr class="memdesc:aa01f9205792614930138e19d3e310b7b"><td class="mdescLeft"> </td><td class="mdescRight">Internal ByteBuffer for the FlatBuffer data. <br /></td></tr> |
| <tr class="separator:aa01f9205792614930138e19d3e310b7b"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a5aa5323732b1efe0da24fa235a40f5d4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5aa5323732b1efe0da24fa235a40f5d4">◆ </a></span>__construct()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Google\FlatBuffers\FlatbufferBuilder::__construct </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>$initial_size</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a FlatBufferBuilder with a given initial size. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">$initial_size</td><td>initial byte buffer size. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a723a1053d3a17d5433c37bdbd015844e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a723a1053d3a17d5433c37bdbd015844e">◆ </a></span>addBool()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Google\FlatBuffers\FlatbufferBuilder::addBool </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>$x</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Add a <code>bool</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">$x</td><td>The <code>bool</code> to add to the buffer. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a7b78098530190cb90d315419fb1d21fc"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7b78098530190cb90d315419fb1d21fc">◆ </a></span>addByte()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Google\FlatBuffers\FlatbufferBuilder::addByte </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>$x</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Add a <code>byte</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">$x</td><td>The <code>byte</code> to add to the buffer. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a23a5478774e8909117d31b62dde51e86"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a23a5478774e8909117d31b62dde51e86">◆ </a></span>addDouble()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Google\FlatBuffers\FlatbufferBuilder::addDouble </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>$x</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Add a <code>double</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">$x</td><td>The <code>double</code> to add to the buffer. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a5ce6215b65e222b8ee22d3eb4436e404"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5ce6215b65e222b8ee22d3eb4436e404">◆ </a></span>addFloat()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Google\FlatBuffers\FlatbufferBuilder::addFloat </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>$x</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Add a <code>float</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">$x</td><td>The <code>float</code> to add to the buffer. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a63c9d66329dff15855d11c89134599e0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a63c9d66329dff15855d11c89134599e0">◆ </a></span>addInt()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Google\FlatBuffers\FlatbufferBuilder::addInt </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>$x</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Add an <code>int</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">$x</td><td>The <code>int</code> to add to the buffer. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a8875bff7ef67af16938cabe719ceac70"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8875bff7ef67af16938cabe719ceac70">◆ </a></span>addLong()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Google\FlatBuffers\FlatbufferBuilder::addLong </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>$x</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Add a <code>long</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">$x</td><td>The <code>long</code> to add to the buffer. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a127fe515651f4b4347ea8e01b3951934"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a127fe515651f4b4347ea8e01b3951934">◆ </a></span>addOffset()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Google\FlatBuffers\FlatbufferBuilder::addOffset </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>$off</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <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">$off</td><td>The offset to add to the buffer. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"></td><td></td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a6add2b19644657fbe0925cb0238618c6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6add2b19644657fbe0925cb0238618c6">◆ </a></span>addSbyte()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Google\FlatBuffers\FlatbufferBuilder::addSbyte </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>$x</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Add a <code>signed byte</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">$x</td><td>The <code>signed byte</code> to add to the buffer. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a1e11aa1f080749100de6e153e88f9dd5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1e11aa1f080749100de6e153e88f9dd5">◆ </a></span>addShort()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Google\FlatBuffers\FlatbufferBuilder::addShort </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>$x</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Add a <code>short</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">$x</td><td>The <code>short</code> to add to the buffer. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a6f4a37444fca01dcbd0922d18cf2be5c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6f4a37444fca01dcbd0922d18cf2be5c">◆ </a></span>addUint()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Google\FlatBuffers\FlatbufferBuilder::addUint </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>$x</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Add an <code>unsigned int</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">$x</td><td>The <code>unsigned int</code> to add to the buffer. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a01be3a805c221796997b023b64e90826"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a01be3a805c221796997b023b64e90826">◆ </a></span>addUlong()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Google\FlatBuffers\FlatbufferBuilder::addUlong </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>$x</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Add an <code>unsigned long</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">$x</td><td>The <code>unsigned long</code> to add to the buffer. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a570a0024a8a54e2f73374c94b8fa6c42"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a570a0024a8a54e2f73374c94b8fa6c42">◆ </a></span>addUshort()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Google\FlatBuffers\FlatbufferBuilder::addUshort </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>$x</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Add an <code>unsigned short</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">$x</td><td>The <code>unsigned short</code> to add to the buffer. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ac54a8acfac1dda020b610da53b2d9a0f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac54a8acfac1dda020b610da53b2d9a0f">◆ </a></span>createString()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Google\FlatBuffers\FlatbufferBuilder::createString </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>$s</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Encode the string <code>$s</code> in the buffer using UTF-8. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramtype">string</td><td class="paramname">$s</td><td>The string to encode. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>int The offset in the buffer where the encoded string starts. </dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname">InvalidArgumentException</td><td>Thrown if the input string <code>$s</code> is not UTF-8. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ae7e97c2d21da04ef483e6940d442938f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae7e97c2d21da04ef483e6940d442938f">◆ </a></span>dataBuffer()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Google\FlatBuffers\FlatbufferBuilder::dataBuffer </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the ByteBuffer representing the FlatBuffer. </p> |
| <dl class="section return"><dt>Returns</dt><dd>ByteBuffer The ByteBuffer containing the FlatBuffer data. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a799f0d1cf0fff359d6d04768108cb2a5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a799f0d1cf0fff359d6d04768108cb2a5">◆ </a></span>finish()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Google\FlatBuffers\FlatbufferBuilder::finish </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>$root_table</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>$identifier</em> = <code>null</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Finalize a buffer, pointing to the given <code>$root_table</code>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">$root_table</td><td>An offest to be added to the buffer. </td></tr> |
| <tr><td class="paramname">$file_identifier</td><td>A FlatBuffer file identifier to be added to the buffer before <code>$root_table</code>. This defaults to <code>null</code>. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname">InvalidArgumentException</td><td>Thrown if an invalid <code>$identifier</code> is given, where its length is not equal to <code>Constants::FILE_IDENTIFIER_LENGTH</code>. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a5d75bca1a17d58bb6e383a73761ba45f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5d75bca1a17d58bb6e383a73761ba45f">◆ </a></span>forceDefaults()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Google\FlatBuffers\FlatbufferBuilder::forceDefaults </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>$forceDefaults</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>In order to save space, fields that are set to their default value don't get serialized into the buffer. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramtype">bool</td><td class="paramname">$forceDefaults</td><td>When set to <code>true</code>, always serializes default values. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a967e7dc8f051d4e73b3155e3b281d7b4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a967e7dc8f051d4e73b3155e3b281d7b4">◆ </a></span>sizedByteArray()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Google\FlatBuffers\FlatbufferBuilder::sizedByteArray </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Utility function to copy and return the FlatBuffer data from the underlying ByteBuffer. </p> |
| <dl class="section return"><dt>Returns</dt><dd>string A string (representing a byte[]) that contains a copy of the FlatBuffer data. </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li><a class="el" href="_flatbuffer_builder_8php.html">FlatbufferBuilder.php</a></li> |
| </ul> |
| </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> |
