m/grafX2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doxygen group for fileformats.h

Browse Source
This commit is contained in:
Thomas Bernard 2018-11-21 01:29:04 +01:00
parent d21527c024
commit 0e512209a7
No known key found for this signature in database
GPG Key ID: 0FF11B67A5C0863C
2 changed files with 38 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/fileformats.h
View File

@ -27,6 +27,13 @@
#include "loadsave.h" #include "loadsave.h"
/// @defgroup loadsaveformats Test, Load and Save functions
///
/// The Test, Load and Save function for each supported
/// file formats are referenced in @ref File_formats
///
/// @{
// -- PKM ------------------------------------------------------------------- // -- PKM -------------------------------------------------------------------
void Test_PKM(T_IO_Context *, FILE *); void Test_PKM(T_IO_Context *, FILE *);
void Load_PKM(T_IO_Context *); void Load_PKM(T_IO_Context *);
@ -146,4 +153,5 @@ void Test_MOTO(T_IO_Context *, FILE *);
void Load_MOTO(T_IO_Context *); void Load_MOTO(T_IO_Context *);
void Save_MOTO(T_IO_Context *); void Save_MOTO(T_IO_Context *);
/// @}
#endif #endif

42
src/miscfileformats.c
View File

@ -3681,21 +3681,28 @@ void Save_C64(T_IO_Context * context)
} }
// SCR (Amstrad CPC) /**
* Test for SCR file (Amstrad CPC)
*
* TODO
*/
void Test_SCR(T_IO_Context * context, FILE * file) void Test_SCR(T_IO_Context * context, FILE * file)
{ {
// Mmh... not sure what we could test. Any idea ? /**
// The palette file can be tested, if it exists and have the right size it's * Mmh... not sure what we could test. Any idea ?
// ok. But if it's not there the pixel data may still be valid. And we can't * The palette file can be tested, if it exists and have the right size it's
// use the filesize as this depends on the screen format. * ok. But if it's not there the pixel data may still be valid. And we can't
* use the filesize as this depends on the screen format.
// An AMSDOS header would be a good indication but in some cases it may not * An AMSDOS header would be a good indication but in some cases it may not
// be there * be there */
(void)context; // unused (void)context; // unused
(void)file; (void)file;
} }
/**
* TODO
*/
void Load_SCR(T_IO_Context * context) void Load_SCR(T_IO_Context * context)
{ {
// The Amstrad CPC screen memory is mapped in a weird mode, somewhere // The Amstrad CPC screen memory is mapped in a weird mode, somewhere
@ -3728,6 +3735,9 @@ void Load_SCR(T_IO_Context * context)
(void)context; // unused (void)context; // unused
} }
/**
* Save Amstrad SCR file
*/
void Save_SCR(T_IO_Context * context) void Save_SCR(T_IO_Context * context)
{ {
// TODO : Add possibility to set R9, R12, R13 values // TODO : Add possibility to set R9, R12, R13 values
@ -3770,10 +3780,15 @@ void Save_SCR(T_IO_Context * context)
File_error = 0; File_error = 0;
} }
// CM5 - Amstrad CPC "Mode 5" picture /**
// This is a format designed by SyX. There is one .GFX file in the usual amstrad format, * Test for CM5 - Amstrad CPC "Mode 5" picture
// and a .CM5 file with the palette, which varies over time. *
* This is a format designed by SyX.
* There is one .GFX file in the usual amstrad format
* and a .CM5 file with the palette, which varies over time.
*
* CM5 file is 2049 bytes, GFX is 18432 bytes.
*/
void Test_CM5(T_IO_Context * context, FILE * file) void Test_CM5(T_IO_Context * context, FILE * file)
{ {
// check cm5 file size == 2049 bytes // check cm5 file size == 2049 bytes
@ -3799,6 +3814,9 @@ void Test_CM5(T_IO_Context * context, FILE * file)
} }
/**
* Load Amstrad CPC "Mode 5" picture
*/
void Load_CM5(T_IO_Context* context) void Load_CM5(T_IO_Context* context)
{ {
// Ensure "8bit" constraint mode is switched on // Ensure "8bit" constraint mode is switched on