yaze.h

Go to the documentation of this file.

#ifndef YAZE_H
#define YAZE_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#include "zelda.h"
 
#ifndef YAZE_VERSION_STRING
/* Fallback if yaze_config.h not included - will be overridden by build */
#define YAZE_VERSION_STRING "0.4.0"
#define YAZE_VERSION_NUMBER 400
#endif
 
typedef struct yaze_editor_context {
  zelda3_rom* rom;
  const char* error_message;
} yaze_editor_context;
 
typedef enum yaze_status {
  YAZE_OK = 0,                
  YAZE_ERROR_UNKNOWN = -1,    
  YAZE_ERROR_INVALID_ARG = 1, 
  YAZE_ERROR_FILE_NOT_FOUND = 2, 
  YAZE_ERROR_MEMORY = 3,      
  YAZE_ERROR_IO = 4,          
  YAZE_ERROR_CORRUPTION = 5,  
  YAZE_ERROR_NOT_INITIALIZED = 6, 
} yaze_status;
 
const char* yaze_status_to_string(yaze_status status);
 
yaze_status yaze_library_init(void);
 
void yaze_library_shutdown(void);
 
int yaze_app_main(int argc, char** argv);
 
bool yaze_check_version_compatibility(const char* expected_version);
 
const char* yaze_get_version_string(void);
 
int yaze_get_version_number(void);
 
yaze_status yaze_init(yaze_editor_context* context, const char* rom_filename);
 
yaze_status yaze_shutdown(yaze_editor_context* context);
 
typedef struct yaze_bitmap {
  int width;      
  int height;     
  uint8_t bpp;    
  uint8_t* data;  
} yaze_bitmap;
 
yaze_bitmap yaze_load_bitmap(const char* filename);
 
void yaze_free_bitmap(yaze_bitmap* bitmap);
 
yaze_bitmap yaze_create_bitmap(int width, int height, uint8_t bpp);
 
typedef struct snes_color {
  uint16_t red;   
  uint16_t green; 
  uint16_t blue;  
} snes_color;
 
snes_color yaze_rgb_to_snes_color(uint8_t r, uint8_t g, uint8_t b);
 
void yaze_snes_color_to_rgb(snes_color color, uint8_t* r, uint8_t* g, uint8_t* b);
 
typedef struct snes_palette {
  uint16_t id;        
  uint16_t size;      
  snes_color* colors; 
} snes_palette;
 
snes_palette* yaze_create_palette(uint16_t id, uint16_t size);
 
void yaze_free_palette(snes_palette* palette);
 
snes_palette* yaze_load_palette_from_rom(const zelda3_rom* rom, uint16_t palette_id);
 
typedef struct snes_tile8 {
  uint32_t id;        
  uint32_t palette_id; 
  uint8_t data[64];   
} snes_tile8;
 
snes_tile8 yaze_load_tile_from_rom(const zelda3_rom* rom, uint32_t tile_id, uint8_t bpp);
 
snes_tile8 yaze_convert_tile_bpp(const snes_tile8* tile, uint8_t from_bpp, uint8_t to_bpp);
 
typedef struct snes_tile_info {
  uint16_t id;
  uint8_t palette;
  bool priority;
  bool vertical_mirror;
  bool horizontal_mirror;
} snes_tile_info;
 
typedef struct snes_tile16 {
  snes_tile_info tiles[4];
} snes_tile16;
 
typedef struct snes_tile32 {
  uint16_t t0;
  uint16_t t1;
  uint16_t t2;
  uint16_t t3;
} snes_tile32;
 
zelda3_rom* yaze_load_rom_file(const char* filename);
 
yaze_status yaze_validate_rom(const zelda3_rom* rom);
 
yaze_status yaze_get_rom_info(const zelda3_rom* rom, zelda3_version* version, uint64_t* size);
 
snes_color yaze_get_color_from_paletteset(const zelda3_rom* rom,
                                          int palette_set, int palette,
                                          int color);
 
zelda3_overworld* yaze_load_overworld(const zelda3_rom* rom);
 
void yaze_free_overworld(zelda3_overworld* overworld);
 
const zelda3_overworld_map* yaze_get_overworld_map(const zelda3_overworld* overworld, int map_index);
 
int yaze_get_overworld_map_count(const zelda3_overworld* overworld);
 
zelda3_dungeon_room* yaze_load_all_rooms(const zelda3_rom* rom, int* room_count);
 
const zelda3_dungeon_room* yaze_load_room(const zelda3_rom* rom, int room_id);
 
void yaze_free_rooms(zelda3_dungeon_room* rooms, int room_count);
 
yaze_status yaze_load_messages(const zelda3_rom* rom, zelda3_message** messages, int* message_count);
 
const zelda3_message* yaze_get_message(const zelda3_rom* rom, int message_id);
 
void yaze_free_messages(zelda3_message* messages, int message_count);
 
typedef void (*yaze_initialize_func)(yaze_editor_context* context);
typedef void (*yaze_cleanup_func)(void);
 
typedef struct yaze_extension {
  const char* name;           
  const char* version;        
  const char* description;    
  const char* author;         
  int api_version;           
  yaze_status (*initialize)(yaze_editor_context* context);
 
  void (*cleanup)(void);
 
  uint32_t (*get_capabilities)(void);
} yaze_extension;
 
#define YAZE_EXT_CAP_ROM_EDITING    (1 << 0)  
#define YAZE_EXT_CAP_GRAPHICS       (1 << 1)  
#define YAZE_EXT_CAP_AUDIO          (1 << 2)  
#define YAZE_EXT_CAP_SCRIPTING      (1 << 3)  
#define YAZE_EXT_CAP_IMPORT_EXPORT  (1 << 4)  
yaze_status yaze_register_extension(const yaze_extension* extension);
 
yaze_status yaze_unregister_extension(const char* name);
 
#ifdef __cplusplus
}
#endif
 
#endif  // YAZE_H