tung-tea 0.2.4 → 0.3.0

data/README.rdoc

@@ -68,7 +68,7 @@ Below is a simple bouncing circle demo.
 What's working:
 
 * Events/Input - done
-* Graphics - nearly done, still need sub-bitmap grabbing
+* Graphics - done
 
 What isn't done yet:
 

data/doc/example/grab.rb

@@ -0,0 +1,28 @@
+# Test that grabbing from bitmaps works.
+# Expected results are a smiley on the screen, but with its quarters swapped.
+
+require 'tea'
+
+puts <<TEST
+You should see a smiley in the centre of the screen for 5 seconds, but with its
+quarters swapped.
+TEST
+
+Tea.init
+Tea::Screen.set_mode 320, 240
+
+smiley = Tea::Bitmap.new("smile.png")
+sw2 = smiley.w / 2
+sh2 = smiley.h / 2
+top_left     = smiley.grab(  0,   0, sw2, sh2)
+top_right    = smiley.grab(sw2,   0, sw2, sh2)
+bottom_left  = smiley.grab(  0, sh2, sw2, sh2)
+bottom_right = smiley.grab(sw2, sh2, sw2, sh2)
+
+Tea::Screen.blit bottom_right, Tea::Screen.w / 2 - sw2, Tea::Screen.h / 2 - sh2
+Tea::Screen.blit bottom_left,        Tea::Screen.w / 2, Tea::Screen.h / 2 - sh2
+Tea::Screen.blit top_right,    Tea::Screen.w / 2 - sw2,       Tea::Screen.h / 2
+Tea::Screen.blit top_left,           Tea::Screen.w / 2,       Tea::Screen.h / 2
+Tea::Screen.update
+
+sleep 5

data/doc/example/rect_alpha.rb

@@ -29,6 +29,12 @@ x, y = 205, 15
 up, down, left, right = false, false, false, false
 wait_for_event = true
 
+b = Tea::Bitmap.new(180, 130, 0x00000000)
+b.rect 45, 32, 90, 65, 0xff0000ff
+b.rect  0,  0, 90, 65, 0x00ff0080, :mix => :blend
+b.rect 90, 65, 90, 65, 0x0000ff80, :mix => :replace
+b.rect  0, 65, 90, 65, 0xffffff80
+
 begin
   Tea::Screen.clear
 
@@ -37,11 +43,6 @@ begin
   Tea::Screen.rect 200, 150, 200, 150, 0x0000ff80, :mix => :replace
   Tea::Screen.rect   0, 150, 200, 150, 0xffffff80
 
-  b = Tea::Bitmap.new(180, 130, 0x00000000)
-  b.rect 45, 32, 90, 65, 0xff0000ff
-  b.rect  0,  0, 90, 65, 0x00ff0080, :mix => :blend
-  b.rect 90, 65, 90, 65, 0x0000ff80, :mix => :replace
-  b.rect  0, 65, 90, 65, 0xffffff80
   Tea::Screen.blit b, x, y
 
   Tea::Screen.update
@@ -63,8 +64,8 @@ begin
     end
   end
   wait_for_event = !(up || down || left || right)
-  x -= 8 if left
-  x += 8 if right
-  y -= 8 if up
-  y += 8 if down
+  x -= 1 if left
+  x += 1 if right
+  y -= 1 if up
+  y += 1 if down
 end until e.class == Tea::App::Exit || (e.class == Tea::Kbd::Down && e.key == Tea::Kbd::ESCAPE)

data/doc/reference.textile

@@ -32,6 +32,16 @@ Tea::Clipping:
 
 These clip methods get, set and run a block with a clipping rectangle respectively.  While a clipping rectangle is set, drawing will be clipped inside it.
 
+Tea::Grabbing:
+* grab([x, y, w, h])
+
+This grab method copies a sub-section of the Bitmap (or all of it if no arguments are given) and returns it as a new Bitmap object.
+
+Tea::ImageSaving:
+* save(path)
+
+The save method saves the Bitmap as an image file.
+
 Tea::Primitive:
 * clear()
 * point(x, y, color)
@@ -76,6 +86,16 @@ Tea::Clipping:
 
 These clip methods get, set and run a block with a clipping rectangle respectively.  While a clipping rectangle is set, drawing will be clipped inside it.
 
+Tea::Grabbing:
+* grab([x, y, w, h])
+
+This grab method copies a sub-section of the screen (or all of it if no arguments are given) and returns it as a new Bitmap object.
+
+Tea::ImageSaving:
+* save(path)
+
+The save method saves the Screen as an image file.
+
 Tea::Primitive:
 * clear()
 * point(x, y, color)

data/lib/tea/c_bitmap.rb

@@ -5,6 +5,8 @@ require 'sdl'
 
 require 'tea/mix_blitting'
 require 'tea/mix_clipping'
+require 'tea/mix_grabbing'
+require 'tea/mix_image_saving'
 require 'tea/mix_primitive'
 
 #
@@ -39,17 +41,27 @@ module Tea
       @buffer.h
     end
 
-    include Tea::Blitting
+    include Blitting
     def blitting_buffer
       @buffer
     end
 
-    include Tea::Clipping
+    include Clipping
     def clipping_buffer
       @buffer
     end
 
-    include Tea::Primitive
+    include Grabbing
+    def grabbing_buffer
+      @buffer
+    end
+
+    include ImageSaving
+    def image_saving_buffer
+      @buffer
+    end
+
+    include Primitive
     def primitive_buffer
       @buffer
     end

data/lib/tea/mix_grabbing.rb

@@ -0,0 +1,86 @@
+# This file contains the Grabbing mixin, which makes a new Bitmap object based
+# on some part of a bitmap-like pixel buffer.
+
+require 'sdl'
+
+require 'tea/c_bitmap'
+
+#
+module Tea
+
+  # This module gives bitmap-like objects a +grab+ method that takes a
+  # 'snapshot' of some part of it and returns it as a new Bitmap.
+  #
+  # To use this mixin, include it and define a +grabbing_buffer+ method:
+  #
+  #   include Grabbing
+  #   def grabbing_buffer
+  #     @my_sdl_buffer
+  #   end
+  #
+  module Grabbing
+
+    # Grab some part of the bitmap-like object, and return it as a new
+    # Tea::Bitmap object.
+    #
+    # This can be called in two ways:
+    #
+    # * ()::            create a deep-copy of the whole bitmap-like object.
+    # * (x, y, w, h)::  copy the pixels within the box at (x, y) of size w * h.
+    #
+    # May raise Tea::Error if the box given (if any) is outside the bitmap.
+    def grab(*box)
+      buffer = grabbing_buffer
+
+      case box.length
+      when 0
+        x = 0
+        y = 0
+        w = buffer.w
+        h = buffer.h
+      when 4
+        if clipped_box = grabbing_clip(*box, 0, 0, buffer.w, buffer.h)
+          x, y, w, h = clipped_box
+        else
+          raise Tea::Error, "cannot grab (#{x}, #{y}, #{w}, #{h}), not within (#{buffer.x}, #{buffer.y}, #{buffer.w}, #{buffer.h})", caller
+        end
+      else
+        raise ArgumentError, "wrong number of arguments (#{box.length} for 0 or 4)", caller
+      end
+
+      bitmap = Bitmap.new(w, h, 0x00000000)
+
+      for buf_y in y..(y + h)
+        for buf_x in x..(x + w)
+          red, green, blue, alpha = buffer.get_rgba(buffer[buf_x, buf_y])
+          bitmap.point buf_x - x, buf_y - y, ((red << 24) | (green << 16) | (blue << 8) | alpha)
+        end
+      end
+
+      bitmap
+    end
+
+    # Keep the rect (x, y, w, h) within the rect (bound_x, bound_y, bound_w, bound_h).
+    #
+    # Returns [in_x, in_y, in_w, in_h], defining a rect like (x, y, w, h), but
+    # within the bounding rect.  Returns nil if the rect given is not within
+    # the bounding rect at all, i.e. w or h would be less than 1.
+    def grabbing_clip(x, y, w, h, bound_x, bound_y, bound_w, bound_h)
+      return nil if x + w <= bound_x || x >= bound_x + bound_w || y + h <= bound_y || y >= bound_y + bound_h
+
+      in_x = (x >= bound_x) ? x : bound_x
+      in_y = (y >= bound_y) ? y : bound_y
+
+      x2 = x + w
+      y2 = y + h
+      in_x2 = (x2 <= bound_x + bound_w) ? x2 : bound_x + bound_w
+      in_y2 = (y2 <= bound_y + bound_h) ? y2 : bound_y + bound_h
+      in_w = in_x2 - in_x
+      in_h = in_y2 - in_y
+
+      [in_x, in_y, in_w, in_h]
+    end
+
+  end
+
+end

data/lib/tea/mix_image_saving.rb

@@ -0,0 +1,50 @@
+# This file holds the ImageSaving mixin.
+
+require 'sdl'
+
+require 'tea/c_error'
+
+#
+module Tea
+
+  # This mixin allows SDL surface-backed classes to be saved as image files.
+  #
+  # To use, include the mixin and implement an image_saving_buffer method:
+  #
+  #   include ImageSaving
+  #   def image_saving_buffer
+  #     @my_sdl_buffer
+  #   end
+  module ImageSaving
+
+    # Save the object as an image file at the given path.
+    #
+    # The format is determined by the extension at the end of the path.  ".bmp"
+    # will save it as Windows Bitmap image.
+    #
+    # May raise Tea::Error if the desired image file format can't be
+    # determined, or isn't supported.
+    def save(path)
+      extension_match = /\..+$/.match(path)
+
+      if extension_match
+        ext = extension_match[0]
+        case ext
+        when '.bmp'
+          image_saving_buffer.save_bmp(path)
+        when '.png'
+          raise Tea::Error, "PNG format not supported for saving yet", caller
+        else
+          raise Tea::Error, "can't determine image format '#{ext}' for saving", caller
+        end
+      else
+        raise Tea::Error, "can't determine desired image file format for #{path}", caller
+      end
+
+    rescue SDL::Error => e
+      raise Tea::Error, e.message, e.backtrace
+    end
+
+  end
+
+end

data/lib/tea/mix_primitive.rb

@@ -68,16 +68,21 @@ module Tea
         raise Tea::Error, "can't draw rectangle of size #{w}x#{h}", caller
       end
 
-      if options == nil || options[:mix] == nil
-        mix = :blend
-      else
-        unless [:blend, :replace].include?(options[:mix])
-          raise Tea::Error, "invalid mix option \"#{options[:mix]}\"", caller
+      r, g, b, a = primitive_hex_to_rgba(color)
+
+      if a < 0xff
+        if options == nil || options[:mix] == nil
+          mix = :blend
+        else
+          unless [:blend, :replace].include?(options[:mix])
+            raise Tea::Error, "invalid mix option \"#{options[:mix]}\"", caller
+          end
+          mix = options[:mix]
         end
-        mix = options[:mix]
+      else
+        mix = :replace
       end
 
-      r, g, b, a = primitive_hex_to_rgba(color)
       case mix
       when :blend
         if a == 0xff
@@ -107,19 +112,20 @@ module Tea
     #                   +:replace+ writes over the RGBA parts of the line
     #                   destination pixels.
     def line(x1, y1, x2, y2, color, options=nil)
+      r, g, b, a = primitive_hex_to_rgba(color)
+
       if options == nil
         antialias = false
-        mix = :blend
+        mix = (a < 0xff) ? :blend : :replace
       else
         antialias = options[:antialias] || false
-        mix = options[:mix] || :blend
+        mix = options[:mix] || ((a < 0xff) ? :blend : :replace)
 
         unless [:blend, :replace].include?(mix)
           raise Tea::Error, "invalid mix option \"#{mix}\"", caller
         end
       end
 
-      r, g, b, a = primitive_hex_to_rgba(color)
       if primitive_buffer.class == SDL::Screen
         primitive_buffer.draw_line x1, y1, x2, y2, primitive_rgba_to_color(r, g, b, (mix == :replace ? a : 255)), antialias, (mix == :blend ? a : nil)
       else
@@ -149,14 +155,16 @@ module Tea
         raise Tea::Error, "can't draw circle with radius #{radius}", caller
       end
 
+      r, g, b, a = primitive_hex_to_rgba(color)
+
       if options == nil
         outline = false
         antialias = false
-        mix = :blend
+        mix = (a < 0xff) ? :blend : :replace
       else
         outline = options[:outline] || false
         antialias = options[:antialias] || false
-        mix = options[:mix] || :blend
+        mix = options[:mix] || ((a < 0xff) ? :blend : :replace)
 
         unless [:blend, :replace].include?(mix)
           raise Tea::Error, "invalid mix option \"#{mix}\"", caller
@@ -166,8 +174,7 @@ module Tea
       if primitive_buffer.class == SDL::Screen
         case mix
         when :blend
-          r, g, b, a = primitive_hex_to_rgba(color)
-          if !outline && antialias && a < 0xff
+          if !outline && antialias
             # rubysdl can't draw filled antialiased alpha circles for some reason.
             # Big endian because the SGE-powered circle antialiasing apparently
             # doesn't like it any other way.
@@ -188,7 +195,6 @@ module Tea
       else
         # SGE and alpha mixing don't... mix.  Gotta do it ourselves.
         mixer = (mix == :blend) ? BLEND_MIXER : REPLACE_MIXER
-        r, g, b, a = primitive_hex_to_rgba(color)
         primitive_circle x, y, radius, !outline, antialias, r, g, b, a, mixer
       end
     end

data/lib/tea/o_screen.rb

@@ -4,6 +4,8 @@ require 'sdl'
 
 require 'tea/mix_blitting'
 require 'tea/mix_clipping'
+require 'tea/mix_grabbing'
+require 'tea/mix_image_saving'
 require 'tea/mix_primitive'
 
 #
@@ -65,6 +67,16 @@ module Tea
       @screen
     end
 
+    extend Grabbing
+    def Screen.grabbing_buffer
+      @screen
+    end
+
+    extend ImageSaving
+    def Screen.image_saving_buffer
+      @screen
+    end
+
     extend Primitive
     def Screen.primitive_buffer
       @screen

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tung-tea
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors: 
 - Tung Nguyen
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-21 00:00:00 -07:00
+date: 2009-08-29 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,6 +45,7 @@ files:
 - doc/example/event_app.rb
 - doc/example/event_keyboard.rb
 - doc/example/event_mouse.rb
+- doc/example/grab.rb
 - doc/example/init.rb
 - doc/example/lines.rb
 - doc/example/lines_aa.rb
@@ -74,11 +75,12 @@ files:
 - lib/tea/m_event_mouse.rb
 - lib/tea/mix_blitting.rb
 - lib/tea/mix_clipping.rb
+- lib/tea/mix_grabbing.rb
+- lib/tea/mix_image_saving.rb
 - lib/tea/mix_primitive.rb
 - lib/tea/o_screen.rb
 has_rdoc: false
 homepage: http://github.com/tung/tea
-licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -99,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
 summary: A simple game development library for Ruby.