ruby-opengl 0.60.0-i386-mswin32

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions: 
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software. 
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE. 

data/README.txt

@@ -0,0 +1,47 @@
+ruby-opengl
+===========
+
+[ruby-opengl][] consists of Ruby extension modules that are bindings for
+the [OpenGL][], GLU, and [GLUT][] libraries. It is intended to be a
+replacement for -- and uses the code from -- [Yoshi's ruby-opengl][].
+
+It's licensed under the MIT license. Please see the included MIT-LICENSE
+file for the terms of the license.
+
+
+[ruby-opengl]: http://rubyforge.org/projects/ruby-opengl/
+[OpenGL]: http://www.opengl.org/
+[GLUT]: http://www.opengl.org/documentation/specs/glut/spec3/spec3.html
+
+
+[Yoshi's ruby-opengl]: http://www2.giganet.net/~yoshi/
+
+
+Current release: 0.60.0 (December 29, 2007)
+-----------------
+Changes in this release:
+* Automatic error checking for GL/GLU calls, enabled by default (see doc/tutorial)
+* Added support for many more OpenGL extensions
+* Support for Ruby 1.9.0+ (requires mkrf 0.2.3)
+* Ton of bugfixes.<br><br>
+<b>API Changes:</b>
+* Boolean functions/parameters was changed to ruby true/false instead of GL\_TRUE / GL\_FALSE, which remains for compatibility
+* glGet\* functions now returns x instead of [x] when returning only one value
+* Functions operating on packed strings (glTexture, gl\*Pointer etc.) now also accepts ruby arrays directly
+* Matrix handling functions now also accepts instances of Matrix class, or any class that can be converted to array
+* glUniform\*v and glUniformmatrix\*v now does not require 'count' parameter, they will calculate it from length of passed array
+* glCallLists needs type specifier (previously was forced to GL_BYTE)
+* On ruby 1.9, glut keyboard callback returns char ("x") instead of integer so using 'if key == ?x' works on both 1.8 and 1.9
+
+Previous release: 0.50.0 (October 23, 2007)
+-----------------
+Changes in this release:
+
+* GLU and GLUT cleanup, bugfixes, some missing functions added - version 3.7
+  of GLUT API is now requirement (previously 3.0)
+* We added support for number of OpenGL extensions
+* Some new examples and code cleanup
+* Support for OpenGL 2.1 (that includes pixelpack/unpack buffer)
+* Some code refactoring to remove duplicity
+* Documentation update (still no API doc though)
+* Lots of bugfixes.

data/doc/build_install.txt

@@ -0,0 +1,122 @@
+Building ruby-opengl
+====================
+
+Pre-requisites
+--------------
+
+General
+--------------
+* C compiler (not needed for binary install on Windows)
+* ruby 1.8.5+ or ruby 1.9.0+
+* rake
+* mkrf 0.2.0+ (0.2.3+ for ruby 1.9)
+* rubygems 0.9.1+
+* OpenGL headers for OpenGL version 1.1 or later (not needed for binary install on Windows)
+* GLUT 3.7+ or API-compatible implementation (freeglut,OpenGLUT)
+
+Linux
+--------------
+On Ubuntu or Debian systems, aside from Ruby you'll need ruby and
+some extra ruby related packages:
+
+* `ruby rdoc ri ruby1.8-dev`
+
+For OpenGL related headers you'll need the following packages:
+
+* `libgl1-mesa-dri libglu1-mesa freeglut3`
+* `libgl1-mesa-dev libglu1-mesa-dev freeglut3-dev`
+
+On older Gentoo, Debian and Ubuntu, rubygems 0.9.0 will be installed by default
+in the packages.  This version of rubygems is INCOMPATIBLE with ruby-opengl.
+You'll need to install rubygems 0.9.1+ from source.
+
+On some distributions you may need 'xorg-dev' developer package.
+
+Mac OS X
+--------------
+On OS X, you will need to install your own version of Ruby as the
+version that ships with OS X has known problems with properly building
+ruby-opengl bindings.  You'll also need XCode for gcc and tools.  Macports
+or fink should handle this cleanly.
+
+* To compile under Mac OS X you MUST install your own version of Ruby
+  as the version included with Tiger (1.8.2) has a broken rbconfig
+  and will fail to build the project properly.  Try either [MacPorts][],
+  [Fink][], or [building your own from source][].
+
+[Macports]: http://www.macports.org/
+[Fink]: http://finkproject.org/
+[building your own from source]: http://www.ruby-lang.org/en/downloads/
+
+Windows
+--------------
+For manual build on Windows you need to have platform SDK and compiler that *must* match the one which was used for compiling ruby binary (for One-click ruby installer it is MSVC 6.0).
+You may also need 'glut.h' in SDK include directory, as the One-click ruby
+installer is missing it. You can copy the file from glut package at [glut homepage][].
+Alternatively, you can install the precompiled binary gem (see bellow).
+
+<b>Important note:</b> If you are using the One-click installer version 1.8.6-25 or earlier,
+you must delete or rename files 'opengl.so' and 'glut.so' in
+C:/ruby/lib/ruby/site_ruby/1.8/i386-msvcrt
+
+[glut homepage]: http://www.xmission.com/~nate/glut.html
+
+Build and installation
+--------------
+
+Installing from rubygems
+-------------------
+
+ruby-opengl should support being installed via gems now.  Just
+try 'gem install -y ruby-opengl' and it should pull down the gem
+and try to build the bindings for you automatically.
+
+For windows there is also pre-built binary windows gem available
+(i386-mswin32) which is compatible with the ruby one-click installer and does not need
+compiler or other mentioned tools installed.
+
+Manual Build instructions for all platforms (see above for platform-specific notes)
+------------------
+1. Make sure you have working ruby with rubygems installed
+	 and (if needed) appropriate developer packages (ruby-dev,ruby1.8-dev,...).
+2. Make sure you have working C compiler
+3. Install rake either from package or by running 'gem install rake'
+4. Install mkrf (0.2.0+) either from package or by running 'gem install mkrf'
+5. Make sure you have working OpenGL installation, this includes libGL,libGLU,
+   glut and (if needed) appropriate -dev or -devel packages.
+6. Run 'rake' at the top level of the project
+7. (OPTIONAL) Run 'rake test' to run unit tests to verify it works properly
+
+Installing manually built extensions
+------------------
+1. Run 'rake clean' to clean out the project
+2. Run 'rake gem' to create source gem from project
+3. Run 'gem install pkg/ruby-opengl-(version).gem' to compile and install the gem
+4. Done.
+
+Building binary gem (useful only for binary distribution of the project)
+------------------
+1. Run 'gem install gembuilder' to install the gembuilder package
+2. Run 'rake clean' to clean out the project
+3. Run 'rake gem' to build source gem
+4. Run 'gembuilder pkg/ruby-opengl-(version).gem' to compile the binary gem
+
+
+Testing
+-----------------
+
+To run unit tests:
+
+   $ rake test
+
+Note that the tests have the adverse effect of testing the underlying OpenGL
+implementation, so depending on your GL provider,drivers or OS, the tests may
+fail, crash, or not run at all, without affecting your ability to use the
+bindings.
+
+Running programs and examples
+-----------------
+To run a sample file, make sure the ruby-opengl gem is installed then:
+
+    $ cd examples
+    $ ruby -rubygems plane.rb

data/doc/history.txt

@@ -0,0 +1,66 @@
+Project history
+===============
+
+The [original ruby-opengl](http://www2.giganet.net/~yoshi/) was written
+by Yoshi.
+
+James A. desperately wanted to get the OpenGL Ruby bindings working on his Mac,
+but they wouldn't even compile on OSX. After a little bit of tweaking, he made
+his patched bindings available to the ruby community in a very informal manner.
+
+John G. then wanted to clean it up and add some docs to it, and so started
+tweaking and put up a new site and made his changes available.
+
+Then Peter M. came along and decided to try updating ruby-opengl using SWIG,
+as it seemed easier than doing everything by hand. Peter wrote the new code,
+John started the actual RubyForge project, put up a new site, and Peter
+committed the code.
+
+Thu M. V. joined the project with a lot of energy, and the mailing list
+was showing a good bit of activity.
+
+After some experience, we began to question whether SWIG was necessary/helpful
+for a project of this nature.  The leaning was that people want to abandon
+SWIG and go back to maintaining the binding files by hand. Thu even provided
+a script to help with the manual coding that would be required without using
+SWIG.
+
+The reasoning at the time was:
+
+Pro-SWIG:
+
+* Could use the .i files for another project, perhaps (OTOH, we couldn't
+  use previous .i files on this project...)
+
+* It's supposed to require less manual coding.
+
+Con-SWIG:
+
+* yet another tool to learn
+
+* OpenGL isn't really all that big
+
+* OpenGL doesn't change a lot
+
+* A lot of boilerplate and overhead in the generated files because SWIG is
+  a general tool.
+
+
+In September 2006, we stopped using SWIG. Thu and Peter began fine tuning
+Thu's original `utils/mkwrap.rb` script.
+
+Development stalled in October 2006.
+
+Development picked up again towards the end of 2006. After a long hiatus 
+and getting a new release of mkrf out the door, version 0.33 (following the
+numbering of original Yoshi's bindings which stalled at 0.32) was released.
+
+During first half of 2007, we added large portion of code, as well as number
+of unit tests, creating near-complete support for OpenGL 2.1.
+Support for MS Windows was also added during this time.
+
+Version 0.40 was released in July 2007.
+
+Version 0.50 was released in October 2007.
+
+Version 0.60 was released in December 2007.

data/doc/requirements_and_design.txt

@@ -0,0 +1,117 @@
+Design
+======
+
+This document records the requirements, high-level design, and the
+specifications for the ruby-opengl project.
+
+The content of this document was gleaned from the postings on the
+ruby-opengl-dev list and internal notes from John G., Peter M., Vo Minh Thu,
+and Robert K.
+
+
+Requirements
+------------
+
+* ruby-opengl is a Ruby extension library which wraps the OpenGL, GLU,
+  and GLUT libraries.
+
+* ruby-opengl shall provide three base modules: *BaseGL*, *BaseGLU*, and
+  *BaseGLUT* (the "Base Modules").
+
+  Note: "BaseGL" etc. are not the names that appear in the code -- they are
+  just handles so we can write about them in documents like this one.
+
+* The Base Modules shall be separately loadable.
+
+* BaseGL shall not depend on any of the other Ruby modules.
+
+* BaseGLU shall depend on, at most, BaseGL.
+
+* BaseGLUT shall depend on, at most, BaseGLU and BaseGL.
+
+* Base Module syntax shall closely follow the standard C-syntax.
+
+  The syntax for a Ruby program that uses the base modules, shall closely
+  follow the standard C-like syntax that OpenGL programmers are used to,
+  and that most OpenGL examples are published in:
+
+        {{ruby}}
+        require 'gl'
+        Gl.glBegin( Gl::GL_POLYGON )
+          Gl.glVertex2d( 0, 0 )
+          Gl.glVertex2d( 0, 1 )
+          Gl.glVertex2d( 1, 1 )
+          Gl.glVertex2d( 1, 0 )
+        Gl.glEnd
+
+  Or:
+
+        {{ruby}}
+        require 'gl'
+        include Gl
+        glBegin( GL_POLYGON )
+          glVertex2d( 0, 0 )
+          glVertex2d( 0, 1 )
+          glVertex2d( 1, 1 )
+          glVertex2d( 1, 0 )
+        glEnd
+
+  The rationale for adopting the C-like syntax is:
+    * Makes it familiar to OpenGL programmers.
+    * Removes the burden of learning OpenGL plus some Ruby-isms, just to
+      get started.
+    * Makes it easier to port OpenGL programs to/from ruby-opengl.
+    * The current OpenGL documentation more naturally fits ruby-opengl.
+    * Putting "gl", "glu" and "glut" in front of all the names (i.e.,
+      following the C-like syntax) leaves common variable names open for
+      the programmers (e.g., "vertex", "color" etc. are popular topics in
+      3D programming, so not robbing the ruby namespace of such valuable
+      real-estate seems nice).
+
+
+* It shall be possible to check out the project from svn, compile and test
+  on the following platforms: Mac OS X, GNU/Linux. MS Windows operating
+  systems may also be supported in the future.
+
+* The project will make a number of pre-compiled extensions available as gems.
+
+* The project will supply source code and build scripts (via svn checkout)
+  conducive to straightforward porting to other platforms.
+
+* There shall be a test suite that exercises each call in each of the Base
+  modules.
+
+* All project documentation will be in Markdown format in files that end in
+  `.txt`.
+
+* The project will make some efforts to track versions of OpenGL.
+
+
+### Things in the future
+
+Once the base modules are implemented, there are several ideas on things to
+do next.  This list is not really requirements, but a list of nice ideas to
+try:
+
+* Provide wrappers for glBegin/glEnd, eg: polygon()...translates to
+  glBegin(GL_POLYGON)....glEnd
+
+* Untyped versions of the multi-typed gl functions:  e.g., a single
+  glVertex that examines its arguments and calls the appropriate
+  glVertex{234}{fisdv} call in BaseGL.
+
+
+
+Implementation
+--------------
+
+Our plan is to continue on with Yoshi's original code, modified
+to use standard OpenGL-style constant and function names.
+
+
+### Build environment ###
+
+The build environment will use:
+
+* use rake and mkrf. 
+* minimize the number of additional tools required

data/doc/roadmap.txt

@@ -0,0 +1,28 @@
+Roadmap
+=======
+
+* Write comprehensive API documentation
+* Create more example code
+* Add RMagick(ImageMagick) integration for easy image handling (textures,screenshots)
+* Support all pixelstore modes (currently forced to default values by
+  any function getting/setting data affected by it)
+
+Possible Features
+========
+* Add **all** OpenGL extensions (some are obsolete or not really used or useful at all)
+* Add direct mapping on ruby types for vertex arrays, buffers and image data to allow high performance data operations from within ruby
+	- this should be modeled after Perl's OpenGL::Array
+	- Update: preliminary tests shows that performance-wise there is no need for it, as the Ruby interpreter overhead is currently larger than immediate-mode calls overhead, so any potential speed gains are in domain of 1-5%. It still may be good idea from usability perspective, although that would require more comprehensive design, not just simple wrapper.
+* Support for r/w VBO buffer mapping - gl(Un)MapBuffer (is it needed?)
+
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>

data/doc/scientific_use.txt

@@ -0,0 +1,35 @@
+Scientific Use
+--------------
+
+Though not directly related to ruby-opengl, this page contains a
+few tidbits of general info that might possibly be of interest to
+a number of users.
+
+There are currently two bindings to the [GNU Scientific Library][1] (GSL):
+
+* Yoshiki's Ruby/GSL (<http://rb-gsl.rubyforge.org/>) --
+  Comes with an API reference. Also, I've been told that the API has been
+  worked a bit to be more comfortable for Ruby programmers.
+* Arno's ruby-gsl (<http://ruby-gsl.sourceforge.net/>) --
+  more of a straight wrapper around the C API.
+
+[1]: http://www.gnu.org/software/gsl/
+
+<a href="http://rubyforge.org/softwaremap/trove_list.php?form_cat=97">Browse Rubyforge</a>
+for more.
+
+
+Links
+-----
+
+* <http://sciruby.codeforpeople.com/sr.cgi/FrontPage> -- SciRuby wiki.
+* <http://narray.rubyforge.org/> -- Numerical n-dimensional Array class.
+* <http://www.kitp.ucsb.edu/~paxton/tioga.html> -- Tioga. Create plots using
+  Ruby and TeX.
+
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>

data/doc/thanks.txt

@@ -0,0 +1,29 @@
+Thank you
+---------
+
+Aside from big thank-you's to the core devs, special thanks also goes to:
+
+* Bill Kelly -- provided some pilot code changing how users can call method and constant names.
+* Ilmari Heikkinen -- provided code for changing how users can call method and constant names.
+* James Adam -- Mac OS X fixes
+* Tony Hursh -- Mac OS X glut build tweak
+* Sean Long -- More Mac OS X fixes
+* John Gabriele -- Numerous fixes, documentation, and project support
+* Ronald Pijnacker -- Windows support and bugfixes
+* **Yoshi** -- providing ruby-opengl-0.32g from which to work off of.
+
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>