2.0.0 release

butano/include/bn_documentation.h

@@ -973,7 +973,7 @@
  * @tableofcontents
  *
  *
- * @section changelog_2_0_0 2.0.0 (next release)
+ * @section changelog_2_0_0 2.0.0
  *
  * * By removing some method overloads, lots of runtime asserts when creating resources have been removed.
  * * bn::palette_bpp_mode has been renamed to bn::bpp_mode and `bpp_mode()` methods have been renamed to `bpp()`.

butano/include/bn_sprite_tiles_ptr.h

@@ -181,8 +181,8 @@ class sprite_tiles_ptr
      *
      * @param tiles_item sprite_tiles_item which references the tiles to handle.
      * @param graphics_index Index of the tile set to reference in sprite_tiles_item.
-     * @return sprite_tiles_ptr which references tiles_item.graphics_tiles_ref(graphics_index) if it could be allocated;
-     * `nullopt` otherwise.
+     * @return sprite_tiles_ptr which references tiles_item.graphics_tiles_ref(graphics_index)
+     * if it could be allocated; `nullopt` otherwise.
      */
     [[nodiscard]] static optional<sprite_tiles_ptr> create_new_optional(const sprite_tiles_item& tiles_item,
                                                                         int graphics_index);

butano/include/bn_version.h

@@ -27,7 +27,7 @@ namespace bn::version
      */
     [[nodiscard]] constexpr int major()
     {
-        return 1;
+        return 2;
     }
 
     /**

docs/changelog.html

@@ -52,15 +52,15 @@ <h1>
         <div class="m-block m-default">
           <h3>Contents</h3>
           <ul>
-            <li><a href="#changelog_2_0_0">2.0.0 (next release)</a></li>
+            <li><a href="#changelog_2_0_0">2.0.0</a></li>
             <li><a href="#changelog_1_0_0">1.0.0</a></li>
             <li><a href="#changelog_0_4_0">0.4.0</a></li>
             <li><a href="#changelog_0_3_0">0.3.0</a></li>
             <li><a href="#changelog_0_2_0">0.2.0</a></li>
             <li><a href="#changelog_0_1_0">0.1.0</a></li>
           </ul>
         </div>
-<section id="changelog_2_0_0"><h2><a href="#changelog_2_0_0">2.0.0 (next release)</a></h2><ul><li>By removing some method overloads, lots of runtime asserts when creating resources have been removed.</li><li>bn::palette_bpp_mode has been renamed to <a href="group__color.html#ga297688ff852c5695452017a2622cb204" class="m-doc">bn::<wbr />bpp_mode</a> and <code><a href="group__color.html#ga297688ff852c5695452017a2622cb204" class="m-doc">bpp_<wbr />mode()</a></code> methods have been renamed to <code>bpp()</code>.</li><li>8 bits per pixel background tiles allocation fixed.</li></ul></section><section id="changelog_1_0_0"><h2><a href="#changelog_1_0_0">1.0.0</a></h2><ul><li>Regular maps bigger than 512x512 supported.</li><li>Division by 0 assert added.</li><li><a href="classbn_1_1regular__bg__item.html" class="m-doc">bn::<wbr />regular_bg_item</a> maximum tiles check added.</li><li><a href="classbn_1_1regular__bg__item.html" class="m-doc">bn::<wbr />regular_bg_item</a> generation options fixed.</li></ul></section><section id="changelog_0_4_0"><h2><a href="#changelog_0_4_0">0.4.0</a></h2><ul><li><code>btn</code> renamed to <code>bn</code>. No more API breaks will be made between minor releases after 1.0.0, promise.</li><li>Background tiles manager status can be printed in the log with <a href="namespacebn_1_1bg__tiles.html#ad5a2942ef2949f9df246367e55a8f46a" class="m-doc">bn::<wbr />bg_tiles::<wbr />log_status()</a>. This is done automatically when a non-optional background tiles allocation fails too.</li><li>Background regular maps manager status can be printed in the log with <a href="namespacebn_1_1bg__maps.html#ab9a11f9072c42e4843cecc10690ce1aa" class="m-doc">bn::<wbr />bg_maps::<wbr />log_status()</a>. This is done automatically when a non-optional regular background map allocation fails too.</li><li>Sprite tiles manager status can be printed in the log with <a href="namespacebn_1_1sprite__tiles.html#ac38355bc66b2f69750241c73662dcf6c" class="m-doc">bn::<wbr />sprite_tiles::<wbr />log_status()</a>. This is done automatically when a non-optional sprite tiles allocation fails too.</li><li>Color palettes managers status can be printed in the log with <a href="namespacebn_1_1bg__palettes.html#a34c88e1d5175821828bfa1a87f3d9a6e" class="m-doc">bn::<wbr />bg_palettes::<wbr />log_status()</a> and <a href="namespacebn_1_1sprite__palettes.html#a029d633f1be5d839af468a9c8e02b986" class="m-doc">bn::<wbr />sprite_palettes::<wbr />log_status()</a>. This is done automatically when a non-optional color palette allocation fails too.</li><li>Sprites destruction optimized.</li><li>Setters with an optional parameter added to some classes.</li><li>Optional components documentation fixed.</li><li>Other documentation improvements.</li></ul></section><section id="changelog_0_3_0"><h2><a href="#changelog_0_3_0">0.3.0</a></h2><ul><li>Sprites update performance improved up to 30% in Butano Fighter thanks to avoid rebuilding sprites list as much as possible.</li><li>Profiler can show the maximum measured ticks per entry.</li><li>Assets tools print output binaries size.</li></ul></section><section id="changelog_0_2_0"><h2><a href="#changelog_0_2_0">0.2.0</a></h2><ul><li>Performance improved up to 12% in Butano Fighter without <code>-flto</code> thanks to using less build translation units.</li><li>Documentation improved.</li></ul></section><section id="changelog_0_1_0"><h2><a href="#changelog_0_1_0">0.1.0</a></h2><p>First release.</p></section>
+<section id="changelog_2_0_0"><h2><a href="#changelog_2_0_0">2.0.0</a></h2><ul><li>By removing some method overloads, lots of runtime asserts when creating resources have been removed.</li><li>bn::palette_bpp_mode has been renamed to <a href="group__color.html#ga297688ff852c5695452017a2622cb204" class="m-doc">bn::<wbr />bpp_mode</a> and <code><a href="group__color.html#ga297688ff852c5695452017a2622cb204" class="m-doc">bpp_<wbr />mode()</a></code> methods have been renamed to <code>bpp()</code>.</li><li>8 bits per pixel background tiles allocation fixed.</li></ul></section><section id="changelog_1_0_0"><h2><a href="#changelog_1_0_0">1.0.0</a></h2><ul><li>Regular maps bigger than 512x512 supported.</li><li>Division by 0 assert added.</li><li><a href="classbn_1_1regular__bg__item.html" class="m-doc">bn::<wbr />regular_bg_item</a> maximum tiles check added.</li><li><a href="classbn_1_1regular__bg__item.html" class="m-doc">bn::<wbr />regular_bg_item</a> generation options fixed.</li></ul></section><section id="changelog_0_4_0"><h2><a href="#changelog_0_4_0">0.4.0</a></h2><ul><li><code>btn</code> renamed to <code>bn</code>. No more API breaks will be made between minor releases after 1.0.0, promise.</li><li>Background tiles manager status can be printed in the log with <a href="namespacebn_1_1bg__tiles.html#ad5a2942ef2949f9df246367e55a8f46a" class="m-doc">bn::<wbr />bg_tiles::<wbr />log_status()</a>. This is done automatically when a non-optional background tiles allocation fails too.</li><li>Background regular maps manager status can be printed in the log with <a href="namespacebn_1_1bg__maps.html#ab9a11f9072c42e4843cecc10690ce1aa" class="m-doc">bn::<wbr />bg_maps::<wbr />log_status()</a>. This is done automatically when a non-optional regular background map allocation fails too.</li><li>Sprite tiles manager status can be printed in the log with <a href="namespacebn_1_1sprite__tiles.html#ac38355bc66b2f69750241c73662dcf6c" class="m-doc">bn::<wbr />sprite_tiles::<wbr />log_status()</a>. This is done automatically when a non-optional sprite tiles allocation fails too.</li><li>Color palettes managers status can be printed in the log with <a href="namespacebn_1_1bg__palettes.html#a34c88e1d5175821828bfa1a87f3d9a6e" class="m-doc">bn::<wbr />bg_palettes::<wbr />log_status()</a> and <a href="namespacebn_1_1sprite__palettes.html#a029d633f1be5d839af468a9c8e02b986" class="m-doc">bn::<wbr />sprite_palettes::<wbr />log_status()</a>. This is done automatically when a non-optional color palette allocation fails too.</li><li>Sprites destruction optimized.</li><li>Setters with an optional parameter added to some classes.</li><li>Optional components documentation fixed.</li><li>Other documentation improvements.</li></ul></section><section id="changelog_0_3_0"><h2><a href="#changelog_0_3_0">0.3.0</a></h2><ul><li>Sprites update performance improved up to 30% in Butano Fighter thanks to avoid rebuilding sprites list as much as possible.</li><li>Profiler can show the maximum measured ticks per entry.</li><li>Assets tools print output binaries size.</li></ul></section><section id="changelog_0_2_0"><h2><a href="#changelog_0_2_0">0.2.0</a></h2><ul><li>Performance improved up to 12% in Butano Fighter without <code>-flto</code> thanks to using less build translation units.</li><li>Documentation improved.</li></ul></section><section id="changelog_0_1_0"><h2><a href="#changelog_0_1_0">0.1.0</a></h2><p>First release.</p></section>
       </div>
     </div>
   </div>

docs_tools/Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = Butano
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 1.0.0
+PROJECT_NUMBER         = 2.0.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a