- remove the SG_GLxxxx_H #defines, since OSG provides its own versions

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

diff --git a/simgear/screen/screen-dump.hxx b/simgear/screen/screen-dump.hxx
index bcdf11f3fbe41373e8c449779f56e8ae62b53ea1..25a4c1967222224f1b191af780654a3d94cd7558 100644 (file)
--- a/simgear/screen/screen-dump.hxx
+++ b/simgear/screen/screen-dump.hxx
@@ -1,26 +1,46 @@
-// 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 program is free software; you can redistribute it and/or
-// modify it under the terms of the GNU General Public License as
-// published by the Free Software Foundation; either version 2 of the
-// License, or (at your option) any later version.
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Library General Public
+// License as published by the Free Software Foundation; either
+// version 2 of the License, or (at your option) any later version.
 //
-// This program is distributed in the hope that it will be useful, but
-// WITHOUT ANY WARRANTY; without even the implied warranty of
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-// General Public License for more details.
+// Library General Public License for more details.
 //
 // 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., 675 Mass Ave, Cambridge, MA 02139, USA.
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 //
 // $Id$
 
+#include <simgear/compiler.h>
+
+#include <osg/GL>
+
+/**
+ * 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);