Leahnaya/Poke_Transporter_GB
1
0
Fork 0
mirror of https://github.com/GearsProgress/Poke_Transporter_GB.git synced 2026-03-21 17:34:42 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add class comment to payload_file_reader

Browse Source
This commit is contained in:
Philippe Symons 2025-07-18 13:38:38 +02:00
parent 0fb305f97a
commit 31c72b5390
2 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
include/payload_file_reader.h
View File

@ -3,7 +3,19 @@
#include <cstdint>
class payload_file_reader {
/**
* This class can read gameboy payloads from the files that were generated by payload_file_writer in
* the data-generator subproject.
*
* The format stores the base payload metadata alongside the base payload first, and then stores
* other payload metadata alongside binary patches to convert the base payload into that payload.
*
* This way we avoid storing redundancy in the data.
*
* Anyway, this class can extract the desired payload from that file format.
*/
class payload_file_reader
{
public:
payload_file_reader(const uint8_t *file_buffer, uint16_t buffer_size);

11
tools/data-generator/include/payloads/payload_file_reader.h
View File

@ -3,6 +3,17 @@
#include <cstdint>
/**
* This class can read gameboy payloads from the files that were generated by payload_file_writer in
* the data-generator subproject.
*
* The format stores the base payload metadata alongside the base payload first, and then stores
* other payload metadata alongside binary patches to convert the base payload into that payload.
*
* This way we avoid storing redundancy in the data.
*
* Anyway, this class can extract the desired payload from that file format.
*/
class payload_file_reader {
public:
payload_file_reader(const uint8_t *file_buffer, uint16_t buffer_size);