-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
412 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
260 changes: 260 additions & 0 deletions
260
docs-preview/pr-919/classcubos_1_1engine_1_1old_1_1JSONBridge.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,260 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8" /> | ||
| <title>cubos::engine::old::JSONBridge class | CUBOS. Docs</title> | ||
| <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" /> | ||
| <link rel="stylesheet" href="m-dark+documentation.compiled.css" /> | ||
| <link rel="icon" href="favicon-dark.png" type="image/png" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
| <meta name="theme-color" content="#22272e" /> | ||
| </head> | ||
| <body> | ||
| <header><nav id="navigation"> | ||
| <div class="m-container"> | ||
| <div class="m-row"> | ||
| <span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m"> | ||
| <a href="https://gamedevtecnico.github.io/cubos/">CUBOS.</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">Docs</a> | ||
| </span> | ||
| <div class="m-col-t-4 m-hide-m m-text-right m-nopadr"> | ||
| <a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16"> | ||
| <path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/> | ||
| </svg></a> | ||
| <a id="m-navbar-show" href="#navigation" title="Show navigation"></a> | ||
| <a id="m-navbar-hide" href="#" title="Hide navigation"></a> | ||
| </div> | ||
| <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m"> | ||
| <div class="m-row"> | ||
| <ol class="m-col-t-6 m-col-m-none"> | ||
| <li><a href="pages.html">Pages</a></li> | ||
| <li><a href="modules.html">Modules</a></li> | ||
| </ol> | ||
| <ol class="m-col-t-6 m-col-m-none" start="3"> | ||
| <li><a href="annotated.html">Classes</a></li> | ||
| <li><a href="files.html">Files</a></li> | ||
| <li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16"> | ||
| <use href="#m-doc-search-icon-path" /> | ||
| </svg></a></li> | ||
| </ol> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </nav></header> | ||
| <main><article> | ||
| <div class="m-container m-container-inflatable"> | ||
| <div class="m-row"> | ||
| <div class="m-col-l-10 m-push-l-1"> | ||
| <h1> | ||
| <div class="m-doc-include m-code m-inverted m-right-m m-text-right"><span class="cp">#include</span> <a class="cpf" href="engine_2include_2cubos_2engine_2assets_2bridges_2old_2json_8hpp.html"><engine/assets/bridges/old/json.hpp></a></div> | ||
| <div class="m-doc-template">template<typename T></div> | ||
| <span class="m-breadcrumb"><a href="namespacecubos.html">cubos</a>::<wbr/></span><span class="m-breadcrumb"><a href="namespacecubos_1_1engine.html">engine</a>::<wbr/></span><span class="m-breadcrumb"><a href="namespacecubos_1_1engine_1_1old.html">old</a>::<wbr/></span>JSONBridge <span class="m-thin">class</span> | ||
| </h1> | ||
| <p>Bridge for loading and saving assets which are serialized to and from a JSON file.</p> | ||
| <table class="m-table m-fullwidth m-flat"> | ||
| <thead> | ||
| <tr><th colspan="2">Template parameters</th></tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td style="width: 1%">T</td> | ||
| <td>Type of asset to load and save. Must be default constructible.</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| <nav class="m-block m-default"> | ||
| <h3>Contents</h3> | ||
| <ul> | ||
| <li> | ||
| Reference | ||
| <ul> | ||
| <li><a href="#base-classes">Base classes</a></li> | ||
| <li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li> | ||
| <li><a href="#pro-methods">Protected functions</a></li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </nav> | ||
| <p>This bridge automatically serializes and deserializes assets of type <code>T</code> to and from a JSON file. Thus, <code>T</code> must be serializable and deserializable. No additional context is given to the serializer or deserializer.</p> | ||
| <section id="base-classes"> | ||
| <h2><a href="#base-classes">Base classes</a></h2> | ||
| <dl class="m-doc"> | ||
| <dt> | ||
| class <a href="classcubos_1_1engine_1_1FileBridge.html" class="m-doc">cubos::engine::FileBridge</a> | ||
| </dt> | ||
| <dd>Abstract bridge type defined to reduce boilerplate code in bridge implementations which open a single file to load and save assets.</dd> | ||
| </dl> | ||
| </section> | ||
| <section id="typeless-methods"> | ||
| <h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2> | ||
| <dl class="m-doc"> | ||
| <dt> | ||
| <span class="m-doc-wrap-bumper"><a href="#ac378f935a3b613ba94c5c901e8f00576" class="m-doc">JSONBridge</a>(</span><span class="m-doc-wrap">int indentation = 4)</span> | ||
| </dt> | ||
| <dd>Constructs a bridge.</dd> | ||
| </dl> | ||
| </section> | ||
| <section id="pro-methods"> | ||
| <h2><a href="#pro-methods">Protected functions</a></h2> | ||
| <dl class="m-doc"> | ||
| <dt> | ||
| <span class="m-doc-wrap-bumper">auto <a href="#a80e85db7872005e3ca9f582baa97c8bf" class="m-doc">loadFromFile</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1engine_1_1Assets.html" class="m-doc">Assets</a>& assets, | ||
| const <a href="classcubos_1_1engine_1_1AnyAsset.html" class="m-doc">AnyAsset</a>& handle, | ||
| <a href="classcubos_1_1core_1_1memory_1_1Stream.html" class="m-doc">core::<wbr />memory::<wbr />Stream</a>& stream) -> bool <span class="m-label m-flat m-warning">override</span></span> | ||
| </dt> | ||
| <dd>Loads an asset from a file stream.</dd> | ||
| <dt> | ||
| <span class="m-doc-wrap-bumper">auto <a href="#a32841f68b3416f88a6b0f0d0864a0e50" class="m-doc">saveToFile</a>(</span><span class="m-doc-wrap">const <a href="classcubos_1_1engine_1_1Assets.html" class="m-doc">Assets</a>& assets, | ||
| const <a href="classcubos_1_1engine_1_1AnyAsset.html" class="m-doc">AnyAsset</a>& handle, | ||
| <a href="classcubos_1_1core_1_1memory_1_1Stream.html" class="m-doc">core::<wbr />memory::<wbr />Stream</a>& stream) -> bool <span class="m-label m-flat m-warning">override</span></span> | ||
| </dt> | ||
| <dd>Saves an asset to a file stream.</dd> | ||
| </dl> | ||
| </section> | ||
| <section> | ||
| <h2>Function documentation</h2> | ||
| <section class="m-doc-details" id="ac378f935a3b613ba94c5c901e8f00576"><div> | ||
| <h3> | ||
| <div class="m-doc-template"> | ||
| template<typename T> | ||
| </div> | ||
| <span class="m-doc-wrap-bumper"> cubos::<wbr />engine::<wbr />old::<wbr />JSONBridge<T>::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ac378f935a3b613ba94c5c901e8f00576" class="m-doc-self">JSONBridge</a>(</span><span class="m-doc-wrap">int indentation = 4)</span></span> | ||
| </h3> | ||
| <p>Constructs a bridge.</p> | ||
| <table class="m-table m-fullwidth m-flat"> | ||
| <thead> | ||
| <tr><th colspan="2">Parameters</th></tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td style="width: 1%">indentation</td> | ||
| <td>Indentation level to use when saving the JSON file.</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| <p>If the <code>indentation</code> level is set to -1, all whitespace is removed.</p> | ||
| </div></section> | ||
| <section class="m-doc-details" id="a80e85db7872005e3ca9f582baa97c8bf"><div> | ||
| <h3> | ||
| <div class="m-doc-template"> | ||
| template<typename T> | ||
| </div> | ||
| <span class="m-doc-wrap-bumper">bool cubos::<wbr />engine::<wbr />old::<wbr />JSONBridge<T>::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a80e85db7872005e3ca9f582baa97c8bf" class="m-doc-self">loadFromFile</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1engine_1_1Assets.html" class="m-doc">Assets</a>& assets, | ||
| const <a href="classcubos_1_1engine_1_1AnyAsset.html" class="m-doc">AnyAsset</a>& handle, | ||
| <a href="classcubos_1_1core_1_1memory_1_1Stream.html" class="m-doc">core::<wbr />memory::<wbr />Stream</a>& stream) <span class="m-label m-warning">override</span> <span class="m-label m-warning">protected</span></span></span> | ||
| </h3> | ||
| <p>Loads an asset from a file stream.</p> | ||
| <table class="m-table m-fullwidth m-flat"> | ||
| <thead> | ||
| <tr><th colspan="2">Parameters</th></tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td style="width: 1%">assets</td> | ||
| <td>Manager to write into.</td> | ||
| </tr> | ||
| <tr> | ||
| <td>handle</td> | ||
| <td>Handle of the asset being loaded.</td> | ||
| </tr> | ||
| <tr> | ||
| <td>stream</td> | ||
| <td>File stream.</td> | ||
| </tr> | ||
| </tbody> | ||
| <tfoot> | ||
| <tr> | ||
| <th>Returns</th> | ||
| <td>Whether the asset was successfully loaded.</td> | ||
| </tr> | ||
| </tfoot> | ||
| </table> | ||
| </div></section> | ||
| <section class="m-doc-details" id="a32841f68b3416f88a6b0f0d0864a0e50"><div> | ||
| <h3> | ||
| <div class="m-doc-template"> | ||
| template<typename T> | ||
| </div> | ||
| <span class="m-doc-wrap-bumper">bool cubos::<wbr />engine::<wbr />old::<wbr />JSONBridge<T>::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a32841f68b3416f88a6b0f0d0864a0e50" class="m-doc-self">saveToFile</a>(</span><span class="m-doc-wrap">const <a href="classcubos_1_1engine_1_1Assets.html" class="m-doc">Assets</a>& assets, | ||
| const <a href="classcubos_1_1engine_1_1AnyAsset.html" class="m-doc">AnyAsset</a>& handle, | ||
| <a href="classcubos_1_1core_1_1memory_1_1Stream.html" class="m-doc">core::<wbr />memory::<wbr />Stream</a>& stream) <span class="m-label m-warning">override</span> <span class="m-label m-warning">protected</span></span></span> | ||
| </h3> | ||
| <p>Saves an asset to a file stream.</p> | ||
| <table class="m-table m-fullwidth m-flat"> | ||
| <thead> | ||
| <tr><th colspan="2">Parameters</th></tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td style="width: 1%">assets</td> | ||
| <td>Manager to read from.</td> | ||
| </tr> | ||
| <tr> | ||
| <td>handle</td> | ||
| <td>Handle of the asset being saved.</td> | ||
| </tr> | ||
| <tr> | ||
| <td>stream</td> | ||
| <td>File stream.</td> | ||
| </tr> | ||
| </tbody> | ||
| <tfoot> | ||
| <tr> | ||
| <th>Returns</th> | ||
| <td>Whether the asset was successfully saved.</td> | ||
| </tr> | ||
| </tfoot> | ||
| </table> | ||
| </div></section> | ||
| </section> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </article></main> | ||
| <div class="m-doc-search" id="search"> | ||
| <a href="#!" onclick="return hideSearch()"></a> | ||
| <div class="m-container"> | ||
| <div class="m-row"> | ||
| <div class="m-col-m-8 m-push-m-2"> | ||
| <div class="m-doc-search-header m-text m-small"> | ||
| <div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div> | ||
| <div id="search-symbolcount">…</div> | ||
| </div> | ||
| <div class="m-doc-search-content"> | ||
| <form> | ||
| <input type="search" name="q" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" /> | ||
| </form> | ||
| <noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript> | ||
| <div id="search-help" class="m-text m-dim m-text-center"> | ||
| <p class="m-noindent">Search for symbols, directories, files, pages or | ||
| modules. You can omit any prefix from the symbol or file path; adding a | ||
| <code>:</code> or <code>/</code> suffix lists all members of given symbol or | ||
| directory.</p> | ||
| <p class="m-noindent">Use <span class="m-label m-dim">↓</span> | ||
| / <span class="m-label m-dim">↑</span> to navigate through the list, | ||
| <span class="m-label m-dim">Enter</span> to go. | ||
| <span class="m-label m-dim">Tab</span> autocompletes common prefix, you can | ||
| copy a link to the result using <span class="m-label m-dim">⌘</span> | ||
| <span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span> | ||
| <span class="m-label m-dim">M</span> produces a Markdown link.</p> | ||
| </div> | ||
| <div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div> | ||
| <ul id="search-results"></ul> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <script src="search-v2.js"></script> | ||
| <script src="searchdata-v2.js" async="async"></script> | ||
| <footer><nav> | ||
| <div class="m-container"> | ||
| <div class="m-row"> | ||
| <div class="m-col-l-10 m-push-l-1"> | ||
| <p>CUBOS. Docs. Created with <a href="https://doxygen.org/">Doxygen</a> 1.9.1 and <a href="https://mcss.mosra.cz/">m.css</a>.</p> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </nav></footer> | ||
| </body> | ||
| </html> |
Oops, something went wrong.