Deploy preview for PR 1378 🛫

GameDevTecnico · Nov 22, 2024 · abcea33 · abcea33
1 parent 4059d7a
commit abcea33
Show file tree

Hide file tree

Showing 10 changed files with 21 additions and 22 deletions.
diff --git a/preview/pr-1378/annotated.html b/preview/pr-1378/annotated.html
@@ -460,7 +460,7 @@ <h1>Classes</h1>
                   <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>struct <a href="structcubos_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 font data.</span></li>
-                  <li>struct <a href="structcubos_1_1engine_1_1FontAtlas.html" class="m-doc">FontAtlas</a> <span class="m-doc">Struct that holds all the necessay data about a font atlas.</span></li>
+                  <li>struct <a href="structcubos_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_1FontBridge.html" class="m-doc">FontBridge</a> <span class="m-doc">Bridge which loads and saves <a href="structcubos_1_1engine_1_1Font.html" class="m-doc">Font</a> assets.</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>

diff --git a/preview/pr-1378/atlas_8hpp.html b/preview/pr-1378/atlas_8hpp.html
@@ -76,7 +76,7 @@ <h2><a href="#nested-classes">Classes</a></h2>
             <dt>
               struct <a href="structcubos_1_1engine_1_1FontAtlas.html" class="m-doc">cubos::engine::FontAtlas</a>
             </dt>
-            <dd>Struct that holds all the necessay data about a font atlas.</dd>
+            <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>

diff --git a/preview/pr-1378/examples-engine-ui.html b/preview/pr-1378/examples-engine-ui.html
diff --git a/preview/pr-1378/group__core-gl.html b/preview/pr-1378/group__core-gl.html
@@ -176,7 +176,8 @@ <h2><a href="#enum-members">Enums</a></h2>
             </dt>
             <dd>Index format.</dd>
             <dt>
-              <span class="m-doc-wrap-bumper">enum class <a href="#gaddc177005230140ebc1319b5f5342881" class="m-doc">TextureFormat</a> { </span><span class="m-doc-wrap"><a href="#ggaddc177005230140ebc1319b5f5342881af0a6f506aa5b194a87ae1ac8ae197c1f" class="m-doc">R8SNorm</a>,
+              <span class="m-doc-wrap-bumper">enum class <a href="#gaddc177005230140ebc1319b5f5342881" class="m-doc">TextureFormat</a> { </span><span class="m-doc-wrap"><a href="#ggaddc177005230140ebc1319b5f5342881a19af1b10079fc313a35ed795b775415a" class="m-doc">RGB8UInt</a>,
+              <a href="#ggaddc177005230140ebc1319b5f5342881af0a6f506aa5b194a87ae1ac8ae197c1f" class="m-doc">R8SNorm</a>,
               <a href="#ggaddc177005230140ebc1319b5f5342881ad61354fa9f24e44c60534e4edf0f496d" class="m-doc">R16SNorm</a>,
               <a href="#ggaddc177005230140ebc1319b5f5342881a46c380f94f3087cd3e31bf99ee4b1e92" class="m-doc">RG8SNorm</a>,
               <a href="#ggaddc177005230140ebc1319b5f5342881a0d63a698872837baed5fe7e14d20034c" class="m-doc">RG16SNorm</a>,
@@ -204,7 +205,6 @@ <h2><a href="#enum-members">Enums</a></h2>
               <a href="#ggaddc177005230140ebc1319b5f5342881ae8bf59c37f9f97cb4d0edf054a935ac0" class="m-doc">R32Float</a>,
               <a href="#ggaddc177005230140ebc1319b5f5342881a84793afddd23d28be90f041bb018f9b2" class="m-doc">RG16Float</a>,
               <a href="#ggaddc177005230140ebc1319b5f5342881a886c4f569781f74850dcda931e9fbbde" class="m-doc">RG32Float</a>,
-              <a href="#ggaddc177005230140ebc1319b5f5342881a19af1b10079fc313a35ed795b775415a" class="m-doc">RGB8UInt</a>,
               <a href="#ggaddc177005230140ebc1319b5f5342881aa433c9289a39945f953638e3b7b76f9c" class="m-doc">RGB16Float</a>,
               <a href="#ggaddc177005230140ebc1319b5f5342881a509b02d498d3b6ac96165373a217f8c8" class="m-doc">RGB32Float</a>,
               <a href="#ggaddc177005230140ebc1319b5f5342881a63697d10d05db9e24af76c62c43c1b54" class="m-doc">RGBA16Float</a>,
@@ -593,6 +593,11 @@ <h3>
             <table class="m-table m-fullwidth m-flat m-doc">
               <thead><tr><th style="width: 1%">Enumerators</th><th></th></tr></thead>
               <tbody>
+                <tr>
+                  <td><a href="#ggaddc177005230140ebc1319b5f5342881a19af1b10079fc313a35ed795b775415a" class="m-doc-self" id="ggaddc177005230140ebc1319b5f5342881a19af1b10079fc313a35ed795b775415a">RGB8UInt</a></td>
+                  <td>
+                  </td>
+                </tr>
                 <tr>
                   <td><a href="#ggaddc177005230140ebc1319b5f5342881af0a6f506aa5b194a87ae1ac8ae197c1f" class="m-doc-self" id="ggaddc177005230140ebc1319b5f5342881af0a6f506aa5b194a87ae1ac8ae197c1f">R8SNorm</a></td>
                   <td>
@@ -761,12 +766,6 @@ <h3>
                   <p>2 channel 32 bits floating point.</p>
                   </td>
                 </tr>
-                <tr>
-                  <td><a href="#ggaddc177005230140ebc1319b5f5342881a19af1b10079fc313a35ed795b775415a" class="m-doc-self" id="ggaddc177005230140ebc1319b5f5342881a19af1b10079fc313a35ed795b775415a">RGB8UInt</a></td>
-                  <td>
-                  <p>3 channel 8 bits unsigned integer.</p>
-                  </td>
-                </tr>
                 <tr>
                   <td><a href="#ggaddc177005230140ebc1319b5f5342881aa433c9289a39945f953638e3b7b76f9c" class="m-doc-self" id="ggaddc177005230140ebc1319b5f5342881aa433c9289a39945f953638e3b7b76f9c">RGB16Float</a></td>
                   <td>

diff --git a/preview/pr-1378/group__font-plugin.html b/preview/pr-1378/group__font-plugin.html
@@ -86,7 +86,7 @@ <h2><a href="#nested-classes">Classes</a></h2>
             <dt>
               struct <a href="structcubos_1_1engine_1_1FontAtlas.html" class="m-doc">cubos::engine::FontAtlas</a>
             </dt>
-            <dd>Struct that holds all the necessay data about a font atlas.</dd>
+            <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>
             <dt>
               class <a href="classcubos_1_1engine_1_1FontBridge.html" class="m-doc">cubos::engine::FontBridge</a>
             </dt>

diff --git a/preview/pr-1378/namespacecubos_1_1core_1_1gl.html b/preview/pr-1378/namespacecubos_1_1core_1_1gl.html
@@ -174,7 +174,8 @@ <h2><a href="#enum-members">Enums</a></h2>
             </dt>
             <dd>Index format.</dd>
             <dt>
-              <span class="m-doc-wrap-bumper">enum class <a href="group__core-gl.html#gaddc177005230140ebc1319b5f5342881" class="m-doc">TextureFormat</a> { </span><span class="m-doc-wrap"><a href="#ggaddc177005230140ebc1319b5f5342881af0a6f506aa5b194a87ae1ac8ae197c1f" class="m-doc">R8SNorm</a>,
+              <span class="m-doc-wrap-bumper">enum class <a href="group__core-gl.html#gaddc177005230140ebc1319b5f5342881" class="m-doc">TextureFormat</a> { </span><span class="m-doc-wrap"><a href="#ggaddc177005230140ebc1319b5f5342881a19af1b10079fc313a35ed795b775415a" class="m-doc">RGB8UInt</a>,
+              <a href="#ggaddc177005230140ebc1319b5f5342881af0a6f506aa5b194a87ae1ac8ae197c1f" class="m-doc">R8SNorm</a>,
               <a href="#ggaddc177005230140ebc1319b5f5342881ad61354fa9f24e44c60534e4edf0f496d" class="m-doc">R16SNorm</a>,
               <a href="#ggaddc177005230140ebc1319b5f5342881a46c380f94f3087cd3e31bf99ee4b1e92" class="m-doc">RG8SNorm</a>,
               <a href="#ggaddc177005230140ebc1319b5f5342881a0d63a698872837baed5fe7e14d20034c" class="m-doc">RG16SNorm</a>,
@@ -202,7 +203,6 @@ <h2><a href="#enum-members">Enums</a></h2>
               <a href="#ggaddc177005230140ebc1319b5f5342881ae8bf59c37f9f97cb4d0edf054a935ac0" class="m-doc">R32Float</a>,
               <a href="#ggaddc177005230140ebc1319b5f5342881a84793afddd23d28be90f041bb018f9b2" class="m-doc">RG16Float</a>,
               <a href="#ggaddc177005230140ebc1319b5f5342881a886c4f569781f74850dcda931e9fbbde" class="m-doc">RG32Float</a>,
-              <a href="#ggaddc177005230140ebc1319b5f5342881a19af1b10079fc313a35ed795b775415a" class="m-doc">RGB8UInt</a>,
               <a href="#ggaddc177005230140ebc1319b5f5342881aa433c9289a39945f953638e3b7b76f9c" class="m-doc">RGB16Float</a>,
               <a href="#ggaddc177005230140ebc1319b5f5342881a509b02d498d3b6ac96165373a217f8c8" class="m-doc">RGB32Float</a>,
               <a href="#ggaddc177005230140ebc1319b5f5342881a63697d10d05db9e24af76c62c43c1b54" class="m-doc">RGBA16Float</a>,

diff --git a/preview/pr-1378/namespacecubos_1_1engine.html b/preview/pr-1378/namespacecubos_1_1engine.html
@@ -143,7 +143,7 @@ <h2><a href="#nested-classes">Classes</a></h2>
             <dt>
               struct <a href="structcubos_1_1engine_1_1FontAtlas.html" class="m-doc">FontAtlas</a>
             </dt>
-            <dd>Struct that holds all the necessay data about a font atlas.</dd>
+            <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>
             <dt>
               class <a href="classcubos_1_1engine_1_1FontBridge.html" class="m-doc">FontBridge</a>
             </dt>

diff --git a/preview/pr-1378/render__device_8hpp.html b/preview/pr-1378/render__device_8hpp.html
@@ -296,7 +296,8 @@ <h2><a href="#enum-members">Enums</a></h2>
             </dt>
             <dd>Index format.</dd>
             <dt>
-              <span class="m-doc-wrap-bumper">enum class <a href="group__core-gl.html#gaddc177005230140ebc1319b5f5342881" class="m-doc">TextureFormat</a> { </span><span class="m-doc-wrap"><a href="#ggaddc177005230140ebc1319b5f5342881af0a6f506aa5b194a87ae1ac8ae197c1f" class="m-doc">R8SNorm</a>,
+              <span class="m-doc-wrap-bumper">enum class <a href="group__core-gl.html#gaddc177005230140ebc1319b5f5342881" class="m-doc">TextureFormat</a> { </span><span class="m-doc-wrap"><a href="#ggaddc177005230140ebc1319b5f5342881a19af1b10079fc313a35ed795b775415a" class="m-doc">RGB8UInt</a>,
+              <a href="#ggaddc177005230140ebc1319b5f5342881af0a6f506aa5b194a87ae1ac8ae197c1f" class="m-doc">R8SNorm</a>,
               <a href="#ggaddc177005230140ebc1319b5f5342881ad61354fa9f24e44c60534e4edf0f496d" class="m-doc">R16SNorm</a>,
               <a href="#ggaddc177005230140ebc1319b5f5342881a46c380f94f3087cd3e31bf99ee4b1e92" class="m-doc">RG8SNorm</a>,
               <a href="#ggaddc177005230140ebc1319b5f5342881a0d63a698872837baed5fe7e14d20034c" class="m-doc">RG16SNorm</a>,
@@ -324,7 +325,6 @@ <h2><a href="#enum-members">Enums</a></h2>
               <a href="#ggaddc177005230140ebc1319b5f5342881ae8bf59c37f9f97cb4d0edf054a935ac0" class="m-doc">R32Float</a>,
               <a href="#ggaddc177005230140ebc1319b5f5342881a84793afddd23d28be90f041bb018f9b2" class="m-doc">RG16Float</a>,
               <a href="#ggaddc177005230140ebc1319b5f5342881a886c4f569781f74850dcda931e9fbbde" class="m-doc">RG32Float</a>,
-              <a href="#ggaddc177005230140ebc1319b5f5342881a19af1b10079fc313a35ed795b775415a" class="m-doc">RGB8UInt</a>,
               <a href="#ggaddc177005230140ebc1319b5f5342881aa433c9289a39945f953638e3b7b76f9c" class="m-doc">RGB16Float</a>,
               <a href="#ggaddc177005230140ebc1319b5f5342881a509b02d498d3b6ac96165373a217f8c8" class="m-doc">RGB32Float</a>,
               <a href="#ggaddc177005230140ebc1319b5f5342881a63697d10d05db9e24af76c62c43c1b54" class="m-doc">RGBA16Float</a>,

diff --git a/preview/pr-1378/searchdata-v2.js b/preview/pr-1378/searchdata-v2.js
diff --git a/preview/pr-1378/structcubos_1_1engine_1_1FontAtlas.html b/preview/pr-1378/structcubos_1_1engine_1_1FontAtlas.html
@@ -49,7 +49,7 @@ <h1>
           <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>FontAtlas <span class="m-thin">struct</span>
           <div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="atlas_8hpp.html">&lt;engine/font/atlas.hpp&gt;</a></div>
         </h1>
-        <p>Struct that holds all the necessay data about a font atlas.</p>
+        <p>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.</p>
         <nav class="m-block m-default">
           <h3>Contents</h3>
           <ul>
@@ -67,7 +67,7 @@ <h2><a href="#pub-attribs">Public variables</a></h2>
             <dt id="a458df12c1bf59e6c098bb3ab40585c6c">
               <a href="group__core-gl.html#ga0ae8900d7cc51e23143dd6c77cff24f7" class="m-doc">cubos::<wbr />core::<wbr />gl::<wbr />Texture2D</a> <a href="#a458df12c1bf59e6c098bb3ab40585c6c" class="m-doc-self">texture</a>
             </dt>
-            <dd>The created gpu texture for this font atlas.</dd>
+            <dd>GPU texture containing this font atlas.</dd>
             <dt id="a07820d87654836c274f984b02c3c29ca">
               std::unordered_map&lt;msdf_atlas::unicode_t, msdf_atlas::GlyphGeometry&gt; <a href="#a07820d87654836c274f984b02c3c29ca" class="m-doc-self">glyphs</a>
             </dt>