Tools module

Contents

Stuff generated by the assets conversion tools to use your assets with Butano.

Files

file bn_affine_bg_item.h
file bn_affine_bg_map_item.h
file bn_affine_bg_tiles_item.h
file bn_bg_palette_item.h
file bn_compression_type.h
file bn_music_item.h
file bn_regular_bg_item.h
file bn_regular_bg_map_item.h
file bn_regular_bg_tiles_item.h
file bn_sound_item.h
file bn_sprite_item.h
file bn_sprite_palette_item.h
file bn_sprite_tiles_item.h

Classes

class bn::affine_bg_item
Contains the required information to generate affine backgrounds and their maps.
class bn::affine_bg_map_item
Contains the required information to generate affine background maps.
class bn::affine_bg_tiles_item
Contains the required information to generate affine background tiles.
class bn::bg_palette_item
Contains the required information to generate background color palettes.
class bn::music_item
Contains the required information to play music.
class bn::regular_bg_item
Contains the required information to generate regular backgrounds and their maps.
class bn::regular_bg_map_item
Contains the required information to generate regular background maps.
class bn::regular_bg_tiles_item
Contains the required information to generate regular background tiles.
class bn::sound_item
Contains the required information to play sound effects.
class bn::sprite_item
Contains the required information to generate sprites.
class bn::sprite_palette_item
Contains the required information to generate sprite color palettes.
class bn::sprite_tiles_item
Contains the required information to generate sprite tiles.

Enums

enum class compression_type: uint8_t { NONE, LZ77, RUN_LENGTH }
Specifies the available compression types.

Enum documentation

enum class compression_type: uint8_t

Specifies the available compression types.

Enumerators
NONE

Uncompressed data.

LZ77

LZ77 compressed data.

RUN_LENGTH

Run-length compressed data.