mirror of
https://github.com/gbdk-2020/gbdk-2020.git
synced 2026-03-23 07:27:15 +01:00
249 lines
17 KiB
JavaScript
249 lines
17 KiB
JavaScript
var index =
|
|
[
|
|
[ "Introduction", "index.html#autotoc_md197", null ],
|
|
[ "About the Documentation", "index.html#autotoc_md198", null ],
|
|
[ "About GBDK", "index.html#autotoc_md199", null ],
|
|
[ "Historical Info and Links", "index.html#autotoc_md200", null ],
|
|
[ "Getting Started", "docs_getting_started.html", [
|
|
[ "1. Download a Release and unzip it", "docs_getting_started.html#autotoc_md6", null ],
|
|
[ "2. Compile Example projects", "docs_getting_started.html#autotoc_md7", null ],
|
|
[ "3. Use a Template", "docs_getting_started.html#autotoc_md8", null ],
|
|
[ "4. If you use GBTD / GBMB, get the fixed version", "docs_getting_started.html#autotoc_md9", null ],
|
|
[ "5. Review Coding Guidelines", "docs_getting_started.html#autotoc_md10", null ],
|
|
[ "6. Hardware and Resources", "docs_getting_started.html#autotoc_md11", null ],
|
|
[ "7. Set up C Source debugging", "docs_getting_started.html#autotoc_md12", null ],
|
|
[ "8. Try a GBDK Tutorial", "docs_getting_started.html#autotoc_md13", null ],
|
|
[ "9. Read up!", "docs_getting_started.html#autotoc_md14", null ],
|
|
[ "10. Need help?", "docs_getting_started.html#autotoc_md15", null ]
|
|
] ],
|
|
[ "Links and Third-Party Tools", "docs_links_and_tools.html", [
|
|
[ "SDCC Compiler Suite User Manual", "docs_links_and_tools.html#autotoc_md16", null ],
|
|
[ "Getting Help", "docs_links_and_tools.html#autotoc_md17", null ],
|
|
[ "Game Boy Documentation", "docs_links_and_tools.html#autotoc_md18", null ],
|
|
[ "Sega Master System / Game Gear Documentation", "docs_links_and_tools.html#autotoc_md19", null ],
|
|
[ "Tutorials", "docs_links_and_tools.html#autotoc_md20", null ],
|
|
[ "Example code", "docs_links_and_tools.html#autotoc_md21", null ],
|
|
[ "Graphics Tools", "docs_links_and_tools.html#autotoc_md22", null ],
|
|
[ "Music drivers and tools", "docs_links_and_tools.html#autotoc_md23", null ],
|
|
[ "Emulators", "docs_links_and_tools.html#autotoc_md24", null ],
|
|
[ "Debugging tools", "docs_links_and_tools.html#autotoc_md25", null ],
|
|
[ "Continuous Integration and Deployment", "docs_links_and_tools.html#autotoc_md26", null ]
|
|
] ],
|
|
[ "Using GBDK", "docs_using_gbdk.html", [
|
|
[ "Interrupts", "docs_using_gbdk.html#autotoc_md27", [
|
|
[ "Available Interrupts", "docs_using_gbdk.html#autotoc_md28", null ],
|
|
[ "Adding your own interrupt handler", "docs_using_gbdk.html#autotoc_md29", null ],
|
|
[ "Using your own Interrupt Dispatcher", "docs_using_gbdk.html#autotoc_md30", null ],
|
|
[ "Returning from Interrupts and STAT mode", "docs_using_gbdk.html#autotoc_md31", null ]
|
|
] ],
|
|
[ "What GBDK does automatically and behind the scenes", "docs_using_gbdk.html#autotoc_md32", [
|
|
[ "OAM (VRAM Sprite Attribute Table)", "docs_using_gbdk.html#autotoc_md33", null ],
|
|
[ "Font tiles when using stdio.h", "docs_using_gbdk.html#autotoc_md34", null ],
|
|
[ "Default Interrupt Service Handlers (ISRs)", "docs_using_gbdk.html#autotoc_md35", null ]
|
|
] ],
|
|
[ "Copying Functions to RAM and HIRAM", "docs_using_gbdk.html#autotoc_md36", null ],
|
|
[ "Mixing C and Assembly", "docs_using_gbdk.html#autotoc_md37", [
|
|
[ "Inline ASM within C source files", "docs_using_gbdk.html#autotoc_md38", null ],
|
|
[ "In Separate ASM files", "docs_using_gbdk.html#autotoc_md39", null ]
|
|
] ],
|
|
[ "Including binary files in C source with incbin", "docs_using_gbdk.html#autotoc_md40", null ],
|
|
[ "Known Issues and Limitations", "docs_using_gbdk.html#autotoc_md41", [
|
|
[ "SDCC", "docs_using_gbdk.html#autotoc_md42", null ]
|
|
] ]
|
|
] ],
|
|
[ "Coding Guidelines", "docs_coding_guidelines.html", [
|
|
[ "Learning C / C fundamentals", "docs_coding_guidelines.html#autotoc_md43", [
|
|
[ "General C tutorials", "docs_coding_guidelines.html#autotoc_md44", null ],
|
|
[ "Embedded C introductions", "docs_coding_guidelines.html#autotoc_md45", null ],
|
|
[ "Game Boy games in C", "docs_coding_guidelines.html#autotoc_md46", null ]
|
|
] ],
|
|
[ "Understanding the hardware", "docs_coding_guidelines.html#autotoc_md47", null ],
|
|
[ "Writing optimal C code for the Game Boy and SDCC", "docs_coding_guidelines.html#autotoc_md48", [
|
|
[ "Tools", "docs_coding_guidelines.html#autotoc_md49", [
|
|
[ "GBTD / GBMB, Arrays and the \"const\" keyword", "docs_coding_guidelines.html#autotoc_md50", null ]
|
|
] ],
|
|
[ "Variables", "docs_coding_guidelines.html#autotoc_md51", null ],
|
|
[ "Code structure", "docs_coding_guidelines.html#autotoc_md52", null ],
|
|
[ "GBDK API/Library", "docs_coding_guidelines.html#autotoc_md53", null ],
|
|
[ "Toolchain", "docs_coding_guidelines.html#autotoc_md54", null ],
|
|
[ "chars and vararg functions", "docs_coding_guidelines.html#autotoc_md55", null ]
|
|
] ],
|
|
[ "When C isn't fast enough", "docs_coding_guidelines.html#autotoc_md56", [
|
|
[ "Calling convention", "docs_coding_guidelines.html#autotoc_md57", null ],
|
|
[ "Variables and registers", "docs_coding_guidelines.html#autotoc_md58", null ],
|
|
[ "Segments", "docs_coding_guidelines.html#autotoc_md59", null ]
|
|
] ]
|
|
] ],
|
|
[ "ROM/RAM Banking and MBCs", "docs_rombanking_mbcs.html", [
|
|
[ "ROM/RAM Banking and MBCs (Memory Bank Controllers)", "docs_rombanking_mbcs.html#autotoc_md60", [
|
|
[ "Non-banked cartridges", "docs_rombanking_mbcs.html#autotoc_md61", null ],
|
|
[ "MBC Banked cartridges (Memory Bank Controllers)", "docs_rombanking_mbcs.html#autotoc_md62", null ]
|
|
] ],
|
|
[ "Working with Banks", "docs_rombanking_mbcs.html#autotoc_md63", [
|
|
[ "Setting the ROM bank for a Source file", "docs_rombanking_mbcs.html#autotoc_md64", null ],
|
|
[ "Setting the RAM bank for a Source file", "docs_rombanking_mbcs.html#autotoc_md65", null ],
|
|
[ "Setting the MBC and number of ROM & RAM banks available", "docs_rombanking_mbcs.html#autotoc_md66", null ],
|
|
[ "Getting Bank Numbers", "docs_rombanking_mbcs.html#autotoc_md67", null ],
|
|
[ "Banking and Functions", "docs_rombanking_mbcs.html#autotoc_md68", [
|
|
[ "BANKED/NONBANKED keywords", "docs_rombanking_mbcs.html#autotoc_md69", null ],
|
|
[ "Banked Function Calls", "docs_rombanking_mbcs.html#autotoc_md70", null ]
|
|
] ],
|
|
[ "Const Data (Variables in ROM)", "docs_rombanking_mbcs.html#autotoc_md71", null ],
|
|
[ "Variables in RAM", "docs_rombanking_mbcs.html#autotoc_md72", null ],
|
|
[ "Far Pointers", "docs_rombanking_mbcs.html#autotoc_md73", null ],
|
|
[ "Bank switching", "docs_rombanking_mbcs.html#autotoc_md74", null ],
|
|
[ "Restoring the current bank (after calling functions which change it without restoring)", "docs_rombanking_mbcs.html#autotoc_md75", null ],
|
|
[ "Currently active bank: _current_bank", "docs_rombanking_mbcs.html#autotoc_md76", null ]
|
|
] ],
|
|
[ "Auto-Banking", "docs_rombanking_mbcs.html#autotoc_md77", null ],
|
|
[ "Errors related to banking (overflow, multiple writes to same location)", "docs_rombanking_mbcs.html#autotoc_md78", null ],
|
|
[ "Bank space usage", "docs_rombanking_mbcs.html#autotoc_md79", [
|
|
[ "Other important notes", "docs_rombanking_mbcs.html#autotoc_md80", null ]
|
|
] ],
|
|
[ "Banking example projects", "docs_rombanking_mbcs.html#autotoc_md81", null ]
|
|
] ],
|
|
[ "Supported Consoles & Cross Compiling", "docs_supported_consoles.html", [
|
|
[ "Consoles Supported by GBDK", "docs_supported_consoles.html#autotoc_md102", null ],
|
|
[ "Cross Compiling for Different Consoles", "docs_supported_consoles.html#autotoc_md103", [
|
|
[ "lcc", "docs_supported_consoles.html#autotoc_md104", null ],
|
|
[ "sdcc", "docs_supported_consoles.html#autotoc_md105", null ],
|
|
[ "Console Port and Platform Settings", "docs_supported_consoles.html#autotoc_md106", null ]
|
|
] ],
|
|
[ "Cross-Platform Constants", "docs_supported_consoles.html#autotoc_md107", [
|
|
[ "Console Identifiers", "docs_supported_consoles.html#autotoc_md108", null ],
|
|
[ "Console Hardware Properties", "docs_supported_consoles.html#autotoc_md109", null ]
|
|
] ],
|
|
[ "Using <gbdk/...> headers", "docs_supported_consoles.html#autotoc_md110", null ],
|
|
[ "Cross Platform Example Projects", "docs_supported_consoles.html#autotoc_md111", null ],
|
|
[ "Porting From Game Boy to Analogue Pocket", "docs_supported_consoles.html#autotoc_md112", [
|
|
[ "Registers and Flags", "docs_supported_consoles.html#autotoc_md113", null ],
|
|
[ "Boot logo", "docs_supported_consoles.html#autotoc_md114", null ]
|
|
] ],
|
|
[ "Porting From Game Boy to SMS/GG", "docs_supported_consoles.html#autotoc_md115", [
|
|
[ "Tile Data and Tile Map loading", "docs_supported_consoles.html#autotoc_md116", [
|
|
[ "Tile and Map Data in 2bpp Game Boy Format", "docs_supported_consoles.html#autotoc_md117", null ],
|
|
[ "Tile and Map Data in Native Format", "docs_supported_consoles.html#autotoc_md118", null ],
|
|
[ "Emulated Game Boy Color map attributes on the SMS/Game Gear", "docs_supported_consoles.html#autotoc_md119", null ]
|
|
] ]
|
|
] ],
|
|
[ "Hardware Comparison", "docs_supported_consoles.html#autotoc_md120", [
|
|
[ "Safe VRAM / Display Controller Access", "docs_supported_consoles.html#autotoc_md121", null ]
|
|
] ]
|
|
] ],
|
|
[ "GBDK Toolchain", "docs_toolchain.html", [
|
|
[ "Overview", "docs_toolchain.html#autotoc_md82", null ],
|
|
[ "Data Types", "docs_toolchain.html#autotoc_md83", null ],
|
|
[ "Changing Important Addresses", "docs_toolchain.html#autotoc_md84", null ],
|
|
[ "Compiling programs", "docs_toolchain.html#autotoc_md85", [
|
|
[ "Makefiles", "docs_toolchain.html#Makefiles", null ]
|
|
] ],
|
|
[ "Build Tools", "docs_toolchain.html#autotoc_md86", [
|
|
[ "lcc", "docs_toolchain.html#autotoc_md87", null ],
|
|
[ "sdcc", "docs_toolchain.html#autotoc_md88", null ],
|
|
[ "sdasgb", "docs_toolchain.html#autotoc_md89", null ],
|
|
[ "bankpack", "docs_toolchain.html#autotoc_md90", null ],
|
|
[ "sdldgb", "docs_toolchain.html#autotoc_md91", null ],
|
|
[ "ihxcheck", "docs_toolchain.html#autotoc_md92", null ],
|
|
[ "makebin", "docs_toolchain.html#autotoc_md93", null ]
|
|
] ],
|
|
[ "GBDK Utilities", "docs_toolchain.html#autotoc_md94", [
|
|
[ "GBCompress", "docs_toolchain.html#autotoc_md95", null ],
|
|
[ "png2asset", "docs_toolchain.html#autotoc_md96", [
|
|
[ "Working with png2asset", "docs_toolchain.html#autotoc_md97", [
|
|
[ "Terminology", "docs_toolchain.html#autotoc_md98", null ],
|
|
[ "Conversion Process", "docs_toolchain.html#autotoc_md99", null ],
|
|
[ "Maps", "docs_toolchain.html#autotoc_md100", null ],
|
|
[ "Meta sprites", "docs_toolchain.html#autotoc_md101", null ]
|
|
] ]
|
|
] ]
|
|
] ]
|
|
] ],
|
|
[ "Example Programs", "docs_example_programs.html", [
|
|
[ "banks (various projects)", "docs_example_programs.html#autotoc_md122", null ],
|
|
[ "comm", "docs_example_programs.html#autotoc_md123", null ],
|
|
[ "crash", "docs_example_programs.html#autotoc_md124", null ],
|
|
[ "colorbar", "docs_example_programs.html#autotoc_md125", null ],
|
|
[ "dscan", "docs_example_programs.html#autotoc_md126", null ],
|
|
[ "filltest", "docs_example_programs.html#autotoc_md127", null ],
|
|
[ "fonts", "docs_example_programs.html#autotoc_md128", null ],
|
|
[ "galaxy", "docs_example_programs.html#autotoc_md129", null ],
|
|
[ "gb-dtmf", "docs_example_programs.html#autotoc_md130", null ],
|
|
[ "gbdecompress", "docs_example_programs.html#autotoc_md131", null ],
|
|
[ "irq", "docs_example_programs.html#autotoc_md132", null ],
|
|
[ "large map", "docs_example_programs.html#autotoc_md133", null ],
|
|
[ "metasprites", "docs_example_programs.html#autotoc_md134", null ],
|
|
[ "lcd isr wobble", "docs_example_programs.html#autotoc_md135", null ],
|
|
[ "paint", "docs_example_programs.html#autotoc_md136", null ],
|
|
[ "rand", "docs_example_programs.html#autotoc_md137", null ],
|
|
[ "ram_fn", "docs_example_programs.html#autotoc_md138", null ],
|
|
[ "rpn", "docs_example_programs.html#autotoc_md139", null ],
|
|
[ "samptest", "docs_example_programs.html#autotoc_md140", null ],
|
|
[ "sgb (various)", "docs_example_programs.html#autotoc_md141", null ],
|
|
[ "sound", "docs_example_programs.html#autotoc_md142", null ],
|
|
[ "space", "docs_example_programs.html#autotoc_md143", null ],
|
|
[ "templates", "docs_example_programs.html#autotoc_md144", null ]
|
|
] ],
|
|
[ "Frequently Asked Questions (FAQ)", "docs_faq.html", [
|
|
[ "General", "docs_faq.html#autotoc_md145", null ],
|
|
[ "ROM Header Settings", "docs_faq.html#autotoc_md146", null ],
|
|
[ "Errors / Compiling / Toolchain", "docs_faq.html#autotoc_md147", null ],
|
|
[ "API / Utilities", "docs_faq.html#autotoc_md148", null ]
|
|
] ],
|
|
[ "Migrating to new GBDK Versions", "docs_migrating_versions.html", [
|
|
[ "GBDK 2020 versions", "docs_migrating_versions.html#autotoc_md149", [
|
|
[ "Porting to GBDK 2020 4.0.5", "docs_migrating_versions.html#autotoc_md150", null ],
|
|
[ "Porting to GBDK 2020 4.0.4", "docs_migrating_versions.html#autotoc_md151", null ],
|
|
[ "Porting to GBDK 2020 4.0.3", "docs_migrating_versions.html#autotoc_md152", null ],
|
|
[ "Porting to GBDK 2020 4.0.2", "docs_migrating_versions.html#autotoc_md153", null ],
|
|
[ "Porting to GBDK 2020 4.0.1", "docs_migrating_versions.html#autotoc_md154", null ],
|
|
[ "Porting to GBDK 2020 4.0", "docs_migrating_versions.html#autotoc_md155", null ],
|
|
[ "Porting to GBDK 2020 3.2", "docs_migrating_versions.html#autotoc_md156", null ],
|
|
[ "Porting to GBDK 2020 3.1.1", "docs_migrating_versions.html#autotoc_md157", null ],
|
|
[ "Porting to GBDK 2020 3.1", "docs_migrating_versions.html#autotoc_md158", null ],
|
|
[ "Porting to GBDK 2020 3.0.1", "docs_migrating_versions.html#autotoc_md159", null ]
|
|
] ],
|
|
[ "Historical GBDK versions", "docs_migrating_versions.html#autotoc_md161", [
|
|
[ "GBDK 1.1 to GBDK 2.0", "docs_migrating_versions.html#autotoc_md162", null ]
|
|
] ]
|
|
] ],
|
|
[ "GBDK Releases", "docs_releases.html", [
|
|
[ "GBDK 2020 Release Notes", "docs_releases.html#autotoc_md163", [
|
|
[ "GBDK 2020 4.0.5", "docs_releases.html#autotoc_md164", null ],
|
|
[ "GBDK 2020 4.0.4", "docs_releases.html#autotoc_md165", null ],
|
|
[ "GBDK 2020 4.0.3", "docs_releases.html#autotoc_md166", null ],
|
|
[ "GBDK 2020 4.0.2", "docs_releases.html#autotoc_md167", null ],
|
|
[ "GBDK 2020 4.0.1", "docs_releases.html#autotoc_md168", null ],
|
|
[ "GBDK 2020 4.0", "docs_releases.html#autotoc_md169", null ],
|
|
[ "GBDK 2020 3.2", "docs_releases.html#autotoc_md170", null ],
|
|
[ "GBDK 2020 3.1.1", "docs_releases.html#autotoc_md171", null ],
|
|
[ "GBDK 2020 3.1", "docs_releases.html#autotoc_md172", null ],
|
|
[ "GBDK 2020 3.0.1", "docs_releases.html#autotoc_md173", null ],
|
|
[ "GBDK 2020 3.0", "docs_releases.html#autotoc_md174", null ]
|
|
] ],
|
|
[ "Historical GBDK Release Notes", "docs_releases.html#autotoc_md175", [
|
|
[ "GBDK 2.96", "docs_releases.html#autotoc_md176", null ],
|
|
[ "GBDK 2.95-3", "docs_releases.html#autotoc_md177", null ],
|
|
[ "GBDK 2.95-2", "docs_releases.html#autotoc_md178", null ],
|
|
[ "GBDK 2.95", "docs_releases.html#autotoc_md179", null ],
|
|
[ "GBDK 2.94", "docs_releases.html#autotoc_md180", null ],
|
|
[ "GBDK 2.93", "docs_releases.html#autotoc_md181", null ],
|
|
[ "GBDK 2.92-2 for win32", "docs_releases.html#autotoc_md182", null ],
|
|
[ "GBDK 2.92", "docs_releases.html#autotoc_md183", null ],
|
|
[ "GBDK 2.91", "docs_releases.html#autotoc_md184", null ],
|
|
[ "GBDK 2.1.5", "docs_releases.html#autotoc_md185", null ]
|
|
] ]
|
|
] ],
|
|
[ "Toolchain settings", "docs_toolchain_settings.html", [
|
|
[ "lcc settings", "docs_toolchain_settings.html#autotoc_md186", null ],
|
|
[ "sdcc settings", "docs_toolchain_settings.html#autotoc_md187", null ],
|
|
[ "sdasgb settings", "docs_toolchain_settings.html#autotoc_md188", null ],
|
|
[ "sdasz80 settings", "docs_toolchain_settings.html#autotoc_md189", null ],
|
|
[ "bankpack settings", "docs_toolchain_settings.html#autotoc_md190", null ],
|
|
[ "sdldgb settings", "docs_toolchain_settings.html#autotoc_md191", null ],
|
|
[ "sdldz80 settings", "docs_toolchain_settings.html#autotoc_md192", null ],
|
|
[ "ihxcheck settings", "docs_toolchain_settings.html#autotoc_md193", null ],
|
|
[ "makebin settings", "docs_toolchain_settings.html#autotoc_md194", null ],
|
|
[ "gbcompress settings", "docs_toolchain_settings.html#autotoc_md195", null ],
|
|
[ "png2asset settings", "docs_toolchain_settings.html#autotoc_md196", null ]
|
|
] ]
|
|
]; |