ROM Types and Versions

Classes
struct	zelda3_version_pointers
	ROM data pointers for different game versions. More...
struct	zelda3_rom
	ROM data structure. More...

Typedefs
typedef enum zelda3_version	zelda3_version
	Different versions of the game supported by YAZE.
typedef struct zelda3_version_pointers	zelda3_version_pointers
	ROM data pointers for different game versions.
typedef struct zelda3_rom	zelda3_rom
	ROM data structure.

Enumerations
enum	zelda3_version {   ZELDA3_VERSION_UNKNOWN = 0 , ZELDA3_VERSION_US = 1 , ZELDA3_VERSION_JP = 2 , ZELDA3_VERSION_EU = 3 ,   ZELDA3_VERSION_PROTO = 4 , ZELDA3_VERSION_RANDOMIZER = 5 , US = ZELDA3_VERSION_US , JP = ZELDA3_VERSION_JP ,   SD = ZELDA3_VERSION_PROTO , RANDO = ZELDA3_VERSION_RANDOMIZER }
	Different versions of the game supported by YAZE. More...

Functions
zelda3_version	zelda3_detect_version (const uint8_t *rom_data, size_t size)
	Detect ROM version from header data.
const char *	zelda3_version_to_string (zelda3_version version)
	Get version name as string.
const zelda3_version_pointers *	zelda3_get_version_pointers (zelda3_version version)
	Get version-specific pointers.

Detailed Description

Typedef Documentation

zelda3_version

typedef enum zelda3_version zelda3_version

Different versions of the game supported by YAZE.

YAZE supports multiple regional versions and ROM hacks of The Legend of Zelda: A Link to the Past.

zelda3_version_pointers

typedef struct zelda3_version_pointers zelda3_version_pointers

ROM data pointers for different game versions.

Contains memory addresses where specific data structures are located within the ROM. These addresses vary between different regional versions.

zelda3_rom

typedef struct zelda3_rom zelda3_rom

ROM data structure.

Represents a loaded Zelda 3 ROM with its data and metadata.

Enumeration Type Documentation

zelda3_version

enum zelda3_version

Different versions of the game supported by YAZE.

YAZE supports multiple regional versions and ROM hacks of The Legend of Zelda: A Link to the Past.

Enumerator
ZELDA3_VERSION_UNKNOWN	Unknown or unsupported version
ZELDA3_VERSION_US	US/North American version
ZELDA3_VERSION_JP	Japanese version
ZELDA3_VERSION_EU	European version
ZELDA3_VERSION_PROTO	Prototype/development version
ZELDA3_VERSION_RANDOMIZER	Randomizer ROM (experimental)
US	Deprecated: Use ZELDA3_VERSION_US
JP	Deprecated: Use ZELDA3_VERSION_JP
SD	Deprecated: Use ZELDA3_VERSION_PROTO
RANDO	Deprecated: Use ZELDA3_VERSION_RANDOMIZER

Definition at line 33 of file zelda.h.

Function Documentation

zelda3_detect_version()

zelda3_version zelda3_detect_version	(	const uint8_t *	rom_data,
		size_t	size
	)

Detect ROM version from header data.

Parameters

rom_data	Pointer to ROM data
size	Size of ROM data in bytes

Returns

Detected version, or ZELDA3_VERSION_UNKNOWN if not recognized

Todo:

Implement proper version detection based on ROM header

Definition at line 325 of file yaze.cc.

References ZELDA3_VERSION_UNKNOWN, and ZELDA3_VERSION_US.

zelda3_version_to_string()

const char * zelda3_version_to_string

(

zelda3_version

version

)

Get version name as string.

Parameters

version

Version enum value

Returns

Human-readable version name

Definition at line 334 of file yaze.cc.

References ZELDA3_VERSION_EU, ZELDA3_VERSION_JP, ZELDA3_VERSION_PROTO, ZELDA3_VERSION_RANDOMIZER, and ZELDA3_VERSION_US.

zelda3_get_version_pointers()

const zelda3_version_pointers * zelda3_get_version_pointers

(

zelda3_version

version

)

Get version-specific pointers.

Parameters

version

ROM version

Returns

Pointer to version-specific address structure

Definition at line 351 of file yaze.cc.

References ZELDA3_VERSION_JP, and ZELDA3_VERSION_US.