GNOME.org
 

[gtkglarea] * AUTHORS README TODO docs/HOWTO.txt: update documentation.

commit 8b6c0a7f57764ae9cfe71ec8a94776dbd3b14f05
Author: Sam Hocevar <sam hocevar net>
Date:   Sat Jul 18 01:06:52 2009 +0200

    * AUTHORS README TODO docs/HOWTO.txt: update documentation.

 AUTHORS        |   21 +++++++++--
 ChangeLog      |   69 ++++++++++++++++++-----------------
 MAINTAINERS    |    2 +-
 README         |   45 +++++++----------------
 TODO           |    5 +--
 docs/HOWTO.txt |  111 +++++++++++++++++++++++---------------------------------
 gtkgl/gdkgl.c  |    2 +-
 7 files changed, 117 insertions(+), 138 deletions(-)
---
diff --git a/AUTHORS b/AUTHORS
index adf7155..b88ad1a 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -1,5 +1,18 @@
-C.J. Adams-Collier <cjcollier colliertech org>
+Current authors and maintainers
+-------------------------------
+ Sam Hocevar <sam hocevar net>
+ C.J. Adams-Collier <cjcollier colliertech org>
+
+Previous authors
+----------------
+ Xavier Ordoquy <xordoquy wanadoo fr>
+ Janne Löf <jlof mail student oulu fi>
+
+Contributors
+------------
+ Karl Nelson <kenelson ece ucdavis edu> (original autoconf, gtkglarea--)
+ Daniel Skarda <0rfelyus atrey karlin mff cuni cz> (original autotools)
+ Jussi Löf <jussi lof pirko fi> (LightWave objects)
+ Andrew Marriott <raytrace lillee cs curtin edu au> (original win32 port)
+ Chris Abernethy <chris65536 home com> (gtkglarea_demo.c)
 
-Retired:
-Xavier Ordoquy <xordoquy wanadoo fr>
-Janne Löf      <jlof mail student oulu fi>
diff --git a/ChangeLog b/ChangeLog
index 12b061a..4da2df4 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,21 +1,24 @@
-2009-02-19  Sam Hocevar  <sam zoy org>
+2009-07-18  Sam Hocevar  <sam hocevar net>
+	* AUTHORS README TODO docs/HOWTO.txt: update documentation.
+
+2009-02-19  Sam Hocevar  <sam hocevar net>
 	* gtkgl/gdkgl.c: fix a pointer/int confusion warning on Win32.
 
-2009-02-19  Sam Hocevar  <sam zoy org>
+2009-02-19  Sam Hocevar  <sam hocevar net>
 	* gtkgl/gdkgl.c: fix the Win32 build by defining PLATFORM everywhere.
 
-2009-02-18  Sam Hocevar  <sam zoy org>
+2009-02-18  Sam Hocevar  <sam hocevar net>
 	* gtkgl/gdkgl.c: emit a warning if the GL context could not be shared.
 
-2008-10-20  Sam Hocevar  <sam zoy org>
+2008-10-20  Sam Hocevar  <sam hocevar net>
 	* configure.ac: get rid of USE_WIN32, glib.h knows our windowing
 	platform better than us.
 
-2008-10-20  Sam Hocevar  <sam zoy org>
+2008-10-20  Sam Hocevar  <sam hocevar net>
 	* autogen.sh: regenerate config.h.in by running autoheader with the
 	--force flag.
 
-2008-10-20  Sam Hocevar  <sam zoy org>
+2008-10-20  Sam Hocevar  <sam hocevar net>
 	Bug 384072 â?? Add stubs for other windowing platforms
 
 	* gdkgl.c gtkglarea.c: use GDK_WINDOWING_WIN32 etc. instead of
@@ -23,55 +26,55 @@
 
 	* gdkgl.c gtkglarea.c: add stubs for unsupported windowing platforms.
 
-2008-10-20  Sam Hocevar  <sam zoy org>
+2008-10-20  Sam Hocevar  <sam hocevar net>
 	* gdkgl.c gtkglarea.c: minor code factorisation.
 
-2008-09-22  Sam Hocevar  <sam zoy org>
+2008-09-22  Sam Hocevar  <sam hocevar net>
 	* shaders.c: gl_TexCoord is read-only in a fragment shader; use a
 	temporary variable instead.
 
-2008-09-22  Sam Hocevar  <sam zoy org>
+2008-09-22  Sam Hocevar  <sam hocevar net>
 	* examples/shaders.c: improve code readability.
 
-2008-09-22  Sam Hocevar  <sam zoy org>
+2008-09-22  Sam Hocevar  <sam hocevar net>
 	* Cosmetic fix: remove trailing spaces from source files.
 
-2008-09-22  Sam Hocevar  <sam zoy org>
+2008-09-22  Sam Hocevar  <sam hocevar net>
 	* examples/shaders.c: fix shader syntax by replacing (float)xxx with
 	float(xxx).
 
-2008-09-05  Sam Hocevar  <sam zoy org>
+2008-09-05  Sam Hocevar  <sam hocevar net>
 	* examples/zktor.c: cosmetic gcc warning fix.
 
-2007-06-18  Sam Hocevar  <sam zoy org>
+2007-06-18  Sam Hocevar  <sam hocevar net>
 	* gtkgl/gdkgl.c: fix a signed/unsigned compilation warning.
 
-2007-04-01  Sam Hocevar  <sam zoy org>
+2007-04-01  Sam Hocevar  <sam hocevar net>
 	* Proper GL shader extensions checks for the shader example, courtesy
 	of Ã?ric Beets.
 
-2007-03-07  Sam Hocevar  <sam zoy org>
+2007-03-07  Sam Hocevar  <sam hocevar net>
 	* Fix a minor warning by changing char * to char const * in a prototype.
 
-2007-03-07  Sam Hocevar  <sam zoy org>
+2007-03-07  Sam Hocevar  <sam hocevar net>
 	* Get rid of WinMain in viewlw.c and simple.c, the other examples don't
 	have it and work like a charm.
 
-2007-03-07  Sam Hocevar  <sam zoy org>
+2007-03-07  Sam Hocevar  <sam hocevar net>
 	* Build with -Wall by default.
 	* Replace BASE_DEPENDENCIES_* with GTK_* for better readability.
 
-2007-03-07  Sam Hocevar  <sam zoy org>
+2007-03-07  Sam Hocevar  <sam hocevar net>
 	* Starting the gtkgl.c reorganisation.
 
-2007-03-07  Sam Hocevar  <sam zoy org>
+2007-03-07  Sam Hocevar  <sam hocevar net>
 	* Merged gdkgl.c and gdkgl-win32.c. No refactoring yet, just code
 	copies.
 
-2007-03-07  Sam Hocevar  <sam zoy org>
+2007-03-07  Sam Hocevar  <sam hocevar net>
 	* Converted all text files to UTF-8.
 
-2007-03-07  Sam Hocevar  <sam zoy org>
+2007-03-07  Sam Hocevar  <sam hocevar net>
 	* Put uninteresting autotools files in the .auto subdirectory.
 	* Get rid of outdated ltmain.sh and run libtoolize in autogen.sh
 	instead.
@@ -80,44 +83,44 @@
 	gcc.
 	* Use more modern AC_INIT syntax in configure.ac.
 
-2007-03-06  Sam Hocevar  <sam zoy org>
+2007-03-06  Sam Hocevar  <sam hocevar net>
 	* Remove the executable property from gtkgl/gdkgl-win32.c.
 
-2007-03-06  Sam Hocevar  <sam zoy org>
+2007-03-06  Sam Hocevar  <sam hocevar net>
 	* Add svn:ignore properties to hide various autotools-generated files.
 
-2007-03-06  Sam Hocevar  <sam zoy org>
+2007-03-06  Sam Hocevar  <sam hocevar net>
 	* Support for automake 1.10.1 in autogen.sh. The second comma was
 	triggering a shell test error.
 
-2007-03-06  Sam Hocevar  <sam zoy org>
+2007-03-06  Sam Hocevar  <sam hocevar net>
 	* Add a small message to warn the user that even if they see the
 	texture, fragment shaders are only working properly if it is coloured.
 
-2007-11-22  Sam Hocevar  <sam zoy org>
+2007-11-22  Sam Hocevar  <sam hocevar net>
 	* Added a fragment shader and vertex shader test example.
 
-2007-11-22  Sam Hocevar  <sam zoy org>
+2007-11-22  Sam Hocevar  <sam hocevar net>
 	* Add a configure check for OpenGL shader support (2.0 only) by
 	looking for glCreateProgram().
 
-2007-11-03  Sam Hocevar  <sam zoy org>
+2007-11-03  Sam Hocevar  <sam hocevar net>
 	* Fix compiler warnings due to missing <string.h> includes.
 
-2007-11-03  Sam Hocevar  <sam zoy org>
+2007-11-03  Sam Hocevar  <sam hocevar net>
 	* Cosmetic fix in a debug message.
 
-2007-11-03  Sam Hocevar  <sam zoy org>
+2007-11-03  Sam Hocevar  <sam hocevar net>
 	* Fix compiler warnings due to improper or missing casts.
 
-2007-11-03  Sam Hocevar  <sam zoy org>
+2007-11-03  Sam Hocevar  <sam hocevar net>
 	* Fix autogen support for newer (1.10+) versions of automake.
 
-2007-11-03  Sam Hocevar  <sam zoy org>
+2007-11-03  Sam Hocevar  <sam hocevar net>
 	* Fixed native Win32 build detection on Cygwin.
 	* Removed entries for non-existent Makefiles.
 
-2007-11-03  Sam Hocevar  <sam zoy org>
+2007-11-03  Sam Hocevar  <sam hocevar net>
 	* Fixing the MAINTAINERS file format and recklessly adding myself.
 
 2006-12-07  C.J. Adams-Collier <cjcollier colliertech org>
diff --git a/MAINTAINERS b/MAINTAINERS
index c88a7b5..d739996 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -3,7 +3,7 @@ E-mail: cjcollier colliertech org
 Userid: ccollier
 
 Sam Hocevar
-E-mail: sam zoy org
+E-mail: sam hocevar net
 Userid: samh
 
 Former maintainers:
diff --git a/README b/README
index 82591d4..daf2e6c 100644
--- a/README
+++ b/README
@@ -1,12 +1,13 @@
 GtkGLArea
----------
+=========
 
-
-AUTHOR
-------
+Authors
+-------
  Janne Löf <jlof mail student oulu fi>
+ C.J. Adams-Collier <cjcollier colliertech org>
+ Sam Hocevar <sam hocevar net>
 
-CONTRIBUTORS
+Contributors
 ------------
  Karl Nelson     <kenelson ece ucdavis edu>          (original autoconf, gtkglarea--)
  Daniel Skarda   <0rfelyus atrey karlin mff cuni cz> (original automake & libtool)
@@ -14,25 +15,7 @@ CONTRIBUTORS
  Andrew Marriott <raytrace lillee cs curtin edu au>  (original win32 port)
  Chris Abernethy <chris65536 home com>               (gtkglarea_demo.c)
 
-LICENSE
--------
-
-    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 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
-    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., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-
-INTRODUCTION
+Introduction
 ------------
 
  GtkGLArea is an OpenGL widget for GTK+ GUI toolkit.
@@ -42,13 +25,13 @@ INTRODUCTION
  from GtkDrawinigArea widget and adds only few extra functions.
 
  Lower level gdkgl functions make it easy to render on any widget that has
- OpenGL capable visual, rendering to off-screen pixmaps is also supported. 
+ OpenGL capable visual, rendering to off-screen pixmaps is also supported.
 
  Related project which may iterest those who use GTK-- is GtkGLArea--. It is a
- C++ wrapper for gtkglarea written by Karl Nelson <kenelson ece ucdavis edu>. 
+ C++ wrapper for gtkglarea written by Karl Nelson <kenelson ece ucdavis edu>.
 
 
-INSTALLATION
+Installation
 ------------
 
  You need GTK+ and either OpenGL or Mesa, if you have both you can choose which
@@ -62,7 +45,7 @@ INSTALLATION
  Library files go to PREFIX/lib/
 
 
-WIN32
+Win32
 -----
 
  There is now a working windows port. There are old hand-written
@@ -97,7 +80,7 @@ WIN32
  functions, no gdk_gl_* functions.
 
 
-DOCUMENTATION
+Documentation
 -------------
 
  Documentation is slightly out of date, sorry.
@@ -107,14 +90,14 @@ DOCUMENTATION
  docs/HOWTO.txt		good advice
 
 
-LINKS
+Links
 -----
 
  GtkGLArea home page http://www.student.oulu.fi/~jlof/gtkglarea/
  Gtk-- wrapper http://www.ece.ucdavis.edu/~kenelson/gtk-glarea/
 
 
-TODO
+Todo
 ----
 
  - rewrite documentation in texinfo format
diff --git a/TODO b/TODO
index c3df686..50fa098 100644
--- a/TODO
+++ b/TODO
@@ -1,4 +1,3 @@
 1) Ensure windows compatability exists
-2) Bump version to 2.0
-3) code audit
-4) begin using glitz.  This will provide better cross-platform support
+2) code audit
+3) begin using glitz.  This will provide better cross-platform support
diff --git a/docs/HOWTO.txt b/docs/HOWTO.txt
index 16be03b..1649742 100644
--- a/docs/HOWTO.txt
+++ b/docs/HOWTO.txt
@@ -2,110 +2,91 @@
 
 1. Help, ./configure does not find Mesa, I do have Mesa libaries installed.
 
-	- Mesa may need additional libraries to link with, depending on what
-	  options were used while compiling Mesa libraries. Currently configure tries
-	  to link Mesa with whatever libraries GTK needs and if this fails it tries
-	  Mesa+needed by GTK+pthreads libraries. Try passing extra libraries to
-	  ./configure in LIBS envinronment variable.
-
-	- configure scripts are still a bit flaky, patches are gratefully accepted.
-
+    - Mesa may need additional libraries to link with, depending on what
+      options were used while compiling Mesa libraries. Currently configure
+      tries to link Mesa with whatever libraries GTK needs and if this fails
+      it tries adding the pthreads libraries. Try passing extra libraries to
+      ./configure in LIBS envinronment variable.
 
 
 
 2. How do I make any widget opengl widget?
 
-	Your widget needs OpenGL capable visual and you also
-	need to set colormap for it. Widget must also have
-	X window (not all widgets have it).
+    Your widget needs an OpenGL capable visual and you also need to set
+    a colormap for it. The widget must also have an X window (not all
+    widgets have it).
 
-	/* get visual using gdk_gl_choose_visual */
-	visual = gdk_gl_choose_visual(visual_attributes);
+    /* get visual using gdk_gl_choose_visual */
+    visual = gdk_gl_choose_visual(visual_attributes);
 
-	/* set visual and colormap */
-	gtk_widget_push__colormap(gdk_colormap_new(visual, TRUE));
-	gtk_widget_push_visual(visual);
+    /* set visual and colormap */
+    gtk_widget_push__colormap(gdk_colormap_new(visual, TRUE));
+    gtk_widget_push_visual(visual);
 
-	/* create your widget */
-	widget = gtk_foobar_new();
+    /* create your widget */
+    widget = gtk_foobar_new();
 
-	/* disable backing store (only in GTK-1.4) */
-	gtk_widget_set_double_buffered(widget, FALSE);
-
-	/* restore old values */
-	gtk_widget_pop_visual();
-	gtk_widget_pop_colormap();
+    /* disable backing store (only in GTK-1.4) */
+    gtk_widget_set_double_buffered(widget, FALSE);
 
+    /* restore old values */
+    gtk_widget_pop_visual();
+    gtk_widget_pop_colormap();
 
 
 
 3. How do I render to such widget?
 
-	Create gl context and connect it to widgets GdkDrawable.
+    Create a GL context and connect it to the widget's GdkDrawable.
 
-	context = gdk_gl_context(visual);
- 
-	/* connect to gdk window of widget */
-	if (gdk_gl_make_current(widget->window, context)) {
-		do opengl stuff...
+    context = gdk_gl_context(visual);
 
-	}
+    /* connect to gdk window of widget */
+    if (gdk_gl_make_current(widget->window, context)) {
+        /* do opengl stuff... */
 
+    }
 
 
 
-4. How do I render to off screen pixmap?
+4. How do I render to an off-screen pixmap?
 
-	See examples/glpixmap.c, remember that pixmaps can not be rendered to with
-	direct context.
+    See examples/glpixmap.c, remember that pixmaps can not be rendered to with
+    direct context.
 
 
 
 5. Can I use gdk_gl functions and GtkGLArea widget in the same program?
 
-	Yes, just remember that gtk_gl_area_make_current makes internal context of
-	GtkGLArea widget current context (and leaves it so).
+    Yes, just remember that gtk_gl_area_make_current() makes the GtkGLArea
+    widget's internal context the current context and leaves it so.
 
 
 
 6. How do I capture keypress events for GtkGLArea widget?
 
-	This is not a GtkGLArea specific question, but here is the answer anyway,
-
-	- You forgot to set event mask:
-		 gtk_widget_set_events(glarea, GDK_KEY_PRESS_MASK);
-
-	- You forgot to grab focus:
-		GTK_WIDGET_SET_FLAGS(glarea, GTK_CAN_FOCUS);
-		gtk_widget_grab_focus(GTK_WIDGET(glarea));
-
-	-  keypresses/releases have default handlers, you may need to prevent
-	   them from running:
-		/* do this in your signal keypress handler and return TRUE from handler */
-		gtk_signal_emit_stop_by_name(GTK_OBJECT(glarea),"key_press_event");
-		
-
-
+    This is not a GtkGLArea specific question, but here is a solution:
 
-7. I noticed that gtk_gl_area_begingl(), gtk_gl_area_endgl(), and gtk_gl_area_swapbuffers()
-   are deprecated?
+    - Set an event mask:
+         gtk_widget_set_events(glarea, GDK_KEY_PRESS_MASK);
 
-	- they are still there, but you should use gtk_gl_area_make_current() instead
-	  then you can avoid calling matching gtk_gl_area_endgl().
+    - Grab the focus:
+        GTK_WIDGET_SET_FLAGS(glarea, GTK_CAN_FOCUS);
+        gtk_widget_grab_focus(GTK_WIDGET(glarea));
 
-	- just formalizing what has been true for a long time, gtk_gl_area_endgl is
-	  no longer necessary and gtk_gl_area_begingl() just makes widgets context
-	  current.
+    - Prevent possible default handlers from running:
+        /* do this in the keypress handler and return TRUE from handler */
+        gtk_signal_emit_stop_by_name(GTK_OBJECT(glarea), "key_press_event");
 
-	- gtk_gl_area_swapbuffers() just fixes minor spelling error.
 
-	- old versions wont go away.
 
-	- to convert your code you can replace them with following functions.
+7. Where are gtk_gl_area_begingl() and gtk_gl_area_endgl()?
 
-	   gtk_gl_area_begingl()     =>  gtk_gl_area_make_current()
-	   gtk_gl_area_endgl()       =>  glFlush() or nothing
-	   gtk_gl_area_swapbuffers() =>  gtk_gl_area_swap_buffers()
+    These functions are deprecated. You should use gtk_gl_area_make_current()
+    instead of gtk_gl_area_begingl().
 
+    gtk_gl_area_endgl() is no longer required, but you may wish to call
+    glFlush() instead.
 
+    gtk_gl_area_swapbuffers() was renamed to gtk_gl_area_swap_buffers().
 
diff --git a/gtkgl/gdkgl.c b/gtkgl/gdkgl.c
index 8aa5c99..3d908ee 100644
--- a/gtkgl/gdkgl.c
+++ b/gtkgl/gdkgl.c
@@ -1,6 +1,6 @@
 /*
  * Copyright (C) 1998 Janne Löf <jlof mail student oulu fi>
- *           (c) 2008 Sam Hocevar <sam zoy org>
+ *           (c) 2008, 2009 Sam Hocevar <sam hocevar net>
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]