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