G t k G L E x t

  - OpenGL Extension to GTK


General Information
===================

GtkGLExt is an OpenGL extension to GTK.

This package is composed of GdkGLExt library and GtkGLExt library.
GdkGLExt library provides the GDK objects which support OpenGL
rendering in GTK. GtkGLExt library provides the GtkWidget API add-ons
to make GTK+ widgets OpenGL-capable.

The official web site is:
  http://projects.gnome.org/gtkglext/


Licensing
=========

GtkGLExt libraries are released under the terms of the GNU Lesser
General Public License (GNU LGPL). While components and programs
included with this release are licensed under the terms of the GNU
General Public License (GNU GPL).


Supported Platforms
===================

Currently GtkGLExt supports

  * UNIX and UNIX-like platforms
      Tested under Linux, FreeBSD, IRIX, and Mac OS X.

  * Win32 platforms
      Tested under Windows XP & 2000 Professional using MinGW/Cygwin
      environment.


Requirements
============

  * GNU C compiler

  * GNU make

  * GTK 2.0 or later (http://www.gtk.org/)

  * OpenGL or Mesa (http://www.mesa3d.org/)

  * GTK-Doc (http://www.gtk.org/rdp/)  [optional]


Multihead Support
=================

Multihead support requires GTK+ 2.1 or above.

If GtkGLExt is already installed, you can check whether installed
GtkGLExt library supports multihead using the following command.

  $ pkg-config --variable=multihead gtkglext-3.0


Installation
============

To build and install GtkGLExt, type follows (use GNU make)

  $ ./configure --prefix=/foo/bar (other options...)
  $ make (or gmake)
  $ make install

To compile example programs, type

  $ make examples

Please read INSTALL or type "./configure --help" for more details.


Configure Options
=================

OpenGL options

  --with-gl-prefix=DIR      OpenGL (Mesa) is installed in DIR [default=auto]
  --with-gl-includedir=DIR  OpenGL (Mesa) headers are in DIR [default=auto]
  --with-gl-libdir=DIR      OpenGL (Mesa) libraries are in DIR [default=auto]

Debug options

  --enable-debug=[no/minimum/yes] turn on debugging [default=minimum]

Window system options

  --with-gdktarget=[x11/win32] select GDK target

Auto-generation files options

  --disable-rebuilds      disable all source autogeneration rules

Documentation options

  --enable-gtk-doc        use gtk-doc to build documentation [default=no]
  --with-html-dir=PATH    path to installed docs


Building the Git Version of GtkGLExt
====================================

GtkGLExt's GNOME Git repository can be checked out anonymously:

  $ git clone git://git.gnome.org/gtkglext

When you are working on the Git version of GtkGLExt, you can use autogen.sh
for generating configure script and Makefiles.

  $ env ACLOCAL_FLAGS='-I /pkgconfig/share/aclocal -I /gtk/share/aclocal' \
        ./autogen.sh --prefix=${HOME}/gtkglext \
                     --enable-debug=yes
  $ make
  $ make install
  $ make examples

You may have to set ACLOCAL_FLAGS environment variable for some m4
macros used in configure.ac.

The following versions of the GNU autotools are required.

  autoconf 2.54 and above
  automake 1.7.x
  libtool  1.5


Contact
=======

Any patches, bug fixes and improvements are always welcome ;-)

  * Home: http://projects.gnome.org/gtkglext/
  * Mailing List: http://mail.gnome.org/mailman/listinfo/gtkglext-list/
  * Bugs & Patches: Use GNOME Bugzilla at https://bugzilla.gnome.org/enter_bug.cgi?product=gtkglext