git » fp-git.git » commit 69b69f3

Comentarios en los .h

author dessaya
2004-04-03 01:54:59 UTC
committer dessaya
2004-04-03 01:54:59 UTC
parent 21c8950405236547e9d01c65c57595c76767b9f9

Comentarios en los .h

FP/src/include/input.h +4 -2
FP/src/include/output.h +9 -4
FP/src/include/resources.h +10 -5

diff --git a/FP/src/include/input.h b/FP/src/include/input.h
index 3b41c5c..7947eab 100644
--- a/FP/src/include/input.h
+++ b/FP/src/include/input.h
@@ -33,8 +33,10 @@ input.h: Free Prince : Input devices handling
 #ifndef _INPUT_H_
 #define _INPUT_H_
 
-typeDef key
+typedef struct {...} tKey
+
+tKey getInput();
+/* Returns the next input (either from the keyboard or joystick or whatever) */
 
-tKey getKey();
 
 #endif
diff --git a/FP/src/include/output.h b/FP/src/include/output.h
index a3d724e..0965fb3 100644
--- a/FP/src/include/output.h
+++ b/FP/src/include/output.h
@@ -21,6 +21,11 @@
 /*
 resources.h: Free Prince : Output Devices Handler
 \xaf\xaf\xaf\xaf\xaf\xaf\xaf\xaf\xaf\xaf\xaf
+
+ Description: 
+ 	Platform and device independent functions for handling output
+	(text, graphics, sound, music...).
+
  Copyright 2004 Princed Development Team
   Created: 23 Mar 2004
 
@@ -34,15 +39,15 @@ resources.h: Free Prince : Output Devices Handler
 #define _OUTPUT_H_
 
 /* Text Primitives*/
-drawText(const char* text);
-drawMessage(const char* text);
+drawText(const char* text, int x, int y);
+drawMessage(const char* text); 
 
 /* Sound */
-playWav(tWave sound);
+playWav(tWave sound); /* Starts the reproduction of the sample and returns */
 playMid(tMidi music); /* Starts the music reproduction and returns */
 
 /* Graph */
-drawBitmap(tImage image);
+drawBitmap(tImage image, int x, int y);
 clearScreen();
 
 /* Initialization */
diff --git a/FP/src/include/resources.h b/FP/src/include/resources.h
index 4340867..fd65fb8 100644
--- a/FP/src/include/resources.h
+++ b/FP/src/include/resources.h
@@ -33,12 +33,17 @@ resources.h: Free Prince : Resource Handler
 #ifndef _RESOURCES_H_
 #define _RESOURCES_H_
 
-int resOpenFile(const char* file);
-resCloseFile(int fd);
+int resOpenFile(const char* file); 
+	/* Opens file, loads the data into memory, closes the file and
+	 * returns an ID number (data descriptor) for the new structure. */
+resCloseFile(int dd); /* dd = data descriptor */
+	/* Frees the data from memory. */
 resCloseAllFiles();
 
-tMidi resGetMidi(int fd,int resId);
-tWave resGetWave(int fd,int resId);
-tImage resGetImage(int df, int resId);
+/* Functions for getting data previously loaded into memory. Each dd points
+ * to an array of elements, and resId indicates the index in this array. */
+tMidi resGetMidi(int dd, int resId);
+tWave resGetWave(int dd, int resId);
+tImage resGetImage(int dd, int resId);
 
 #endif