danabr75-ashton 0.1.5

data/lib/ashton/texture.rb

@@ -0,0 +1,186 @@
+module Ashton
+  class Texture
+    include Mixins::VersionChecking
+
+    DEFAULT_DRAW_COLOR = Gosu::Color::WHITE
+    VALID_DRAW_MODES = [:alpha_blend, :add, :multiply, :replace]
+
+    class << self
+      # [Boolean] Whether or not to pixelate (rather than smooth) on #draw
+      attr_writer :pixelated
+      # [Boolean] Whether or not to pixelate (rather than smooth) on #draw. Set true when Gosu::enable_undocumented_retrofication called.
+      def pixelated?; @pixelated end
+    end
+    self.pixelated = false
+
+    # [Boolean] Is this texture being rendered to currently?
+    def rendering?; @rendering end
+
+    # @overload initialize(image)
+    #   Create a texture from a Gosu::Image
+    #
+    #   @see Image#to_texture
+    #   @param image [Gosu::Image]
+    #
+    # @overload initialize(blob, width, height)
+    #   Create a texture from a binary blob.
+    #
+    #   @param blob [String]
+    #   @param width [Integer]
+    #   @param height [Integer]
+    #
+    # @overload initialize(width, height)
+    #   Create a blank (transparent) texture.
+    #
+    #   @param width [Integer]
+    #   @param height [Integer]
+    def initialize(*args)
+      case args.size
+        when 1
+          # Create from Gosu::Image
+          image = args[0]
+          raise TypeError, "Expected Gosu::Image" unless image.is_a? Gosu::Image
+          initialize_ image.width, image.height, nil
+
+          render do
+            # TODO: Ideally we'd draw the image in replacement mode, but Gosu doesn't support that.
+            $window.gl do
+              info = image.gl_tex_info
+              Gl.glEnable Gl::GL_TEXTURE_2D
+              Gl.glBindTexture Gl::GL_TEXTURE_2D, info.tex_name
+              Gl.glEnable Gl::GL_BLEND
+              Gl.glBlendFunc Gl::GL_ONE, Gl::GL_ZERO
+
+              Gl.glBegin Gl::GL_QUADS do
+                Gl.glTexCoord2d info.left, info.top
+                Gl.glVertex2d 0, height # BL
+
+                Gl.glTexCoord2d info.left, info.bottom
+                Gl.glVertex2d 0, 0 # TL
+
+                Gl.glTexCoord2d info.right, info.bottom
+                Gl.glVertex2d width, 0 # TR
+
+                Gl.glTexCoord2d info.right, info.top
+                Gl.glVertex2d width, height # BR
+              end
+            end
+          end
+
+        when 2
+          # Create blank image.
+          width, height = *args
+          initialize_ width, height, nil
+          clear
+
+        when 3
+          # Create from blob - create a Gosu image first.
+          blob, width, height = *args
+          raise ArgumentError, "Blob data is not of expected size" if blob.length != width * height * 4
+          initialize_ width, height, blob
+
+        else
+          raise ArgumentError, "Expected 1, 2 or 3 parameters."
+      end
+
+      @rendering = false
+    end
+
+    public
+    # Clears the buffer, optionally to a specific color.
+    #
+    # @option options :color [Gosu::Color, Array<Float>] (transparent)
+    def clear(options = {})
+      options = {
+          color: [0.0, 0.0, 0.0, 0.0],
+      }.merge! options
+
+      color = options[:color]
+      color = color.to_opengl if color.is_a? Gosu::Color
+
+      Gl.glBindFramebufferEXT Gl::GL_FRAMEBUFFER_EXT, fbo_id unless rendering?
+
+      Gl.glDisable Gl::GL_BLEND # Need to replace the alpha too.
+      Gl.glClearColor(*color)
+      Gl.glClear Gl::GL_COLOR_BUFFER_BIT | Gl::GL_DEPTH_BUFFER_BIT
+      Gl.glEnable Gl::GL_BLEND
+
+      Gl.glBindFramebufferEXT Gl::GL_FRAMEBUFFER_EXT, 0 unless rendering?
+
+      nil
+    end
+
+    public
+    # Enable the texture to use (e.g. to draw or convert it).
+    def render
+      raise ArgumentError, "Block required" unless block_given?
+      raise Error, "Can't nest rendering" if rendering?
+
+      $window.flush # Ensure that any drawing _before_ the render block is drawn to screen, rather than into the buffer.
+
+      render_
+
+      @rendering = true
+
+      # Project onto the texture itself, using Gosu (inverted) coordinates.
+      Gl.glPushMatrix
+      Gl.glMatrixMode Gl::GL_PROJECTION
+      Gl.glLoadIdentity
+      Gl.glViewport 0, 0, width, height
+      Gl.glOrtho 0, width, height, 0, -1, 1
+
+      begin
+        yield self
+      ensure
+        $window.flush # Force all the drawing to draw now!
+        Gl.glBindFramebufferEXT Gl::GL_FRAMEBUFFER_EXT, 0
+
+        @rendering = false
+
+        Gl.glPopMatrix
+
+        cache.refresh # Force lazy reloading of the cache.
+      end
+
+      self
+    end
+
+    # @!method draw(x, y, z, options = {})
+    #   Draw the Texture.
+    #
+    #   This is not as versatile as converting the Texture into a Gosu::Image and then
+    #   drawing it, but it is many times faster, so use it when you are updating the buffer
+    #   every frame, rather than just composing an image.
+    #
+    #   Drawing in Gosu orientation will be flipped in standard OpenGL and visa versa.
+    #
+    #   @param x [Number] Top left corner x.
+    #   @param y [Number] Top left corner y.
+    #   @param z [Number] Z-order (can be nil to draw immediately)
+    #
+    #   @option options :shader [Ashton::Shader] Shader to apply to drawing.
+    #   @option options :color [Gosu::Color] (Gosu::Color::WHITE) Color to apply to the drawing.
+    #   @option options :mode [Symbol] (:alpha_blend) :alpha_blend, :add, :multiply, :replace
+    #   @option options :multitexture [Texture] A texture to be used in a multi-texturing shader.
+    #   @option options :pixelated [Boolean] (true if Gosu::enable_undocumented_retrofication ever called) Pixelate, rather than smooth, when zoomed out.
+
+    public
+    # Convert the current contents of the buffer into a Gosu::Image
+    #
+    # @option options :caching [Boolean] (true) TexPlay behaviour.
+    # @option options :tileable [Boolean] (false) Standard Gosu behaviour.
+    # @option options :rect [Array<Integer>] ([0, 0, width, height]) Rectangular area of buffer to use to create the image [x, y, w, h]
+    def to_image(*args)
+      cache.to_image(*args)
+    end
+
+    def dup
+      # Create a new texture and draw self into it.
+      new_texture = Texture.new width, height
+      new_texture.render do
+        draw 0, 0, 0, mode: :replace
+      end
+      new_texture
+    end
+  end
+end

data/lib/ashton/version.rb

@@ -0,0 +1,3 @@
+module Ashton
+  VERSION = "0.1.5"
+end

data/lib/ashton/window_buffer.rb

@@ -0,0 +1,16 @@
+module Ashton
+  # A texture that is the same size as the Gosu::Window.
+  class WindowBuffer < Texture
+    def initialize
+      super $window.width, $window.height
+    end
+
+    public
+    # Copy the window contents into the buffer.
+    def capture
+      Gl.glBindTexture Gl::GL_TEXTURE_2D, id
+      Gl.glCopyTexImage2D Gl::GL_TEXTURE_2D, 0, Gl::GL_RGBA8, 0, 0, width, height, 0
+      self
+    end
+  end
+end

data/spec/ashton/ashton_spec.rb

@@ -0,0 +1,22 @@
+
+require_relative "../helper.rb"
+
+describe Ashton do
+  let(:accuracy) { 0.000001 }
+
+  describe "fast_sin" do
+    it "should give the same result as Math.sin" do
+      (-360..360).step 90 do |angle|
+        Ashton.fast_sin(angle).should be_within(accuracy).of Math.sin(angle.gosu_to_radians)
+      end
+    end
+  end
+
+  describe "fast_cos" do
+    it "should give the same result as Math.cos" do
+      (-360..360).step 90 do |angle|
+        Ashton.fast_cos(angle).should be_within(accuracy).of Math.cos(angle.gosu_to_radians)
+      end
+    end
+  end
+end

data/spec/ashton/gosu_ext/color_spec.rb

@@ -0,0 +1,34 @@
+require_relative "../../helper.rb"
+
+describe Gosu::Color do
+  let :conversions do
+    [
+        [Gosu::Color::RED,                  [1.0, 0.0, 0.0, 1.0]],
+        [Gosu::Color::GREEN,                [0.0, 1.0, 0.0, 1.0]],
+        [Gosu::Color::BLUE,                 [0.0, 0.0, 1.0, 1.0]],
+        [Gosu::Color.rgba(25, 50, 75, 125), [0.09803921568627451, 0.19607843137254902, 0.29411764705882354, 0.49019607843137253]],
+    ]
+  end
+
+  describe "to_opengl" do
+    it "should convert from Color to float array" do
+      conversions.each do |gosu, opengl|
+        gosu.to_opengl.should eq opengl
+      end
+    end
+  end
+
+  describe ".from_opengl" do
+    it "should create the expected Colors from a float array" do
+      conversions.each do |gosu, opengl|
+        Gosu::Color.from_opengl(opengl).should eq gosu
+      end
+    end
+  end
+
+  describe "to_i" do
+    it "should convert to an ARGB8 value" do
+      Gosu::Color.new(0x01234567).to_i.should eq 0x01234567
+    end
+  end
+end

data/spec/ashton/gosu_ext/font_spec.rb

@@ -0,0 +1,57 @@
+require_relative "../../helper.rb"
+
+describe Gosu::Font do
+  before :each do
+    $window = Gosu::Window.new 16, 16, false
+  end
+  let(:subject) { described_class.new $window, Gosu::default_font_name, 20 }
+  let(:shader) { Ashton::Shader.new }
+
+  describe "draw" do
+    it "should pass parameters through normally, without a hash" do
+      mock(subject).draw_without_hash "bleh", 1, 2, 3, 4, 5, 6, 7
+
+      subject.draw "bleh", 1, 2, 3, 4, 5, 6, 7
+    end
+
+    it "should pass parameters through normally, without :shader in the hash" do
+      mock(subject).draw_without_hash "bleh", 1, 2, 3, 4, 5, 6, 7
+
+      subject.draw "bleh", 1, 2, 3, 4, 5, 6, 7, shader: shader
+    end
+
+    it "should use the shader if supplied" do
+      mock(shader) do |m|
+        m.enable 3
+        m.disable 3
+      end
+      mock(subject).draw_without_hash "bleh", 1, 2, 3, 4, 5, 6, 7
+
+      subject.draw "bleh", 1, 2, 3, 4, 5, 6, 7, shader: shader
+    end
+  end
+
+  describe "draw_rel" do
+    it "should pass parameters through normally, without a hash" do
+      mock(subject).draw_rel_without_hash "bleh", 1, 2, 3, 4, 5, 6, 7, 8, 9
+
+      subject.draw_rel "bleh", 1, 2, 3, 4, 5, 6, 7, 8, 9
+    end
+
+    it "should pass parameters through normally, without :shader in the hash" do
+      mock(subject).draw_rel_without_hash "bleh", 1, 2, 3, 4, 5, 6, 7, 8, 9
+
+      subject.draw_rel "bleh", 1, 2, 3, 4, 5, 6, 7, 8, 9, shader: shader
+    end
+
+    it "should use the shader if supplied" do
+      mock(shader) do |m|
+        m.enable 3
+        m.disable 3
+      end
+      mock(subject).draw_rel_without_hash "bleh", 1, 2, 3, 4, 5, 6, 7, 8, 9
+
+      subject.draw_rel "bleh", 1, 2, 3, 4, 5, 6, 7, 8, 9, shader: shader
+    end
+  end
+end

data/spec/ashton/gosu_ext/gosu_spec.rb

@@ -0,0 +1,11 @@
+require_relative "../../helper.rb"
+
+describe Gosu do
+  describe "enable_undocumented_retrofication" do
+    it "should set Texture.pixelated? true" do
+      Ashton::Texture.should_not be_pixelated
+      Gosu.enable_undocumented_retrofication
+      Ashton::Texture.should be_pixelated
+    end
+  end
+end

data/spec/ashton/gosu_ext/image_spec.rb

@@ -0,0 +1,66 @@
+require_relative "../../helper.rb"
+
+describe Gosu::Image do
+  before :each do
+    $window = Gosu::Window.new 16, 16, false
+  end
+
+  let(:subject) { described_class.new $window, media_path("LargeStar.png") }
+
+  describe "draw" do
+    it "should pass parameters through normally, without a hash" do
+      mock(subject).draw_without_hash 0, 1, 2, 3, 4, 5
+
+      subject.draw 0, 1, 2, 3, 4, 5
+    end
+
+    it "should pass parameters through normally, without :shader in the hash" do
+      mock(subject).draw_without_hash 0, 1, 2, 3, 4, 5
+
+      subject.draw 0, 1, 2, 3, 4, 5, {}
+    end
+
+    it "should use the shader if supplied" do
+      mock(shader = Ashton::Shader.new) do |m|
+        m.enable 2
+        m.image = subject
+        m.disable 2
+      end
+      mock(subject).draw_without_hash 0, 1, 2, 3, 4, 5
+
+      subject.draw 0, 1, 2, 3, 4, 5, :shader => shader
+    end
+  end
+
+  describe "draw_rot" do
+    it "should pass parameters through normally, without a hash" do
+      mock(subject).draw_rot_without_hash 0, 1, 2, 3, 4, 5, 6, 7, 8
+
+      subject.draw_rot 0, 1, 2, 3, 4, 5, 6, 7, 8
+    end
+
+    it "should pass parameters through normally, without :shader in the hash" do
+      mock(subject).draw_rot_without_hash 0, 1, 2, 3, 4, 5, 6, 7, 8
+
+      subject.draw_rot 0, 1, 2, 3, 4, 5, 6, 7, 8, {}
+    end
+
+    it "should use the shader if supplied" do
+      mock(shader = Ashton::Shader.new) do |m|
+        m.enable 2
+        m.image = subject
+        m.disable 2
+      end
+      mock(subject).draw_rot_without_hash 0, 1, 2, 3, 4, 5, 6, 7, 8
+
+      subject.draw_rot 0, 1, 2, 3, 4, 5, 6, 7, 8, :shader => shader
+    end
+  end
+
+  describe "to_texture" do
+    it "should create a texture identical to the image" do
+      texture = subject.to_texture
+      texture.to_blob.should eq subject.to_blob
+    end
+  end
+end

data/spec/ashton/gosu_ext/window_spec.rb

@@ -0,0 +1,71 @@
+require_relative "../../helper.rb"
+
+describe Gosu::Window do
+  before :all do
+    $window ||= Gosu::Window.new 16, 16, false
+  end
+
+  # Class methods.
+
+  describe "Window.pixel" do
+    it "should be a 1x1 image" do
+      described_class.pixel.should be_kind_of Gosu::Image
+      described_class.pixel.width.should eq 1
+      described_class.pixel.height.should eq 1
+    end
+
+    it "should be white" do
+      described_class.pixel[0, 0].should eq [1.0, 1.0, 1.0, 1.0]
+    end
+  end
+
+  describe "Window.primary_buffer" do
+    it "should be a window sized buffer" do
+      described_class.primary_buffer.should be_kind_of Ashton::WindowBuffer
+    end
+  end
+
+  describe "Window.secondary_buffer" do
+    it "should be a window sized buffer" do
+      described_class.secondary_buffer.should be_kind_of Ashton::WindowBuffer
+    end
+
+    it "should not be the same as the primary buffer" do
+      described_class.secondary_buffer.should_not eq described_class.primary_buffer
+    end
+  end
+
+  # Instance methods
+
+  describe "post_process" do
+    pending
+  end
+
+  describe "pixel" do
+    it "should be a 1x1 image" do
+      $window.pixel.should be_kind_of Gosu::Image
+      $window.pixel.width.should eq 1
+      $window.pixel.height.should eq 1
+    end
+
+    it "should be white" do
+      $window.pixel[0, 0].should eq [1.0, 1.0, 1.0, 1.0]
+    end
+  end
+
+  describe "primary_buffer" do
+    it "should be a window sized buffer" do
+      $window.primary_buffer.should be_kind_of Ashton::WindowBuffer
+    end
+  end
+
+  describe "secondary_buffer" do
+    it "should be a window sized buffer" do
+      $window.secondary_buffer.should be_kind_of Ashton::WindowBuffer
+    end
+
+    it "should not be the same as the primary buffer" do
+      $window.secondary_buffer.should_not eq $window.primary_buffer
+    end
+  end
+end