X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=simgear%2Fscreen%2Fscreen-dump.hxx;h=375f5398042b6c5ff7b3d653a5694ec2b1190049;hb=201cb61f842ef50a19438e3872ba22e588fa1afc;hp=c9976d38023e8fe73ea8812ce38c3e93eec97a31;hpb=82459a2802a939434f9fc5b88d2b2aea58f0043d;p=simgear.git

diff --git a/simgear/screen/screen-dump.hxx b/simgear/screen/screen-dump.hxx
index c9976d38..375f5398 100644
--- 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
@@ -12,16 +15,37 @@
 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 // Library General Public License for more details.
 //
-// You should have received a copy of the GNU Library General Public
-// License along with this library; if not, write to the
-// Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-// Boston, MA  02111-1307, USA.
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the Free Software
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 //
 // $Id$
 
+#ifndef SG_SCREEN_DUMP_HXX
+#define SG_SCREEN_DUMP_HXX
+
+#include <simgear/compiler.h>
 
-// dump the screen buffer to a ppm file
-void my_glDumpWindow( const char *filename, int win_width, int win_height );
+#include <osg/GL>
 
-void my_glWritePPMFile( const char *filename, GLubyte *buffer, int win_width, 
+/**
+ * Dump the screen buffer to a PNG 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 );
+
+
+/**
+ * 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);
+
+#endif // of SG_SCREEN_DUMP_HXX