Crate agb

agb

agb is a library for making games on the Game Boy Advance using the Rust programming language. It attempts to be a high level abstraction over the internal workings of the Game Boy Advance whilst still being high performance and memory efficient.

To get started with agb, you should clone the template repo and work from there.

Modules

display

Implements everything relating to things that are displayed on screen.

fixnum

Fixed point number implementation for representing non integers efficiently.

hash_map

Contains an implementation of a hashmap which suits the gameboy advance’s hardware. A lot of the documentation for this module was copied straight out of the rust standard library. The implementation however is not.

input

Button inputs to the system.

interrupt

Interacting with the GBA interrupts

mgba

Implements logging to the mgba emulator.

rng

Simple random number generator

sound

Implements sound output.

syscall

System BIOS calls / syscalls.

timer

Interactions with the internal timers

Macros

include_aseprite

Includes sprites found in the referenced aseprite files. Can include multiple at once and optimises palettes of all included in the single call together. See Size for supported sizes. Returns a reference to Graphics.

include_font

include_gfx

This macro is used to convert a png or bmp into a format usable by the Game Boy Advance.

include_wav

println

Structs

ExternalAllocator

This is the allocator for the External Working Ram. This is currently equivalent to the Global Allocator (where things are allocated if no allocator is provided). This implements the allocator trait, so is meant to be used in specifying where certain structures should be allocated.

Gba

The Gba struct is used to control access to the Game Boy Advance’s hardware in a way which makes it the borrow checker’s responsibility to ensure no clashes of global resources.

InternalAllocator

This is the allocator for the Internal Working Ram. This implements the allocator trait, so is meant to be used in specifying where certain structures should be allocated.

Attribute Macros

entry

This macro declares the entry point to your game written using agb.