NdsForge.NdsOverlay Class Reference

Describes an ARM overlay-table entry and its referenced FAT payload. More...

Properties
NdsProcessor	Processor [get]
	Distinguishes the independent ARM9 and ARM7 overlay namespaces and load environments.
uint	Id [get]
	Identifies runtime overlay metadata and is not required to equal the payload's FileId.
uint	LoadAddress [get]
	Specifies the ARM memory address at which the overlay loader places initialized payload bytes.
uint	RamSize [get]
	Declares initialized runtime bytes after decompression, so it may exceed the stored payload length.
uint	BssSize [get]
	Reserves additional zero-filled runtime memory that is absent from the cartridge payload.
uint	StaticInitializerStart [get]
	Marks the inclusive start of the runtime constructor pointer list for this overlay.
uint	StaticInitializerEnd [get]
	Marks the exclusive end of the constructor pointer list and should not precede its start.
uint	FileId [get]
	Gets the referenced FAT file ID, which is independent of Id.
uint	CompressedSize [get]
	Decodes the low 24 bits of the packed control word; zero commonly indicates an uncompressed payload.
byte	Flags [get]
	Preserves the packed control word's high byte, including compression and authentication-related bits.
NdsRegion?	Data [get]
	Gets the resolved payload region, or null for an invalid file ID.
NdsFile?	File [get]
	Links to a navigable FNT entry only when the FAT payload is also named; valid overlays may remain unnamed.

Detailed Description

Describes an ARM overlay-table entry and its referenced FAT payload.

Definition at line 4 of file NdsOverlay.cs.

Property Documentation

BssSize

uint NdsForge.NdsOverlay.BssSize

get

Reserves additional zero-filled runtime memory that is absent from the cartridge payload.

Definition at line 45 of file NdsOverlay.cs.

CompressedSize

uint NdsForge.NdsOverlay.CompressedSize

get

Decodes the low 24 bits of the packed control word; zero commonly indicates an uncompressed payload.

Definition at line 57 of file NdsOverlay.cs.

Data

NdsRegion? NdsForge.NdsOverlay.Data

get

Gets the resolved payload region, or null for an invalid file ID.

Definition at line 63 of file NdsOverlay.cs.

File

NdsFile? NdsForge.NdsOverlay.File

get

Links to a navigable FNT entry only when the FAT payload is also named; valid overlays may remain unnamed.

Definition at line 66 of file NdsOverlay.cs.

FileId

uint NdsForge.NdsOverlay.FileId

get

Gets the referenced FAT file ID, which is independent of Id.

Definition at line 54 of file NdsOverlay.cs.

Flags

byte NdsForge.NdsOverlay.Flags

get

Preserves the packed control word's high byte, including compression and authentication-related bits.

Definition at line 60 of file NdsOverlay.cs.

Id

uint NdsForge.NdsOverlay.Id

get

Identifies runtime overlay metadata and is not required to equal the payload's FileId.

Definition at line 36 of file NdsOverlay.cs.

LoadAddress

uint NdsForge.NdsOverlay.LoadAddress

get

Specifies the ARM memory address at which the overlay loader places initialized payload bytes.

Definition at line 39 of file NdsOverlay.cs.

Processor

NdsProcessor NdsForge.NdsOverlay.Processor

get

Distinguishes the independent ARM9 and ARM7 overlay namespaces and load environments.

Definition at line 33 of file NdsOverlay.cs.

RamSize

uint NdsForge.NdsOverlay.RamSize

get

Declares initialized runtime bytes after decompression, so it may exceed the stored payload length.

Definition at line 42 of file NdsOverlay.cs.

StaticInitializerEnd

uint NdsForge.NdsOverlay.StaticInitializerEnd

get

Marks the exclusive end of the constructor pointer list and should not precede its start.

Definition at line 51 of file NdsOverlay.cs.

StaticInitializerStart

uint NdsForge.NdsOverlay.StaticInitializerStart

get

Marks the inclusive start of the runtime constructor pointer list for this overlay.

Definition at line 48 of file NdsOverlay.cs.

---

The documentation for this class was generated from the following file:

• src/NdsForge/Overlays/NdsOverlay.cs