ashton 0.0.1alpha → 0.0.2alpha

data/LICENSE

@@ -1,21 +1,21 @@
-The MIT License
-
-Copyright (c) 2012 Bil Bas
-
-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
+
+Copyright (c) 2012 Bil Bas
+
+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

@@ -1,68 +1,95 @@
-Ashton
-======
-
-Description
------------
-
-Add extra visual effects to the Gosu game-development library, utilising OpenGL shaders (using shader model 1.0, for maximum compatibility) and frame-buffers.
-
-"Ashton" is named after [Clark Ashton Smith](http://en.wikipedia.org/wiki/Clark_Ashton_Smith), an fantasy/horror author
-with a particularly colourful imagination.
-
-- Author: Bil Bas (Spooner)
-- License: MIT
-
-Usage
------
-
-    gem install ashton --pre
-
-Features
---------
-
-- Gosu::Font
-  * [TODO] #draw - Added :shader hash option to choose optional shader to use.
-  * [TODO] #draw_rel - Added :shader hash option to choose optional shader to use.
-
-- Gosu::Image
-  * #draw - Added :shader hash option to choose optional shader to use.
-  * #draw_rot - Added :shader hash option to choose optional shader to use.
-  * [TODO] #flip!, #flip, #mirror!, #mirror, #scale!, #scale, etc.
-  * [TODO] #resize (Well, create another image which is smaller/larger).
-  * [TODO] #to_framebuffer
-
-- Gosu::Window
-  * #post_process {} - Draws contents of block into a back-buffer, then applies a shader as it draws that onto the screen.
-  * [TODO] #to_framebuffer - Copy the contents of the window as a {Ashton::Framebuffer}.
-  * [TODO] #to_image - Create Gosu::Image from window contents.
-  * [TODO] #draw_line - Added :shader hash option
-  * [TODO] #draw_quad - Added :shader hash option
-  * [TODO] #draw_triangle - Added :shader hash option
-
-- {Ashton::Shader}
-  * #use {} - Inside the block, all draw operations are affected by the shader.
-  * Supports vertex and fragment shaders.
-
-- {Ashton::PostProcess}
-  * A specific type of shader to perform full-screen post-processing.
-  * #process - Used to post-process the entire Gosu::Window at once, after some, or all, drawing is complete.
-  * Supports fragment shaders.
-  * [TODO] Includes a small library of example shaders (:blur, :simplex, etc).
-
-- {Ashton::Framebuffer}
-  * #use {} - Inside the block, draw operations go into the framebuffer, rather than onto the window.
-  * #to_image - Convert to Gosu::Image. 
-  * #draw - Draw directly onto a Gosu::Window.
-  * [TODO] #flip!, #flip - Invert framebuffer's vertical orientation.
-  
-Similar Libraries
------------------
-
-- [TexPlay](https://github.com/banister/texplay) - Deals with Gosu::Image manipulation, such as per-pixel editing and drawing. It is compatible with, and complementary to, this gem.
-
-Credits
--------
-
-- simplex.glsl - simplex noise implementation - Copyright (C) 2011 Ashima Arts - MIT license.
-  
-
+Ashton
+======
+
+Description
+-----------
+
+Add extra visual effects to the Gosu game-development library, utilising OpenGL shaders (using shader model 1.0, for maximum compatibility) and frame-buffers.
+
+"Ashton" is named after [Clark Ashton Smith](http://en.wikipedia.org/wiki/Clark_Ashton_Smith), an fantasy/horror author
+with a particularly colourful imagination.
+
+- Author: [Bil Bas (Spooner)](http://spooner.github.com/)
+- [Wiki](https://github.com/Spooner/ashton/wiki)
+- License: MIT
+
+Usage
+-----
+
+    gem install ashton --pre
+
+Features
+--------
+
+* Gosu extensions
+    - {Gosu::Color} - Converting to and from opengl values.
+
+    - {Gosu::Font} - Apply shader to draw operations.
+
+    - {Gosu::Image} - Apply shader to each draw operation or group of draws. Manipulation, such as flipping and scaling.
+
+    - {Gosu::Window} - Post-processing with shaders. Converting to image.
+
+* Ashton
+    - {Ashton::Texture} - Single texture (compared to Gosu::Image which uses a spritesheet) which can be drawn directly onto and drawn to the Window.
+
+    - {Ashton::Lighting::Manager} -  Manages and combines the lighting from {Ashton::Lighting::LightSource} objects.
+
+    - {Ashton::Lighting::LightSource} -  A single light-source that illuminates and whose can be blocked by shadow-casting objects.
+
+    - {Ashton::ParticleEmitter} - Generates, manages and displays particles.
+
+    - {Ashton::PixelCache} - Cached image data attached to an {Ashton::Texture} or {Gosu::Image}.
+
+    - {Ashton::SignedDistanceField} - A signed distance field based on a an image mask.
+
+    - {Ashton::Shader} -  Wrapper around a GLSL shaders, Supports vertex and fragment shaders. Small shader/function library.
+
+    - {Ashton::WindowBuffer} - Texture that is the same size as the Gosu Window that can capture the contents of the screen.
+
+Requirements
+------------
+
+* OSX/Linux: Requires OpenGL library be installed.
+
+* {Ashton::Shader} and {Ashton::Lighting} or anything else using shaders, require OpenGL 2.0.
+
+Similar Libraries
+-----------------
+
+- [TexPlay](https://github.com/banister/texplay) - Deals with Gosu::Image manipulation, such as per-pixel editing and drawing. It is compatible with, and complementary to, this gem.
+
+Third party
+-----------
+
+- OpenGL static library (in Windows binary gem) and headers.
+- [GLee](http://elf-stone.com/glee.php) source.
+
+- Various trivial shaders - "randomly found on the Internet" :$
+
+- (Classic and Simplex noise functions)[https://github.com/ashima/webgl-noise/] - Copyright (C) 2011 Ashima Arts - MIT license.
+  * classicnoise2d.glsl - 2D Classic Perlin noise implementation - `cnoise(vec2)`
+  * classicnoise3d.glsl - 3D Classic Perlin noise implementation - `cnoise(vec3)`
+  * classicnoise4d.glsl - 4D Classic Perlin noise implementation - `cnoise(vec4)`
+  * noise2d.glsl - 2D Simplex noise implementation - `snoise(vec2)`
+  * noise3d.glsl - 3D Simplex noise implementation - `snoise(vec3)`
+  * noise4d.glsl - 4D Simplex noise implementation - `snoise(vec4)`
+
+- [Bloom filter by myheroics](http://myheroics.wordpress.com/2008/09/04/glsl-bloom-shader/)
+  * bloom.frag
+
+- [Shockwave by Crystalin](http://empire-defense.crystalin.fr/blog/2d_shock_wave_texture_with_shader)
+  * shockwave.frag
+
+- [Radial Blur by gamerendering.com](http://www.gamerendering.com/2008/12/20/radial-blur-filter/)
+  * radial_blur.frag
+
+- Lighting based on, but much optimised from, Catalin Zima's shader based dynamic shadows system.
+  * http://www.catalinzima.com/2010/07/my-technique-for-the-shader-based-dynamic-2d-shadows/
+  * {Ashton::Lighting::LightSource} and {Ashton::Lighting::Manager} classes.
+  * shadow_blur.frag
+  * shadow_distory.frag
+  * shadow_draw_shadows.frag
+
+
+

data/Rakefile

@@ -1,24 +1,42 @@
-require 'rake/clean'
-require 'rspec/core/rake_task'
-require 'yard'
-require 'redcloth'
-require 'launchy'
-require 'rubygems/package_task'
-
-
-spec = Gem::Specification.load Dir['*.gemspec'].first
-
-Gem::PackageTask.new spec do
-end
-
-YARD::Rake::YardocTask.new
-
-task :default => :spec
-
-RSpec::Core::RakeTask.new do |t|
-end
-
-desc "Open yard docs in browser"
-task :browse_yard => :yard do
-  Launchy.open "doc/index.html" rescue nil
+require 'bundler/setup'
+
+require 'rake/clean'
+require 'rspec/core/rake_task'
+require 'rake/extensiontask'
+require 'yard'
+require 'redcloth'
+require 'launchy'
+
+begin
+  require 'devkit' # only used on windows
+rescue LoadError
+end
+
+
+spec = Gem::Specification.load Dir['*.gemspec'].first
+
+Gem::PackageTask.new spec do
+end
+
+Rake::ExtensionTask.new 'ashton', spec do |ext|
+  RUBY_VERSION =~ /(\d+.\d+)/
+  ext.lib_dir = "lib/ashton/#{$1}"
+end
+
+YARD::Rake::YardocTask.new
+
+task :default => :spec
+task :spec => :compile
+
+RSpec::Core::RakeTask.new do |t|
+end
+
+desc "Open yard docs in browser"
+task :browse_yard => :yard do
+  Launchy.open "doc/index.html" rescue nil
+end
+
+desc "Create platform-specific compiled gem"
+task :native_gem do
+  Rake::Task["native"].invoke "gem"
 end

data/examples/bloom_example.rb

@@ -0,0 +1,59 @@
+# Use of GLSL shader in Gosu to post-process the entire screen.
+
+begin
+  require 'rubygems'
+rescue LoadError
+end
+
+$LOAD_PATH.unshift File.expand_path('../lib/', File.dirname(__FILE__))
+require "ashton"
+
+def media_path(file); File.expand_path "media/#{file}", File.dirname(__FILE__) end
+
+class TestWindow < Gosu::Window
+  def initialize
+    super 640, 480, false
+    self.caption = "Post-processing with 'bloom' - mouse pos alters glare and power - hold <Space> to disable"
+
+    @bloom = Ashton::Shader.new fragment: :bloom
+
+
+    @font = Gosu::Font.new self, Gosu::default_font_name, 40
+    @star = Gosu::Image.new(self, media_path("LargeStar.png"), true)
+    @background = Gosu::Image.new(self, media_path("Earth.png"), true)
+
+    update # Ensure the values are initially set.
+  end
+
+  def update
+    $gosu_blocks.clear if defined? $gosu_blocks # Workaround for Gosu bug (0.7.45)
+    @bloom.glare_size = [0.008 * mouse_x / width, 0.0].max
+    @bloom.power = [0.5 * mouse_y / height, 0.0].max
+  end
+
+  def needs_cursor?; true end
+
+  def button_down(id)
+    if id == Gosu::KbEscape
+      close
+    end
+  end
+
+  def draw
+    shaders = button_down?(Gosu::KbSpace) ? [] : [@bloom]
+    post_process(*shaders) do
+      @background.draw 0, 0, 0, width.fdiv(@background.width), height.fdiv(@background.height)
+      @star.draw 0, 0, 0
+      @star.draw 200, 100, 0, 1, 1, Gosu::Color.rgb(100, 100, 100)
+    end
+
+    # Drawing after the effect isn't processed, which is useful for GUI elements.
+    @font.draw_rel "Less glare", 0, height / 2, 0, 0, 0.5
+    @font.draw_rel "More glare", width, height / 2, 0, 1, 0.5
+
+    @font.draw_rel "Less power", width / 2, 0, 0, 0.5, 0
+    @font.draw_rel "More power", width / 2, height, 0, 0.5, 1
+  end
+end
+
+TestWindow.new.show

data/examples/lighting_example.rb

@@ -0,0 +1,127 @@
+# Use of GLSL shader in Gosu to post-process the entire screen.
+
+begin
+  require 'rubygems'
+rescue LoadError
+end
+
+$LOAD_PATH.unshift File.expand_path('../lib/', File.dirname(__FILE__))
+require "ashton"
+
+def media_path(file); File.expand_path "media/#{file}", File.dirname(__FILE__) end
+
+class TestWindow < Gosu::Window
+  def initialize
+    super 640, 480, false
+    self.caption = "Shadow-casting - <space> new layout; <LMB> place light; <Arrows> to scroll"
+
+    @font = Gosu::Font.new self, Gosu::default_font_name, 32
+    @background = Gosu::Image.new(self, media_path("Earth.png"), true)
+
+    @star = Gosu::Image.new(self, media_path("LargeStar.png"), true)
+
+    # Input: Shadow casters are any object that casts a shadow.
+    place_shadow_casters
+
+    setup_lighting
+
+    # Perform the initial rendering into the light manager.
+    @lighting.update_shadow_casters do
+      draw_shadow_casters
+    end
+
+    @debug = false
+    @camera_x, @camera_y = 0, 0
+  end
+
+  def setup_lighting
+    @lighting = Ashton::Lighting::Manager.new
+
+    # Add some lights (various methods)
+    @lighting.create_light 240, 240, 0, height / 3, color: Gosu::Color::RED
+
+    light =  Ashton::Lighting::LightSource.new 400, 150, 0, height / 5, color: Gosu::Color::GREEN
+    @lighting << light
+
+    @light_mouse = @lighting.create_light mouse_x, mouse_y, 0, height / 2, color: Gosu::Color::GRAY
+  end
+
+  # Creates a new set of objects that cast shadows.
+  def place_shadow_casters
+    @shadow_casters = Array.new 12 do
+      { x: rand() * width, y: rand() * height, angle: rand() * 360 }
+    end
+  end
+
+  def update
+    $gosu_blocks.clear if defined? $gosu_blocks # workaround for Gosu 0.7.45 bug.
+
+    @camera_x -= 2 if button_down? Gosu::KbLeft
+    @camera_x += 2 if button_down? Gosu::KbRight
+    @camera_y -= 2 if button_down? Gosu::KbUp
+    @camera_y += 2 if button_down? Gosu::KbDown
+
+    @lighting.camera_x = @camera_x
+    @lighting.camera_y = @camera_y
+
+    @light_mouse.x, @light_mouse.y = mouse_x + @camera_x, mouse_y + @camera_y
+
+    @lighting.update_shadow_casters do
+      draw_shadow_casters
+    end
+  end
+
+  def draw_shadow_casters
+    @font.draw "Hello world! Time to get a grip, eh?", 0, 150, 0, 1, 1, Gosu::Color::RED
+    @shadow_casters.each do |star|
+      @star.draw_rot star[:x], star[:y], 0, star[:angle], 0.5, 0.5, 0.125, 0.125
+    end
+  end
+
+  def needs_cursor?
+    true
+  end
+
+  def button_down(id)
+    case id
+      when Gosu::KbEscape
+        close
+
+      when Gosu::KbSpace
+        place_shadow_casters
+
+      when Gosu::MsLeft
+        color = Gosu::Color.rgba rand(255), rand(255), rand(255), 127 + rand(128)
+        @lighting.create_light mouse_x + @camera_x, mouse_y + @camera_y, 0, height / 16 + rand(height / 2), color: color
+
+      when Gosu::KbD
+        @debug = !@debug
+
+      when Gosu::KbS
+        @lighting.each {|light| light.send :save_buffers }
+    end
+  end
+
+  def draw
+    translate -@camera_x, -@camera_y do
+      @background.draw 0, 0, 0, width.fdiv(@background.width), height.fdiv(@background.height)
+
+      # ... would draw player and other objects here ...
+
+      @lighting.draw
+
+      draw_shadow_casters # These should be drawn above or below the lighting, depending on preference.
+
+      # Draw the light itself - this isn't managed by the manager.
+      @lighting.each do |light|
+        pixel.draw_rot light.x, light.y, 0, 0, 0.5, 0.5, 15, 15, light.color, :add
+        light.draw_debug if @debug
+      end
+    end
+
+    # Drawing after the effect isn't processed, which is useful for GUI elements.
+    @font.draw "FPS: #{Gosu::fps} (for #{@lighting.size} lights)", 0, 0, 0
+  end
+end
+
+TestWindow.new.show