Embedded Sprite Type Reference

gba::embed::indexed4() and gba::embed::indexed8() expose sprite-facing helpers in slightly different shapes.

Include

#include <gba/embed>

`indexed4` result summary

template<unsigned int Width, unsigned int Height, std::size_t PaletteSize, std::size_t TileCount, std::size_t MapSize>
struct indexed4_result {
    std::array<gba::color, PaletteSize> palette;
    gba::sprite4<Width, Height, TileCount> sprite;
    std::array<gba::screen_entry, MapSize> map;
};

Key members

palette: indexed palette data
sprite: 4bpp tile payload + obj() / obj_aff() OAM helpers
map: background-style tilemap (screenblock order)

`indexed8` result summary

template<unsigned int Width, unsigned int Height, std::size_t PaletteSize, std::size_t TileCount, std::size_t MapSize>
struct indexed8_result {
    std::array<gba::color, PaletteSize> palette;
    std::array<gba::tile8bpp, TileCount> tiles;
    std::array<gba::screen_entry, MapSize> map;

    static constexpr gba::object obj(unsigned short tile_index = 0);
    static constexpr gba::object_affine obj_aff(unsigned short tile_index = 0);
};

indexed8 exposes OAM helpers directly on the result type instead of through a nested sprite field.

OAM helpers (4bpp)

`obj(tile_index)`

Returns a regular (non-affine) gba::object entry pre-configured with:

sprite dimensions from the source image
tile index set to tile_index (default 0)
4bpp/8bpp depth matching the source
all other fields zeroed (position, flip, palette bank)

constexpr auto sprite = gba::embed::indexed4<gba::embed::dedup::none>([] {
    return std::to_array<unsigned char>({
#embed "hero.png"
    });
});

gba::obj_mem[0] = sprite.sprite.obj(tile_base);
gba::obj_mem[0].x = 120;
gba::obj_mem[0].y = 80;

`obj_aff(tile_index)`

Returns an affine gba::object_affine entry pre-configured the same way as obj(), but with:

affine flag always set
affine_index zeroed (assign your affine matrix index after)

gba::obj_aff_mem[0] = sprite.sprite.obj_aff(tile_base);
gba::obj_aff_mem[0].affine_index = 0;
gba::obj_aff_mem[0].x = 120;
gba::obj_aff_mem[0].y = 80;

Valid sprite sizes

The sprite type is only created when the source image dimensions match a legal GBA OBJ size:

Shape	Sizes
Square	8x8, 16x16, 32x32, 64x64
Wide	16x8, 32x8, 32x16, 64x32
Tall	8x16, 8x32, 16x32, 32x64

If the source does not match, the converter rejects it at compile time.

Upload pattern

// Copy tile data to OBJ VRAM
const auto base_tile = gba::tile_index(gba::memory_map(gba::mem_vram_obj));
std::memcpy(gba::memory_map(gba::mem_vram_obj), sprite.sprite.data(), sprite.sprite.size());

// Copy palette to OBJ palette RAM
std::copy(sprite.palette.begin(), sprite.palette.end(), gba::pal_obj_bank[0]);

// Create OAM entry
gba::obj_mem[0] = sprite.sprite.obj(base_tile);

Keyboard shortcuts

stdgba