Skip to content

Commit

Permalink
Deploy preview for PR 1379 🛫
Browse files Browse the repository at this point in the history
  • Loading branch information
GCeSilva committed Nov 29, 2024
1 parent bcb899b commit 140a67e
Show file tree
Hide file tree
Showing 71 changed files with 3,276 additions and 93 deletions.
8 changes: 8 additions & 0 deletions preview/pr-1379/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -485,8 +485,14 @@ <h1>Classes</h1>
<li>struct <a href="structcubos_1_1engine_1_1DrawsTo.html" class="m-doc">DrawsTo</a> <span class="m-doc">Relation which indicates the &#x27;from&#x27; entity is a camera that draws to the &#x27;to&#x27; target.</span></li>
<li>class <a href="classcubos_1_1engine_1_1FileBridge.html" class="m-doc">FileBridge</a> <span class="m-doc">Abstract bridge type defined to reduce boilerplate code in bridge implementations which open a single file to load and save assets.</span></li>
<li>struct <a href="structcubos_1_1engine_1_1FixedDeltaTime.html" class="m-doc">FixedDeltaTime</a> <span class="m-doc">Resource which holds the value of the fixed delta for the fixedStep plugin.</span></li>
<li>class <a href="classcubos_1_1engine_1_1Font.html" class="m-doc">Font</a> <span class="m-doc"><a href="classcubos_1_1engine_1_1Asset.html" class="m-doc">Asset</a> containing raw font data containing the glyphs and their shape. This is used to create <a href="classcubos_1_1engine_1_1FontAtlas.html" class="m-doc">FontAtlas</a> that can be used for rendering text.</span></li>
<li>class <a href="classcubos_1_1engine_1_1FontAtlas.html" class="m-doc">FontAtlas</a> <span class="m-doc">Class that holds all the necessary data about a font atlas. This font atlas represents the texure created from all the different glyphs in a font, that will be then used for drawing the text.</span></li>
<li>class <a href="classcubos_1_1engine_1_1FontAtlasBridge.html" class="m-doc">FontAtlasBridge</a> <span class="m-doc">Bridge which loads <a href="classcubos_1_1engine_1_1FontAtlas.html" class="m-doc">FontAtlas</a> assets.</span></li>
<li>class <a href="classcubos_1_1engine_1_1FontBridge.html" class="m-doc">FontBridge</a> <span class="m-doc">Bridge which loads <a href="classcubos_1_1engine_1_1Font.html" class="m-doc">Font</a> assets.</span></li>
<li>struct <a href="structcubos_1_1engine_1_1FontGlyph.html" class="m-doc">FontGlyph</a> <span class="m-doc">Struct that holds glyph data such as texcoords, position offsets and advance.</span></li>
<li>struct <a href="structcubos_1_1engine_1_1Force.html" class="m-doc">Force</a> <span class="m-doc">Component which holds forces applied on a particle.</span></li>
<li>struct <a href="structcubos_1_1engine_1_1FreeCameraController.html" class="m-doc">FreeCameraController</a> <span class="m-doc">Component which moves the camera.</span></li>
<li>struct <a href="structcubos_1_1engine_1_1FXAA.html" class="m-doc">FXAA</a> <span class="m-doc">Component which stores the <a href="structcubos_1_1engine_1_1FXAA.html" class="m-doc">FXAA</a> configuration for a render target.</span></li>
<li>struct <a href="structcubos_1_1engine_1_1GBuffer.html" class="m-doc">GBuffer</a> <span class="m-doc">Component which stores the <a href="structcubos_1_1engine_1_1GBuffer.html" class="m-doc">GBuffer</a> textures of a render target.</span></li>
<li>struct <a href="structcubos_1_1engine_1_1GBufferRasterizer.html" class="m-doc">GBufferRasterizer</a> <span class="m-doc">Component which stores the <a href="structcubos_1_1engine_1_1GBuffer.html" class="m-doc">GBuffer</a> rasterizer state.</span></li>
<li class="m-doc-collapsible collapsed">
Expand Down Expand Up @@ -584,6 +590,8 @@ <h1>Classes</h1>
<li>struct <a href="structcubos_1_1engine_1_1UIMatchHeight.html" class="m-doc">UIMatchHeight</a> <span class="m-doc">Component which makes a UI canvas scale to maintain vertical proportions.</span></li>
<li>struct <a href="structcubos_1_1engine_1_1UIMatchWidth.html" class="m-doc">UIMatchWidth</a> <span class="m-doc">Component which makes a UI canvas scale to maintain horizontal proportions.</span></li>
<li>struct <a href="structcubos_1_1engine_1_1UINativeAspectRatio.html" class="m-doc">UINativeAspectRatio</a> <span class="m-doc">Component which makes a UI element keep the aspect ratio of its source.</span></li>
<li>struct <a href="structcubos_1_1engine_1_1UIText.html" class="m-doc">UIText</a> <span class="m-doc">Component used to draw text on the UI.</span></li>
<li>struct <a href="structcubos_1_1engine_1_1UITextStretch.html" class="m-doc">UITextStretch</a> <span class="m-doc">Component which makes a UI element fit the text it has.</span></li>
<li>struct <a href="structcubos_1_1engine_1_1UIVerticalStretch.html" class="m-doc">UIVerticalStretch</a> <span class="m-doc">Component which makes a UI element fit vertically to its parent.</span></li>
<li>struct <a href="structcubos_1_1engine_1_1Velocity.html" class="m-doc">Velocity</a> <span class="m-doc">Component which holds velocity and forces applied on a particle.</span></li>
<li class="m-doc-collapsible collapsed">
Expand Down
132 changes: 132 additions & 0 deletions preview/pr-1379/atlas_8hpp.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>engine/font/atlas/atlas.hpp file | 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.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://cubosengine.org"><img src="Favicon.png" alt="" />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>
<span class="m-breadcrumb"><a href="dir_bafb7af0e03e95b24a45ff63060ab57b.html">engine</a>/</span><span class="m-breadcrumb"><a href="dir_5b3b50982cfbd8ab81afaa651274e081.html">font</a>/</span><span class="m-breadcrumb"><a href="dir_bba64b883136ac862802ef3d9ed8f701.html">atlas</a>/</span>atlas.hpp <span class="m-thin">file</span>
</h1>
<p>Struct <a href="classcubos_1_1engine_1_1FontAtlas.html" class="m-doc">cubos::<wbr />engine::<wbr />FontAtlas</a>.</p>
<nav class="m-block m-default">
<h3>Contents</h3>
<ul>
<li>
Reference
<ul>
<li><a href="#namespaces">Namespaces</a></li>
<li><a href="#nested-classes">Classes</a></li>
</ul>
</li>
</ul>
</nav>
<section id="namespaces">
<h2><a href="#namespaces">Namespaces</a></h2>
<dl class="m-doc">
<dt>namespace <a href="namespacecubos.html" class="m-doc">cubos</a></dt>
<dd><strong>Cubos</strong> libraries namespace.</dd>
<dt>namespace <a href="namespacecubos_1_1engine.html" class="m-doc">cubos::engine</a></dt>
<dd><a href="group__engine.html" class="m-doc">Engine</a> module.</dd>
</dl>
</section>
<section id="nested-classes">
<h2><a href="#nested-classes">Classes</a></h2>
<dl class="m-doc">
<dt>
class <a href="classcubos_1_1engine_1_1FontAtlas.html" class="m-doc">cubos::engine::FontAtlas</a>
</dt>
<dd>Class that holds all the necessary data about a font atlas. This font atlas represents the texure created from all the different glyphs in a font, that will be then used for drawing the text.</dd>
</dl>
</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">&hellip;</div>
</div>
<div class="m-doc-search-content">
<form>
<input type="search" name="q" id="search-input" placeholder="Loading &hellip;" 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">&darr;</span>
/ <span class="m-label m-dim">&uarr;</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>
5 changes: 5 additions & 0 deletions preview/pr-1379/classcubos_1_1engine_1_1AnyAsset.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,11 @@ <h2><a href="#derived-classes">Derived classes</a></h2>
class <a href="classcubos_1_1engine_1_1Asset.html" class="m-doc">Asset</a>
</dt>
<dd>Handle to an asset of a specific type.</dd>
<dt>
<div class="m-doc-template">template&lt;typename T&gt;</div>
class <a href="classcubos_1_1engine_1_1Asset.html" class="m-doc">Asset</a>
</dt>
<dd>Handle to an asset of a specific type.</dd>
</dl>
</section>
<section id="pub-types">
Expand Down
4 changes: 4 additions & 0 deletions preview/pr-1379/classcubos_1_1engine_1_1AssetBridge.html
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,10 @@ <h2><a href="#derived-classes">Derived classes</a></h2>
class <a href="classcubos_1_1engine_1_1FileBridge.html" class="m-doc">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>
<dt>
class <a href="classcubos_1_1engine_1_1FontAtlasBridge.html" class="m-doc">FontAtlasBridge</a>
</dt>
<dd>Bridge which loads <a href="classcubos_1_1engine_1_1FontAtlas.html" class="m-doc">FontAtlas</a> assets.</dd>
</dl>
</section>
<section id="typeless-methods">
Expand Down
4 changes: 4 additions & 0 deletions preview/pr-1379/classcubos_1_1engine_1_1FileBridge.html
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,10 @@ <h2><a href="#derived-classes">Derived classes</a></h2>
class <a href="classcubos_1_1engine_1_1AudioBridge.html" class="m-doc">AudioBridge</a>
</dt>
<dd>Bridge which loads and saves <a href="structcubos_1_1engine_1_1Audio.html" class="m-doc">Audio</a> assets.</dd>
<dt>
class <a href="classcubos_1_1engine_1_1FontBridge.html" class="m-doc">FontBridge</a>
</dt>
<dd>Bridge which loads <a href="classcubos_1_1engine_1_1Font.html" class="m-doc">Font</a> assets.</dd>
<dt>
class <a href="classcubos_1_1engine_1_1ImageBridge.html" class="m-doc">ImageBridge</a>
</dt>
Expand Down
Loading

0 comments on commit 140a67e

Please sign in to comment.