Changelog
10.5.0
- bn::
core:: vblank_callback and bn:: core:: set_vblank_callback added. - bn::
random:: update added. - H-Blank effects input data validation fixed.
10.4.0
- Avoid data decompression in V-Blank if possible.
- Audio updates can no longer be interrupted.
10.3.0
- bn::
bg_tiles:: allow_offset and bn:: bg_tiles:: set_allow_offset added. - Import tool now can generate regular and affine background tiles without maps nor palettes. See the Regular background tiles and the Affine background tiles import guides to learn how to import them.
- BPP mode can be specified when importing sprite tiles. See the Sprite tiles import guide to learn how to specify it.
- Audio updates can be interrupted.
- SRAM reads and writes optimized.
- BG blocks manager ROM usage reduced.
- agbabi memory routines updated.
- Missing
__FILE_NAME__macro check added. - Missing license files added.
10.2.0
- bn::
core_lock added. - bn::
reciprocal_16_lut added. - Memory operations like
memcpyandmemsetoptimized thanks to agbabi. - bn::
affine_mat_attributes scale setup optimized (CPU and ROM usage reduced). - bn::
atan2 and bn:: degrees_atan2 optimized thanks to agbabi. - Unused interrupts removed from the interrupt manager.
- More questions added to Frequently asked questions (FAQ) page.
10.1.0
- bn::
audio:: dmg_sync_enabled and bn:: audio:: set_dmg_sync_enabled added. - Custom assembler flags can be specified in the project's
Makefile. - GBT Player updated to 4.4.1.
- bn::
fixed, bn:: optional, bn:: string_view and bn:: span are no longer forward declared in the public API. - Text color in assert and profile screens improved.
- Audio volume setup optimized.
- Clouds restored in
world_mapexample.
10.0.0
- Custom linker flags can be specified in the project's
Makefile. - Asserts ROM usage reduced.
- Audio startup fixed when link-time optimization is enabled.
- Audio stop fixed when link communication is active.
- Parallel link-time optimization temporal files ignored and added to the list of files to clean.
9.5.0
- bn::
dmg_music:: left_volume, bn:: dmg_music:: right_volume, bn:: dmg_music:: set_left_volume, bn:: dmg_music:: set_right_volume and bn:: dmg_music:: set_volume added. - bn::
dmg_music:: position and bn:: dmg_music:: set_position added. - bn::
dmg_music_volume_to_action, bn:: dmg_music_volume_loop_action and bn:: dmg_music_volume_toggle_action added. - bn::
link_state:: player_count added. - An external
mod2gbtexecutable is no longer necessary for importing DMG music with*.modextension. - GBT Player updated to 4.4.0.
- New interrupt manager implemented by Universal GBA Library.
- Audio commands list management optimized (ROM, EWRAM and CPU usage reduced).
- Missed link messages frequency reduced.
- Link data sending race condition fixed.
- Link race condition on V-Blank fixed.
- Audio pause/resume No$gba error removed.
- Palette rotate range documentation fixed.
- Frequently asked questions (FAQ) page improved.
9.4.1
BMP files colors count calculation fixed (again).
9.4.0
- bn::
dmg_music and bn:: dmg_music_item added (yes, music playback using DMG channels is now supported thanks to GBT Player. See the DMG music import guide and the dmg_audioexample to learn how to import and play it. - BMP files colors count calculation fixed.
- C++ keywords are not valid asset names anymore.
- Getting started Python setup improved.
- Tremblay Island added to
README.md.
9.3.0
- bn::
sram:: clear and bn:: sram:: set_bytes added. - bn::
music:: playing_item added. - SRAM code moved back from ROM to EWRAM again, since it doesn't seem to crash No$gba anymore.
- bn::
power_of_two optimized. - Keypad with frame skipping fixed.
9.2.0
- bn::
regular_bg_ptr:: hw_id and bn:: affine_bg_ptr:: hw_id added. - bn::
sin_and_cos, bn:: degrees_sin_and_cos, bn:: lut_sin_and_cos and bn:: degrees_lut_sin_and_cos added. - More bn::
regular_bg_ptr and bn:: affine_bg_ptr static contructors added. - bn::
regular_bg_map_item:: cells_ptr and bn:: affine_bg_map_item:: cells_ptr added. - bn::
affine_mat_attributes rotation angle processing optimized. - bn::
unordered_map and bn:: unordered_set lack of pointer stability documented.
9.1.1
bn::
9.1.0
- bn::
system_font, bn:: core:: system_font and bn:: core:: set_system_font added. - bn::
core:: assert_tag and bn:: core:: set_assert_tag added. - BN_
VERSION_ STRING added. - bn::
rect_window:: restore_boundaries added. - bn::
window:: set_show_all and bn:: window:: set_show_nothing fixed. - bn::
utf8_characters_map_ref:: index assert shows UTF8-character data. - gba-free-fonts added to
README.md.
9.0.0
- bn::
utf8_characters_map and bn:: utf8_characters_map_ref added: they allow to build an UTF-8 characters map in ROM, without size limit. - (Breaking change) bn::
sprite_font now manages a bn:: utf8_characters_map_ref instead of a span of UTF-8 characters. - (Breaking change)
BN_CFG_SPRITE_TEXT_MAX_UTF8_CHARACTERSremoved. - bn::
blending_transparency_attributes:: set_transparency_and_intensity_alphas added. - More questions added to Frequently asked questions (FAQ) page.
8.10.0
- Huffman decompression support added.
- bn::
best_fit_allocator added. - bn::
istring:: resize and bn:: istring:: shrink added. - bn::
string and bn:: string_view compatibility improved. - bn::
string construction, assignment and append optimized. - Integer to string conversion optimized.
- Slot index added to palettes manager status log.
- bn::
calloc and bn:: memory:: ewram_calloc interface fixed. .elffiles No$gba support restored.-O0builds support restored.- More questions added to Frequently asked questions (FAQ) page.
8.9.0
- Hue shift palette effect added. See the
palettesexample to learn how to use it. - Brightness effect ROM usage reduced.
- bn::
sprite_item and bn:: sprite_tiles_item size reduced. - Automatic sprite double size detection fixed.
- bn::hbe_visible_toggle_action removed, since it was not possible to use it.
- Clang build fixes.
- Clang-Tidy warnings fixed.
- New games made with Butano added to
README.md.
8.8.0
- Modified assets detection optimized.
- Audio and graphics tools unified in order to reduce build time.
- bn::newton_raphson_sqrt removed, since it doesn't work for bn::
fixed input values.
8.7.0
- An external bn::
bg_palette_item can be specified when importing regular and affine backgrounds. - Colors count can be specified when importing sprite and background palettes.
- Standard containers equality comparison optimized.
- Asserts file name hack fixed.
- Universal GBA Library LGPL license files removed.
- Standard containers documentation improved.
- Frequently asked questions (FAQ) page improved.
8.6.0
- bn::
random:: get_int and bn:: random:: get_fixed added. - bn::
calloc, bn:: realloc, bn:: memory:: ewram_calloc and bn:: memory:: ewram_realloc added. - bn::
unique_ptr moved to its own header file. - bn::
pool and bn:: generic_pool ROM usage reduced. - Automatic 4BPP regular backgrounds generation fixed.
- Asserts disabled build warnings fixed.
- Frequently asked questions (FAQ) page improved.
8.5.0
- bn::
optional:: get added. - bn::
bitset and bn:: bitset_ref optimized (managed bits count now must be a multiple of 8). - ROM usage reduced due to unnecessary internal asserts removed.
- Blending hardware weights fixed.
- bn::
regular_bg_map_cell_info documentation fixed.
8.4.0
- bn::
bitset_ref added. - bn::
diamond_angle and bn:: degrees_diamond_angle added. - Asserts ROM usage reduced.
- Unnecessary
inlinekeyword usages removed.
8.3.0
- Maps commit optimized by more than 50% in some cases.
- Integer alignment at minimum enforced in all containers.
- BG blocks manager and sprite tiles manager commit fixed.
8.2.0
- (Security issue) Source code files full path is not stored in output ROMs anymore.
- Some Clang-Tidy and Cppcheck warnings removed.
8.1.0
- bn::
color_effect added. - bn::
memory:: decompress added. - All
uncompressmethods renamed todecompress. - All color effects optimized.
- Palettes update and search optimized.
- Getting started page improved.
8.0.0
- Blending transparency weights can be setup separately with bn::
blending:: set_transparency_top_weight and bn:: blending:: set_transparency_bottom_weight. - (Breaking change) bn::
blending_transparency_attributes interface has changed to allow to setup transparency weights separately. - Actions for blending transparency weights added.
- Internal graphics suffix changed from
bn_graphicstobn_gfx. Remember to rebuild your project after updating. - Frequently asked questions (FAQ) page improved.
7.8.0
- Generic slow game pak detection replaces SuperCard SD specific one.
- BN_
GAME_ PAK_ WAIT_ STATE_ FIRST_ AUTO and BN_ GAME_ PAK_ WAIT_ STATE_ SECOND_ AUTO enabled by default. - Affine matrices update optimized.
- Tiles and maps managers optimized.
- Background windows optimized.
- bn::
audio:: update_on_vblank and bn:: audio:: set_update_on_vblank documentation improved. - Frequently asked questions (FAQ) page improved.
7.7.0
- bn::
audio:: update_on_vblank and bn:: audio:: set_update_on_vblank added. - Sprite tiles update and commit optimized.
- Background tiles and maps update and commit optimized.
- Big maps commit optimized.
- Asserts ROM usage reduced.
- H-Blank effects ROM usage reduced.
- bn::
sprite_text_generator ROM usage reduced.
7.6.0
- Display and audio hardware commit optimized.
- bn::
unique_ptr size reduced. - bn::
regular_bg_ptr:: set_item and bn:: affine_bg_ptr:: set_item fixed. - Frequently asked questions (FAQ) page improved.
- Licenses section improved.
7.5.1
Audio and HDMA issues when updating at less than 60FPS fixed.
7.5.0
- bn::
sprites:: reserved_handles_count and bn:: sprites:: set_reserved_handles_count added. - BN_
CFG_ PROFILER_ LOG_ ENGINE_ DETAILED added. - Sprites and backgrounds decompression optimized thanks to Cult-of-GBA BIOS.
- Sprites and backgrounds hardware setup optimized.
- Sprites automatic double size mode optimized.
- Affine sprites hiding fixed.
7.4.0
- Run-length is preferred to LZ77 when choosing best compression mode.
- Sprites automatic double size mode and affine matrix management fixed.
- Frequently asked questions (FAQ) page improved.
7.3.0
- bn::
sprite_text_generator now can plot multiple 16x16 variable width characters in a single sprite. - bn::
sprite_text_generator IWRAM usage reduced. - Third party libraries to link can be specified in the project's
Makefile. - Project's
Makefileallows to build source files generated with an external tool. See theexternal_toolexample to learn how to do it. butano-audio-tool.pygenerates a list of all available music and sound items with their name.audio_playerexample added.- Varooom 3D improved (check its
readme.txtfile for details).
7.2.0
- bn::
regular_bg_map_cell_info and bn:: affine_bg_map_cell_info added. - bn::
regular_bg_map_item:: cell_index and bn:: regular_bg_map_item:: cell added. - bn::
affine_bg_map_item:: cell_index and bn:: affine_bg_map_item:: cell added. - Maps commit optimized by more than 200% in some cases.
dynamic_regular_bgexample added.dynamic_bgexample renamed todynamic_affine_bgand improved.
7.1.1
bn::
7.1.0
- HDMA commit fixed.
- Frequently asked questions (FAQ) page improved.
- Games made with Butano added to
README.md.
7.0.1
bn::
7.0.0
- Varooom 3D source code and assets added.
- Maximum number of active H-Blank effects reduced to 6.
- Common files moved to
commonnamespace.
6.18.0
- Generated items are now
constexpr inlineto avoid being copied to every translation unit. - Sprites EWRAM usage reduced.
- Different type backgrounds sorting fixed.
6.17.1
- bn::sort with 128bit sort keys fixed.
- IRQs setup during startup improved.
6.17.0
- bn::
memory:: used_stack_iwram added. - bn::sort optimized.
- VRAM allocation error messages improved.
- bn::
optional:: emplace copy avoided. - Importing assets guide improved.
- More questions added to Frequently asked questions (FAQ) page.
6.16.0
- bn::
sin_lut is not copied to every translation unit. - bn::
reciprocal_lut is not copied to every translation unit. - GBA keypad is read after playing all keypad commands.
- bn::
degrees_lut_cos assert added.
6.15.0
- bn::
rect:: top_right, bn:: rect:: bottom_left, bn:: fixed_rect:: top_right and bn:: fixed_rect:: bottom_left added. - GPIO register is not setup unless needed (avoids mGBA warning at startup).
- SRAM code moved from EWRAM to ROM in order to avoid a No$gba error.
- bn::
abs for unsigned arguments improved. *.elfbinoutput files renamed to*.elfas it should.- bn::
unordered_map:: erase and bn:: unordered_set:: erase fixed.
6.14.0
- Asserts ROM usage reduced.
- bn::
deque:: push_front, bn:: deque:: emplace_front and bn:: deque:: insert fixed.
6.13.1
- bn::
to_array fixed. - bn::
sprite_text_generator documentation fixed.
6.13.0
- EWRAM wait states count can be specified with BN_
CFG_ EWRAM_ WAIT_ STATE. - bn::
fixed_t:: floor_integer and bn:: fixed_t:: ceil_integer added. - bn::
keypad:: any_held, bn:: keypad:: any_pressed and bn:: keypad:: any_released added. - Unnecessary GPIO register writes avoided.
- bn::
type_id marked as constexpr. - Background move actions fixed.
constexpr constreplaced withconstexprwhere it makes sense.
6.12.0
- Multiplication and division methods added to bn::
fixed_point, bn:: fixed_size and bn:: fixed_rect. - Colors count added to palettes manager status log.
- Invalid bn::
fixed_t unsigned operator overloads removed.
6.11.0
- An external tool can be called from the project's
Makefile. See theexternal_toolexample to learn how to call it. - Affine background tiles offset optimized.
- Big numbers to string conversion optimized.
- 32bit integer division optimized.
- 64bit integer division by 0 assert added.
- Big maps maximum valid position fixed.
- Compressed tiles warning fixed.
- GCC11 warning fixed.
- Some 8x8 sprite text characters fixed.
- Qt Creator setup guide added.
- More questions added to Frequently asked questions (FAQ) page.
6.10.0
dynamic_bgexample added.- Affine background tiles offset fixed.
6.9.0
- bn::
sprite_font supports all sprite shapes and sizes. - Trivial type containers destruction optimized.
- Container destructors are always
noexcept. - Redundant container asserts removed.
- GPIO direction register setup.
6.8.0
- Sprites optimized.
- Blending optimized.
- Mosaic optimized.
- Internal memory transfers optimized.
texture_polygonsexample affine parameters fixed.- Clouds removed from
world_mapexample.
6.7.0
- Automatic sprite double size detection improved.
- Butano Fighter allows to disable rumble in the title menu.
6.6.2
Automatic sprite double size detection fixed.
6.6.1
BG blocks manager use after move fixed.
6.6.0
- SRAM memory usage reduced.
- Sprite animate actions memory usage reduced.
- Missing asserts added to some actions.
- bn::
random is now a trivial class. - BG blocks manager search fixed.
world_mapexample frame rate back to 60FPS.
6.5.0
- bn::
bitset and bn:: ibitset added. - BG blocks manager and sprite tiles manager allocation fixed.
6.4.0
- Sprites and affine backgrounds support horizontal and vertical shear.
- bn::
affine_mat_attributes:: unsafe_set_register_values added. texture_polygonsexample added.- More questions added to Frequently asked questions (FAQ) page.
6.3.0
- BN_
VERSION_ MAJOR, BN_ VERSION_ MINOR and BN_ VERSION_ PATCH added. - bn::
core:: current_cpu_usage, bn:: core:: last_cpu_usage and bn:: core:: last_vblank_usage accuracy improved. - Signed division fixed and optimized.
- BG blocks manager and sprite tiles manager allocation fixed.
- BG blocks manager prints requested blocks count when an allocation fails.
6.2.0
- bn::
core:: skip_frames and bn:: core:: set_skip_frames added. - bn::
sprite_font usability improved. - bn::
reciprocal_lut and bn:: lut_reciprocal fixed.
6.1.0
6.0.0
- Rumble support (if your cart supports it). See Rumble and the
rumbleexample. - bn::
sprites:: reload added. - bn::
hdma:: high_priority_start and bn:: hdma:: high_priority_stop added. - bn::
hdma:: running and bn:: hdma:: high_priority_running added. - Sprite tiles can be generated from images alone, without palettes.
- Graphics and audio subfolders supported.
- bn::
core:: reset fixed. - HDMA disable when an assert or the profiler are shown fixed.
- HDMA first screen horizontal line fixed.
- bn::newton_raphson_sqrt recursion avoided.
- Python install guide improved.
5.3.1
bn::
5.3.0
- bn::
sin, bn:: cos, bn:: atan2 and bn:: degrees_atan2 added. - H-Blank effects optimized (thanks JoaoBaptMG).
- bn::
calculate_sin_lut_value optimized. - bn::
lut_reciprocal optimized. - Frequently asked questions (FAQ) page improved.
5.2.0
- bn::
sprite_ptr:: put_below, bn:: regular_bg_ptr:: put_below and bn:: affine_bg_ptr:: put_below added. - H-Blank effects IWRAM usage reduced.
butano-graphics-tool.pyerrors reporting improved.
5.1.0
- Automatic game pak wait states setup (see BN_
GAME_ PAK_ WAIT_ STATE_ FIRST_ AUTO and BN_ GAME_ PAK_ WAIT_ STATE_ SECOND_ AUTO for more information). - bn::
format and bn:: format_ref functions added. - Some methods to indicate if a background or a background map are big or not have been added.
- bn::
calculate_sin_lut_value precision improved. - Frequently asked questions (FAQ) page added.
butano-graphics-tool.pynow uses all CPU cores.- Missing third party license files included.
5.0.0
- Compressed sprites and backgrounds support (see Importing assets to learn how to generate them).
- bn::
degrees_sin and bn:: degrees_cos don't use a LUT anymore, they are replaced by bn:: degrees_lut_sin and bn:: degrees_lut_cos. - bn::
lut_sin and bn:: lut_cos input angle range increased to [0, 2048]. - Enum classes size reduced.
- Required fields when importing assets are not defaulted anymore.
- bn::
rule_of_three_approximation overflow fixed.
4.4.0
- bn::
sprite_font allows to specify space between characters. - Background palettes bits per pixel mode can be specified by the user.
- Palettes change optimized.
- Unused palette colors are not exported anymore.
- bn::
sprite_ptr:: set_tiles() validation fixed.
4.3.0
4.2.0
- Sprite and background palettes can be generated from images alone, without tiles nor maps.
<cstddef>is always included (bn_cstddef.hheader file removed).- bn::
unordered_map and bn:: unordered_set assignment fixed.
4.1.0
- H-Blank effects optimized (it fixes
world_mapexample flickering). - SRAM code moved from EWRAM to ROM to avoid a No$gba crash.
4.0.0
- Affine backgrounds support. See Affine backgrounds and the
affine_bgs,mode_7andworld_mapexamples for more. - bn::hblank_effect_ptr renamed to bn::
hbe_ptr (all child classes have been renamed too). - bn::sprite_affine_mat_attributes renamed to bn::
affine_mat_attributes. - bn::bg_tiles_ptr renamed to bn::
regular_bg_tiles_ptr. - bn::bg_tiles_item renamed to bn::
regular_bg_tiles_item. - bn::affine_mat_scale_lut replaced with bn::
reciprocal_lut. - bn::core::cpu_usage() and bn::core::vblank_usage() renamed to bn::
core:: last_cpu_usage() and bn:: core:: last_vblank_usage(). - bn::
lut_reciprocal() added. - bn::
core:: current_cpu_usage() added. - gba-link-connection updated to v2.1.4.
- HDMA is disabled when needed, like before sleeping or before an assert screen.
- bn::
regular_bg_tiles_item:: valid_tiles_count() fixed. - bn::
nullopt documentation links fixed.
3.3.0
- HDMA properly supported (now it works at less than 60fps). See bn::
hdma and the hdma_polygonsexample for more. - gba-link-connection remote timeout detection fixed.
3.2.1
bn::
3.2.0
bn::
3.1.0
- bn::
regular_bg_map_ptr:: tiles_offset() and bn:: regular_bg_map_ptr:: palette_banks_offset() methods added. - Allocated background tiles and maps commit fixed.
3.0.0
Thanks to the awesome gba-link-connection, multiplayer support has been implemented! See bn::link example for more.
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_methods have been renamed tomode() bpp(). - 8 bits per pixel background tiles allocation fixed.
1.0.0
- Regular maps bigger than 512x512 supported.
- 32bit integer division by 0 assert added.
- bn::
regular_bg_item maximum tiles check added. - bn::
regular_bg_item generation options fixed.
0.4.0
btnrenamed tobn. No more API breaks will be made between minor releases after 1.0.0, promise.- Background tiles manager status can be printed in the log with bn::
bg_tiles:: log_status(). This is done automatically when a non-optional background tiles allocation fails too. - Background regular maps manager status can be printed in the log with bn::
bg_maps:: log_status(). This is done automatically when a non-optional regular background map allocation fails too. - Sprite tiles manager status can be printed in the log with bn::
sprite_tiles:: log_status(). This is done automatically when a non-optional sprite tiles allocation fails too. - Color palettes managers status can be printed in the log with bn::
bg_palettes:: log_status() and bn:: sprite_palettes:: log_status(). This is done automatically when a non-optional color palette allocation fails too. - Sprites destruction optimized.
- Setters with an optional parameter added to some classes.
- Optional components documentation fixed.
- Other documentation improvements.
0.3.0
- Sprites update performance improved up to 30% in Butano Fighter thanks to avoid rebuilding sprites list as much as possible.
- Profiler can show the maximum measured ticks per entry.
- Assets tools print output binaries size.
0.2.0
- Performance improved up to 12% in Butano Fighter without
-fltothanks to using less build translation units. - Documentation improved.
0.1.0
First release.