texplay 0.3.1 → 0.3.3pre2

data/lib/texplay.rb

@@ -4,7 +4,6 @@
 direc = File.expand_path(File.dirname(__FILE__))
 
 # include gosu first
-require 'rbconfig'
 require 'gosu'
 require "#{direc}/texplay/version"
 
@@ -14,13 +13,12 @@ module TexPlay
   class << self
     def on_setup(&block)
       raise "need a block" if !block
-      
       @__init_procs__ ||= []
       @__init_procs__.push(block)
     end
 
     def setup(receiver)
-      if @__init_procs__ then
+      if @__init_procs__ 
         @__init_procs__.each do |init_proc|
           receiver.instance_eval(&init_proc)
         end
@@ -36,7 +34,12 @@ module TexPlay
       raise ArgumentError, "Height and width must be positive" if height <= 0 or width <= 0
       
       img = Gosu::Image.new(window, EmptyImageStub.new(width, height), :caching => options[:caching])
-      img.rect 0, 0, img.width - 1, img.height - 1, :color => options[:color], :fill => true 
+
+      # this should be a major speedup (avoids both a cache and a sync
+      # if color is alpha (default)
+      if options[:color] != :alpha
+        img.rect 0, 0, img.width - 1, img.height - 1, :color => options[:color], :fill => true
+      end
 
       img
     end
@@ -46,7 +49,7 @@ module TexPlay
     # Image can be :tileable, but it will break if it is tileable AND gets modified after creation.
     def from_blob(window, blob_data, width, height, options={})
       options = {
-        :caching => @options[:caching],
+        :caching => false,
         :tileable => false,
       }.merge!(options)
 
@@ -71,7 +74,7 @@ module TexPlay
     # default values defined here
     def set_defaults
       @options = {
-        :caching => true
+        :caching => :lazy
       }
     end
 
@@ -121,6 +124,7 @@ module TexPlay
   #
   # This object duck-types an RMagick image (#rows, #columns, #to_blob), so that Gosu will import it.
   class ImageStub
+
     # @return [Integer]
     attr_reader :rows, :columns
 
@@ -153,14 +157,15 @@ module TexPlay
 end
 
 # bring in user-defined extensions to TexPlay
-dlext = Config::CONFIG['DLEXT']
 begin
   if RUBY_VERSION && RUBY_VERSION =~ /1.9/
-    require "#{direc}/1.9/texplay.#{dlext}"
+    require "#{direc}/1.9/texplay"
   else
-    require "#{direc}/1.8/texplay.#{dlext}"
+    require "#{direc}/1.8/texplay"
   end
 rescue LoadError => e
+  require 'rbconfig'
+  dlext = Config::CONFIG['DLEXT']
   require "#{direc}/texplay.#{dlext}"
 end
 
@@ -203,16 +208,33 @@ module Gosu
         options = {
           :caching => TexPlay.get_options[:caching]
         }.merge!(options)
-        
-        # refresh the TexPlay image cache
+
+        caching_mode = options[:caching]
+
+        # we can't manipulate large images, so skip them.
         if obj.width <= (TexPlay::TP_MAX_QUAD_SIZE) &&
-            obj.height <= (TexPlay::TP_MAX_QUAD_SIZE) && obj.quad_cached? then
-          obj.refresh_cache if options[:caching]
+            obj.height <= (TexPlay::TP_MAX_QUAD_SIZE)
+          
+          if caching_mode
+            if caching_mode == :lazy
+
+              # only cache if quad already cached (to refresh old data)
+              # otherwise cache lazily at point of first TexPlay call
+              obj.refresh_cache if obj.quad_cached?
+
+            else
+              
+              # force a cache - this obviates the need for a
+              # potentialy expensive runtime cache of the image by
+              # moving the cache to load-time
+              obj.refresh_cache
+            end
+          end
         end
         
         # run custom setup
         TexPlay.setup(obj)
-        
+
         obj.instance_variable_set(:@__window__, window)
 
         obj

data/lib/texplay/alone.rb

@@ -0,0 +1,20 @@
+direc = File.dirname(__FILE__)
+
+require "#{direc}/../texplay"
+
+module TexPlay
+  Win = Gosu::Window.new(0, 0, false)
+
+  set_options :sync_mode => :no_sync
+
+  class << self
+    def load(name)
+      Gosu::Image.new(Win, name)
+    end
+  
+    alias_method :original_create_image, :create_image
+    def create_image(width, height, options={})
+      original_create_image(Win, width, height, options)
+    end      
+  end
+end

data/lib/texplay/c_function_docs.rb

@@ -1,3 +1,4 @@
+# -*- coding: iso-8859-1 -*-
 # This code is never run; it is just here so we can document the C functions.
 
 
@@ -44,7 +45,7 @@ module TexPlay
   def each(&block)
   end
 
-  # Fill at a given position.
+  # Perform a Flood Fill at a given position.
   #
   # @param [Number] x
   # @param [Number] y
@@ -186,4 +187,4 @@ module TexPlay
   # @return [String] Raw binary data (blob) in RGBA byte order.
   def to_blob
   end
-end
+end

data/lib/texplay/version.rb

@@ -1,3 +1,3 @@
 module TexPlay
-  VERSION = "0.3.1"
+  VERSION = "0.3.3pre2"
 end

data/live/live.rb

@@ -0,0 +1,85 @@
+direc = File.dirname(__FILE__)
+
+require 'rubygems'
+require "#{direc}/../lib/texplay"
+require 'pry'
+
+WIDTH = 640
+HEIGHT = 480
+
+class Gosu::Image
+  attr_accessor :x, :y
+
+  alias_method :orig_init, :initialize
+  def initialize(*args)
+    @x = WIDTH / 2
+    @y = HEIGHT / 2
+    orig_init(*args)
+  end
+end
+
+class WinClass < Gosu::Window
+
+  class View
+    attr_accessor :zoom, :rotate
+
+    def initialize
+      @zoom = 1
+      @rotate = 0
+    end
+
+    def reset
+      @zoom = 1
+      @rotate = 0
+    end
+  end
+  
+  attr_reader :images, :view
+  
+  def initialize
+    super(WIDTH, HEIGHT, false)
+    Gosu.enable_undocumented_retrofication
+
+    @images = []
+    @view = View.new
+    @pry_instance = Pry.new :prompt => [Proc.new { "(live)> " }, Proc.new { "(live)* " }]
+    
+    @img = TexPlay.create_image(self, 200, 200)
+    @img.rect 0, 0, @img.width - 1, @img.height - 1
+    
+    images << @img
+    @binding = binding
+  end
+
+  def create_image(width, height, options={})
+    TexPlay.create_image(self, width, height, options)
+  end
+
+  def load_image(file)
+    Gosu::Image.new(self, file)
+  end
+
+  def show_image(image)
+    images << image
+  end
+
+  def hide_image(image)
+    images.delete(image)
+  end
+  
+  def draw
+    images.uniq!
+    images.each do |v|
+      v.draw_rot(v.x, v.y, 1, view.rotate, 0.5, 0.5, view.zoom, view.zoom)
+    end
+  end
+
+  def update
+    @pry_instance.rep(@binding)
+  end
+end
+
+w = WinClass.new
+
+w.show
+

data/test/image_spec.rb

@@ -0,0 +1,45 @@
+direc = File.dirname(__FILE__)
+
+require "#{direc}/../lib/texplay"
+
+class Module
+  public :remove_const
+end
+
+describe Gosu::Image do
+  before do
+    @window = Gosu::Window.new(640, 480, false)
+    NormalImageSize = [Gosu::MAX_TEXTURE_SIZE - 2, Gosu::MAX_TEXTURE_SIZE - 2]
+    TooLargeImageSize = [2000, 2000]
+  end
+
+  after do
+    Object.remove_const(:NormalImageSize)
+    Object.remove_const(:TooLargeImageSize)
+  end
+  
+  describe "Gosu::Image#new (patched by TexPlay)" do
+    describe "caching option" do
+      it "should not cache image if :caching => false" do
+        source_image = TexPlay.create_image(@window, *NormalImageSize)
+        source_image.quad_cached?.should == false
+
+        image = Gosu::Image.new(@window, source_image, :caching => false)
+        image.width.should == NormalImageSize[0]
+        image.height.should == NormalImageSize[1]
+
+        image.quad_cached?.should == false
+      end
+
+      it "should cache the image if :caching => true" do
+        source_image = TexPlay.create_image(@window, *NormalImageSize)
+
+        image = Gosu::Image.new(@window, source_image, :caching => true)
+        image.width.should == NormalImageSize[0]
+        image.height.should == NormalImageSize[1]
+
+        image.quad_cached?.should == true
+      end
+    end
+  end
+end

data/test/texplay_spec.rb

@@ -0,0 +1,141 @@
+$LOAD_PATH.unshift File.join(File.expand_path(__FILE__), '..', 'lib','texplay')
+direc = File.dirname(__FILE__)
+
+require "#{direc}/../lib/texplay"
+
+describe TexPlay do
+  described_class = TexPlay
+  
+  before do
+    @window = Gosu::Window.new(640, 480, false)
+  end
+
+  describe "#create_image" do
+    it "should create a blank image of the correct size" do
+      width, height = 30, 10
+      image = described_class.create_image(@window, width, height)
+
+      image.width.should == width
+      image.height.should == height
+
+      width.times do |x|
+        height.times do |y|
+          image.get_pixel(x, y).should == [0.0, 0.0, 0.0, 0.0]
+        end
+      end
+    end
+
+    it "should create a coloured image of the correct size" do
+      width, height = 10, 30
+      color = [1.0, 1.0, 0.0, 1.0]
+      image = described_class.create_image(@window, width, height, :color => color)
+
+      image.width.should == width
+      image.height.should == height
+
+      width.times do |x|
+        height.times do |y|
+          image.get_pixel(x, y).should == color
+        end
+      end
+    end
+
+    it "should raise an error if an image dimension is 0 or less" do
+      lambda { described_class.create_image(@window, 0, 0)}.should.raise ArgumentError
+    end
+
+    # TODO: Should probably be an ArgumentError.
+    it "should NOT raise an error if the image would be too large (as uses raw blobs, doesnt use TexPlay at all)" do
+      too_big = TexPlay::TP_MAX_QUAD_SIZE + 1
+      [[too_big, 5], [10, too_big], [too_big, too_big]].each do |width, height|
+        lambda { described_class.create_image(@window, width, height)}.should.not.raise Exception
+      end
+    end
+  end
+
+  describe "#clear" do
+    it "should clear an image to the correct color" do
+      img = described_class.create_image(@window, 10, 10)
+      img.clear :color => :red
+      (0...img.width).each do |x|
+        (0...img.height).each do |y|
+          img.get_pixel(x,y).should == [1,0,0,1]
+        end
+      end
+    end
+  end
+
+  describe "#from_blob" do
+    # it "should create an image with the requested pixel data and size" do
+    #   # 4 x 3, with columns of red, blue, green, transparent.
+    #   gosu_colors = [[255, 0, 0, 255], [0, 255, 0, 255], [0, 0, 255, 255], [0, 0, 0, 0]]
+    #   texplay_colors = gosu_colors.map {|a| a.map {|c| c / 255.0 } }
+    #   width, height = gosu_colors.size, 3
+      
+    #   image = described_class.from_blob(@window, (gosu_colors * height).flatten.pack('C*'), width, height)
+
+    #   image.width.should == width
+    #   image.height.should == height
+
+    #   texplay_colors.each_with_index do |color, x|
+    #     3.times do |y|
+    #       image.get_pixel(x, y).should == color
+    #     end
+    #   end
+    # end
+
+    it "should raise an error if the image size is not correct for the blob data" do
+      lambda { described_class.from_blob(@window, [1, 1, 1, 1].pack("C*"), 2, 1) }.should.raise ArgumentError
+    end
+
+    it "should raise an error if an image dimension is 0 or less" do
+      lambda { described_class.from_blob(@window, '', 0, 0) }.should.raise ArgumentError
+    end
+  end
+
+  describe "alpha_blend" do
+    it "should alpha blend using source alpha and not fixing alpha" do
+      img1 = described_class.create_image(@window, 10, 10).clear :color => [1, 0, 0, 1]
+      img1.clear :color => [0, 0, 1, 0.5], :alpha_blend => :source
+      img1.get_pixel(5, 5).should == [0.5, 0, 0.5, 0.75]
+    end
+
+    it "hash params true and :source should be equivalent" do
+      img1 = described_class.create_image(@window, 10, 10).clear :color => [1, 0, 0, 1]
+      img2 = img1.dup
+      img1.clear :color => [0, 0, 1, 0.5], :alpha_blend => :source
+      img2.clear :color => [0, 0, 1, 0.5], :alpha_blend => true
+      
+      img1.get_pixel(5, 5).should == [0.5, 0, 0.5, 0.75]
+      img2.get_pixel(5, 5).should == [0.5, 0, 0.5, 0.75]
+    end
+
+    it "false or nil should prevent alpha blending" do
+      img1 = described_class.create_image(@window, 10, 10).clear :color => [1, 0, 0, 1]
+      img2 = img1.dup
+      img1.clear :color => [0, 0, 1, 0.5], :alpha_blend => false
+      img2.clear :color => [0, 0, 1, 0.5], :alpha_blend => nil
+      
+      img1.get_pixel(5, 5).should == [0, 0, 1, 0.5]
+      img2.get_pixel(5, 5).should == [0, 0, 1, 0.5]
+    end
+
+    it "should alpha blend using dest alpha and not fixing alpha" do
+      img1 = described_class.create_image(@window, 10, 10).clear :color => [1, 0, 0, 0.5]
+      img1.clear :color => [0, 0, 1, 1], :alpha_blend => :dest
+      img1.get_pixel(5, 5).should == [0.5, 0, 0.5, 0.75]
+    end
+
+    it "should alpha blend using source alpha and fixing alpha" do
+      img1 = described_class.create_image(@window, 10, 10).clear :color => [1, 0, 0, 1]
+      img1.clear :color => [0, 0, 1, 0.5], :alpha_blend => :source_with_fixed_alpha
+      img1.get_pixel(5, 5).should == [0.5, 0, 0.5, 1]
+    end
+
+    it "should alpha blend using dest alpha and fixing alpha" do
+      img1 = described_class.create_image(@window, 10, 10).clear :color => [1, 0, 0, 0.5]
+      img1.clear :color => [0, 0, 1, 1], :alpha_blend => :dest_with_fixed_alpha
+      img1.get_pixel(5, 5).should == [0.5, 0, 0.5, 0.5]
+    end
+  end
+end

metadata

@@ -1,13 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: texplay
 version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: false
+  hash: -223651707
+  prerelease: 5
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 3
+  - pre
+  - 2
+  version: 0.3.3pre2
 platform: ruby
 authors: 
 - John Mair (banisterfiend)
@@ -15,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-13 00:00:00 +13:00
+date: 2011-02-22 00:00:00 +13:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,6 +36,22 @@ dependencies:
         version: 0.7.25
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bacon
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :development
+  version_requirements: *id002
 description: TexPlay is a light-weight image manipulation framework for Ruby and Gosu
 email: jrmair@gmail.com
 executables: []
@@ -46,6 +64,7 @@ files:
 - Rakefile
 - README.markdown
 - CHANGELOG
+- lib/texplay/alone.rb
 - lib/texplay/c_function_docs.rb
 - lib/texplay/version.rb
 - lib/texplay-contrib.rb
@@ -122,9 +141,11 @@ files:
 - examples/media/sand1.png
 - examples/media/sunset.png
 - examples/media/texplay.png
-- spec/image_spec.rb
-- spec/texplay_spec.rb
-has_rdoc: yard
+- test/image_spec.rb
+- test/texplay_spec.rb
+- live/live.rb
+- .gemtest
+has_rdoc: true
 homepage: http://banisterfiend.wordpress.com/2008/08/23/texplay-an-image-manipulation-tool-for-ruby-and-gosu/
 licenses: []
 
@@ -145,16 +166,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 25
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: TexPlay is a light-weight image manipulation framework for Ruby and Gosu