Oops, WIN32 typo fix.

[simgear.git] / simgear / screen / screen-dump.hxx

diff --git a/simgear/screen/screen-dump.hxx b/simgear/screen/screen-dump.hxx
index c9976d38023e8fe73ea8812ce38c3e93eec97a31..7c2e922d9390391a7d97178b754e72434d77a012 100644 (file)
--- a/simgear/screen/screen-dump.hxx
+++ b/simgear/screen/screen-dump.hxx
@@ -1,5 +1,8 @@
-// screen-dump.hxx -- dump a copy of the opengl screen buffer to a file
-//
+/**
+ * \file screen-dump.hxx
+ * Dump a copy of the opengl screen buffer to a file.
+ */
+
 // Contributed by Richard Kaszeta <bofh@me.umn.edu>, started October 1999.
 //
 // This library is free software; you can redistribute it and/or
@@ -19,9 +22,26 @@
 //
 // $Id$
 
+#include <simgear/compiler.h>
+
+#include SG_GL_H
+
+/**
+ * Dump the screen buffer to a ppm file.
+ * @param filename name of file
+ * @param win_width width of our opengl window
+ * @param win_height height of our opengl window
+ */
+bool sg_glDumpWindow( const char *filename, int win_width, int win_height );
 
-// dump the screen buffer to a ppm file
-void my_glDumpWindow( const char *filename, int win_width, int win_height );
 
-void my_glWritePPMFile( const char *filename, GLubyte *buffer, int win_width, 
+/**
+ * Given a GLubyte *buffer, write it out to a ppm file.
+ * @param filename name of file
+ * @param buffer pointer to opengl buffer
+ * @param win_width width of buffer
+ * @param win_height height of buffer
+ * @param mode one of GL_RGBA, GL_RGB, etc.
+ */
+bool sg_glWritePPMFile( const char *filename, GLubyte *buffer, int win_width, 
                        int win_height, int mode);