rubygl 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: d0db02206c2e8a176817a841bc3ced8cfe60b4af
-  data.tar.gz: cc0aee2bc3df4f86b43b151e666b967ad9153b03
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZWE2NTJjYThmM2M2MGM0MmUwNmE5NTk1YmQxOTFiMTI5YTZkZjEzYg==
+  data.tar.gz: !binary |-
+    ZDRmMDFhZmI3MjJkZDEwZTgwMDg2N2I4NGI2YmFmOGRjOTg5MjUxYQ==
 SHA512:
-  metadata.gz: c37b401ada50218e49983b17a3e7d8f9486fe1a05f1b5bd99ac1ec67fd83cea4a6254c9febf8fa903a21b1f9364bed9bb8c1f8399a862e7eb7e71c3f220d5911
-  data.tar.gz: 7148dd01e893ed00fcfccb884b34d05e24a946ee01d668b637b3defc22a77b0f378784b225512394e6728a2f8210a266e2b247e3c36b3b05204623c3d33d7a86
+  metadata.gz: !binary |-
+    YjA1NWMzYzI1YTZiM2E2ZWEyYWI0NDUxYmM5ZmVlY2UyYThkOGU5M2RlN2Nk
+    NDlhZjA3NGUwMWQ1ZTMzOTE4M2Q2MmI3OTg0NDM1ZWYyNTVmMzgyY2I2NjJk
+    ODUzNGU0YTE5ZjFhYzY4OTFlYWJlYzgyYzI5YjQ0NWY0N2Q2OGI=
+  data.tar.gz: !binary |-
+    ODNkNTRmZmUxMTVmODU4OWUxMmMwZGNiM2Q1YzBlNjE5NGJiZjc4MmRjODk1
+    NjNlMTMxYTlhNzQ3OWZkZGEzOWNjZWE1ZjE0ZDFmODk0OWYyZTFhYmYyNDcx
+    MDhmZGFhNWY1ODA5OTNhN2JkMTgyMmIyY2Y0MjMxZDllNmMzNzY=

data/.travis/push-rdoc-to-gh-pages.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+if [ "$TRAVIS_REPO_SLUG" == "GGist/RubyGL" ] && [ "$TRAVIS_PULL_REQUEST" == "false" ] && [ "$TRAVIS_BRANCH" == "master" ]; then
+    echo -e "Publishing rdoc to gh-pages...\n"
+    
+    mkdir $HOME/rdoc-latest
+    rake doc
+    cp -r doc/* $HOME/rdoc-latest/.
+    
+    cd $HOME
+    git config --global user.email "travis@travis-ci.org"
+    git config --global user.name "travis-ci"
+    git clone --quiet --branch=gh-pages https://${GH_TOKEN}@github.com/GGist/RubyGL gh-pages > /dev/null
+    
+    cd gh-pages
+    cp -rf $HOME/rdoc-latest/* .
+    git add -A
+    git commit -m "Latest rdoc on successful travis build $TRAVIS_BUILD_NUMBER auto-pushed to gh-pages"
+    git push -fq origin gh-pages > /dev/null
+    
+    echo -e "Published rdoc to gh-pages.\n"
+fi

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+
+script:
+- bundle exec rake test
+
+env:
+  global:
+  - secure: qt435BABTrF0JP6PwK5WyyaMYMdDatHDT4yQcJq9BEfhMrhyY+Xdwzpkhq2UVkJ1r+g+ML5C7oNFQxUkDFS7PY4H7YhaPZHKCBbCpp9YH7yzMH7eWq4FtjGUt357kdGVhLietfqTiBl/pnxgAdUmvXxcjvZGHd2OORUymxRucIw=
+
+after_success:
+- chmod +x .travis/push-rdoc-to-gh-pages.sh
+- .travis/push-rdoc-to-gh-pages.sh
+
+deploy:
+  provider: rubygems
+  api_key:
+  - secure: ohBwl2E3XI6eP3O35SiJU5hnnh6/fah0yCtAHcs30PJaDuHHoCB/RfwhsiNHWAvs7jJGg261UD/Mz1t1vl3mpxx0KfTc1y/Px+5JbjHSlvd6OeVMu1fIZweYXofjQbhHjugbWmDKII5a1G+/4WEU6FTI0RGpGww1w+dh4nXjQj4=
+  gem: rubygl

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+group :test do
+    gem 'ffi'
+    gem 'rake'
+end
+

data/Gemfile.lock

@@ -0,0 +1,12 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ffi (1.9.5-x86-mingw32)
+    rake (0.9.6)
+
+PLATFORMS
+  x86-mingw32
+
+DEPENDENCIES
+  ffi
+  rake

data/LICENSE

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2014 Andrew
-
-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.
+The MIT License (MIT)
+
+Copyright (c) 2014 Andrew
+
+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.md

@@ -0,0 +1,40 @@
+RubyGL - [![Build Status](https://travis-ci.org/GGist/RubyGL.svg)](https://travis-ci.org/GGist/RubyGL) [![Documentation](http://img.shields.io/badge/docs-in--progress-blue.svg)](http://ggist.github.io/RubyGL/index.html) [![License](http://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/GGist/RubyGL/master/LICENSE)
+=======
+A Complete Solution For Graphics Programming In Ruby.
+
+Installing - [![Gem Version](https://badge.fury.io/rb/rubygl.svg)](http://badge.fury.io/rb/rubygl)
+----------
+```
+gem install rubygl
+```
+
+Examples Gallery
+----------------
+<img src="https://cloud.githubusercontent.com/assets/5248583/5156041/53eeb3ce-725b-11e4-908b-0b5aa7b37e2e.gif">
+<img align="right" src="https://cloud.githubusercontent.com/assets/5248583/5156042/55d1ee0e-725b-11e4-9edf-b240051a41b7.gif">
+
+Frequently Asked Questions
+--------------------------
+**Q: Why are my shaders not working?**  
+A: You probably have an older version of GLSL (1.2 or earler) so your version of GLSL may not support the ```in``` and ```out``` 
+variables (the shaders in ShaderGenerator use these). To work around this, you can change the ```in``` qualifiers in the 
+vertex shader to ```attribute``` qualifiers and the ```out``` qualifiers to ```varying``` qualifiers. In the fragment 
+shader change the ```in``` qualifiers to ```varying``` qualifiers and remove any ```out``` variables; you should use the 
+built-in ```gl_FragColor``` variable to assign the output fragment color. Lastly, make sure to update the ```#version XXX```
+tag for the version of GLSL your GPU can support (Ex: ```#version 120``` if running GLSL 1.2). You can check your
+GLSL version by running ```puts RubyGL::Native::glGetString(RubyGL::Native::GL_SHADING_LANGUAGE_VERSION)```.
+
+**Q: Why is my program giving a segmentation fault?**  
+A: You are most likely trying to call an OpenGL function that does not exist in your GPUs version of OpenGL. The offending
+function should be given to you in the stack trace. I have compiled the rubygl shared library for the latest version of OpenGL
+in compatibility mode to let users call any function that their version of OpenGL may support; the library will assume
+that any OpenGL function you are calling is valid (I should probably change this), hence the segmentation fault. Go to 
+https://www.opengl.org/sdk/docs/man/ to see which functions are supported by each OpenGL version. You can run 
+```puts RubyGL::Native::glGetString(RubyGL::Native::GL_VERSION)``` to see what version of OpenGL you have.
+
+Known Issues
+------------
+- Only supports Windows at the moment (OSX support coming soon)
+- Not sure how to support Linux without requiring users to compile a shared library
+- Windows does not guarantee that OpenGL functions loaded during context creation will be valid for other contexts
+ - Need to figure out how to efficiently swap these out if the user creates more than one context

data/Rakefile

@@ -1,83 +1,98 @@
-require 'rake/task'
-require 'rake/testtask'
-require 'tmpdir'
-
-SDL_INCLUDE = 'C:\Users\GG\Desktop\SDL2-2.0.3\i686-w64-mingw32\include\SDL2'
-SDL_LIB = 'C:\Users\GG\Desktop\SDL2-2.0.3\i686-w64-mingw32\lib'
-SDL_BIN = 'C:\Users\GG\Desktop\SDL2-2.0.3\i686-w64-mingw32\bin'
-
-MINGW_LIB = ''
-
-PROJ_INCLUDE = 'lib/RubyGL/Native/include'
-PROJ_SRC = 'lib/RubyGL/Native/src/'
-
-# OS Detection
-def os
-    @os ||= (
-        host_os = RbConfig::CONFIG['host_os']
-        
-        case host_os
-            when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
-                :windows
-            when /darwin|mac os/
-                :macosx
-            when /linux/
-                :linux
-            when /solaris|bsd/
-                :unix
-            else
-                raise Error::WebDriverError, "unknown os: #{host_os.inspect}"
-        end
-    )
-end
-
-/---------------------------------RAKE JOBS-----------------------------------/
-
-task :default do
-    files = ['Audio', 'Window', 'GLContext', 'Input', 'OpenGL']
-    
-    # Build Object Files
-    obj = "gcc -I#{SDL_INCLUDE}  -I#{PROJ_INCLUDE} -c -fPIC REPLACE.c -o REPLACE.o"
-    files.each { |file|
-        sh (obj.gsub(/REPLACE/, PROJ_SRC + file))
-        file = file.prepend PROJ_SRC
-    }
-
-    # Build Shared Object File
-    bin = "gcc -L#{SDL_LIB} -L#{MINGW_LIB} #{files.join('.o ') << '.o'} \
-        -lmingw32 -lSDL2main -lSDL2 -lopengl32 -shared -o \
-        ext/#{os.to_s}/RubyGL.so"
-    sh bin
-end
-
-task :clean do
-    # Clean Out Object Files
-    FileUtils.rm Dir.glob(PROJ_SRC + '/*.o')
-end
-
-task :bindings do
-    shared_lib = "RubyGL.so"
-
-    Dir.mktmpdir { |dir|
-        # Generates Header And Source C Files
-        sh "ruby bin/gl_code_gen.rb gl 4.5 OpenGL #{dir}"
-    
-        # Run Preprocessor On Source File
-        sh "gcc -E -I#{SDL_INCLUDE} -o #{dir}/OpenGL.o #{dir}/OpenGL.c"
-    
-        # Pipe Preprocessor(ed) File And Header File To Generate Bindings
-        sh "ruby bin/ffi_code_gen.rb #{dir}/OpenGL.o #{dir}/OpenGL.h \
-            #{dir}/opengl.rb #{shared_lib}"
-    
-        # Move Files To Correct Folders
-        mv "#{dir}/OpenGL.h", PROJ_INCLUDE
-        mv "#{dir}/OpenGL.c", PROJ_SRC
-        mv "#{dir}/opengl.rb", "lib/RubyGL/Native/"
-    }
-end
-
-Rake::TestTask.new do |t|
-  t.libs << "tests"
-  t.test_files = FileList['tests/test*.rb']
-  t.verbose = true
-end
+require 'rake/task'
+require 'rake/testtask'
+require 'tmpdir'
+
+# Dependency Locations
+SDL_INCLUDE = 'C:\Users\GG\Desktop\SDL2-2.0.3\i686-w64-mingw32\include\SDL2'
+SDL_LIB = 'C:\Users\GG\Desktop\SDL2-2.0.3\i686-w64-mingw32\lib'
+SDL_BIN = 'C:\Users\GG\Desktop\SDL2-2.0.3\i686-w64-mingw32\bin'
+
+# C File Locations
+PROJ_INCLUDE = 'lib/rubygl/native/include/'
+PROJ_SRC = 'lib/rubygl/native/src/'
+
+# OS Detection
+def os
+    @os ||= (
+        host_os = RbConfig::CONFIG['host_os']
+        
+        case host_os
+            when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+                :windows
+            when /darwin|mac os/
+                :macosx
+            when /linux/
+                :linux
+            when /solaris|bsd/
+                :unix
+            else
+                raise Error::WebDriverError, "unknown os: #{host_os.inspect}"
+        end
+    )
+end
+
+/---------------------------------RAKE JOBS-----------------------------------/
+
+task :default => [:bindings, :build, :clean]
+
+# Builds The RubyGL Shared Library From C Source Files And SDL Library
+task :build do
+    files = ['Window', 'GLContext', 'Input', 'OpenGL']
+    
+    # Build Object Files
+    obj = "gcc -I#{SDL_INCLUDE}  -I#{PROJ_INCLUDE} -c -fPIC REPLACE.c -o REPLACE.o"
+    files.each { |file|
+        sh (obj.gsub(/REPLACE/, PROJ_SRC + file))
+        file = file.prepend PROJ_SRC
+    }
+
+    # Build Shared Object File
+    bin = "gcc -L#{SDL_LIB} #{files.join('.o ') << '.o'} -lSDL2main -lSDL2 \
+           -lopengl32 -shared -o ext/#{os.to_s}/RubyGL.so"
+    sh bin 
+end
+
+# Created The Documentation For The Library
+task :doc do
+    sh "rdoc lib/*"
+end
+
+# Clean Out Generated Files Silently
+task :clean do
+    FileUtils.rm_r('doc', {:secure => true, :force => true})
+
+    FileUtils.rm_f(PROJ_INCLUDE + '/OpenGL.h')
+    
+    FileUtils.rm_f(PROJ_SRC + '/OpenGL.c')
+    
+    FileUtils.rm_f Dir.glob(PROJ_SRC + '/*.o')
+end
+
+# Generate Updated OpenGL Bindings
+task :bindings do
+    gl_api, gl_version, shared_lib = 'gl', '4.5C', 'RubyGL.so'
+
+    Dir.mktmpdir { |dir|
+        # Generates C Header And Source Files
+        sh "ruby bin/gl_code_gen.rb #{gl_api} #{gl_version} OpenGL #{dir}"
+    
+        # Run Preprocessor On C Source File
+        sh "gcc -E -I#{SDL_INCLUDE} -o #{dir}/OpenGL.o #{dir}/OpenGL.c"
+    
+        # Pipe Preprocessor(ed) File And Header File To Generate Bindings
+        sh "ruby bin/ffi_code_gen.rb #{dir}/OpenGL.o #{dir}/OpenGL.h \
+            #{dir}/opengl.rb #{shared_lib}"
+    
+        # Move Files To Correct Folders
+        mv "#{dir}/OpenGL.h", PROJ_INCLUDE
+        mv "#{dir}/OpenGL.c", PROJ_SRC
+        mv "#{dir}/opengl.rb", "lib/rubygl/native/"
+    }
+end
+
+# Run All Tests In The tests Directory
+Rake::TestTask.new do |t|
+  t.libs << 'test' << 'lib/rubygl'
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end