rubygame 2.6.3 → 2.6.4

data/NEWS

@@ -1,5 +1,21 @@
 = NEWS
 
+== Rubygame 2.6.4
+
+Release focus: Bug fix.
+
+=== Fixes
+
+- Fixed: Rubygame's "require_path" setting in the gem spec was
+  interfering with ruby-opengl (and potentially others). [#43]
+
+  If you have problems loading ruby-opengl when Rubygame 2.6.* is
+  installed via RubyGems, you should uninstall all versions of the
+  Rubygame gem, then reinstall version 2.6.4 (or later).
+
+
+
+
 == Rubygame 2.6.3
 
 Release focus: Bug fixes.

data/doc/surface_palettes.rdoc

@@ -0,0 +1,8 @@
+= Using Surface Palettes in Rubygame
+
+This is a guide will explain the concept of Surface palettes, as well
+as the methods available to use them in Rubygame.
+
+== About Surface Palettes
+
+Surface palettes are a feature in SDL which 

data/lib/rubygame/color.rb

@@ -102,19 +102,9 @@ module Rubygame
     end
 
     def self.make_sdl_rgba( color ) # :nodoc:
-      @rgba_cache ||= {}
-      @rgba_cache[color] ||=
-        begin
-          r,g,b,a = convert_color(color).collect!{ |c| c.to_i }[0,4]
-          a ||= 255
-          [r,g,b,a].freeze
-        end
-    end
-
-
-    def self.remove_from_cache( color_name )
-      @rgba_cache ||= {}
-      @rgba_cache.delete( color_name )
+      r,g,b,a = convert_color(color).collect!{ |c| c.to_i }[0,4]
+      a = 255 if a.nil?
+      [r,g,b,a]
     end
 
 	end

data/lib/rubygame/color/models/hsl.rb

@@ -59,14 +59,6 @@ module Rubygame
 			end
 			alias :inspect :to_s
 			
-			def hash
-				@hash ||= ((@h.hash << 4) +
-				           (@s.hash << 3) +
-				           (@l.hash << 2) +
-				           (@a.hash << 1) +
-				           self.class.hash)
-			end
-
 			class << self
 
 				def new_from_rgba( rgba )

data/lib/rubygame/color/models/hsv.rb

@@ -59,14 +59,6 @@ module Rubygame
 			end
 			alias :inspect :to_s
 			
-			def hash
-				@hash ||= ((@h.hash << 4) +
-				           (@s.hash << 3) +
-				           (@v.hash << 2) +
-				           (@a.hash << 1) +
-				           self.class.hash)
-			end
-
 			class << self
 				
 				def new_from_rgba( rgba )

data/lib/rubygame/color/models/rgb.rb

@@ -63,14 +63,6 @@ module Rubygame
 			end
 			alias :inspect :to_s
 			
-			def hash
-				@hash ||= ((@r.hash << 4) +
-				           (@g.hash << 3) +
-				           (@b.hash << 2) +
-				           (@a.hash << 1) +
-				           self.class.hash)
-			end
-
 			class << self
 				def new_from_rgba( rgba )
 					new( rgba )

data/lib/rubygame/color/palettes/palette.rb

@@ -48,9 +48,6 @@ class Rubygame::Color::Palette
 	
 	# Store a color by name in this palette. See #sanitize_name
 	def []=( name, color )
-    # Uncache colors with this name, to avoid using obsolete value.
-    Rubygame::Color.remove_from_cache( name )
-
 		name = sanitize_name( name )
 		@colors[name] = color
 	end

data/lib/rubygame/deprecated_mixer.rb

@@ -257,7 +257,7 @@ class Rubygame::Mixer::Sample
   def self.load_audio( filename )
     Rubygame.deprecated( "Rubygame::Mixer::Sample", "3.0" )
 
-    chunk = SDL::Mixer.LoadWAV( filename.to_s )
+    chunk = SDL::Mixer.LoadWAV( filename )
 
     if( chunk.pointer.null? )
       raise( Rubygame::SDLError,
@@ -331,7 +331,7 @@ class Rubygame::Mixer::Music
   def self.load_audio
     Rubygame.deprecated( "Rubygame::Mixer::Music", "3.0" )
 
-    music = SDL::Mixer.LoadMUS( filename.to_s )
+    music = SDL::Mixer.LoadMUS( filename )
 
     if( music.pointer.null? )
       raise( Rubygame::SDLError,

data/lib/rubygame/image.rb

@@ -76,7 +76,7 @@ class Rubygame::Surface
     # XPM:: "XPixMap" format.
     # 
     def load( filename )
-      surf = SDL::Image.Load( filename.to_s )
+      surf = SDL::Image.Load( filename )
 
       if( surf.pointer.null? )
         raise( Rubygame::SDLError, "Couldn't load image \"%s\": %s"%\

data/lib/rubygame/main.rb

@@ -25,7 +25,7 @@ require "ruby-sdl-ffi/sdl"
 module Rubygame
 
   VERSIONS = {
-    :rubygame => [2, 5, 3],
+    :rubygame => [2, 6, 4],
     :sdl      => SDL.Linked_Version().to_ary
   }
 

data/lib/rubygame/music.rb

@@ -76,7 +76,7 @@ class Rubygame::Music
     def load( filename )
       Rubygame.open_audio
 
-      music = SDL::Mixer.LoadMUS( filename.to_s )
+      music = SDL::Mixer.LoadMUS( filename )
 
       if( music.pointer.null? )
         raise( Rubygame::SDLError, "Could not load Music file '%s': %s"%

data/lib/rubygame/screen.rb

@@ -153,73 +153,12 @@ class Rubygame::Screen < Rubygame::Surface
 
 
 
-  # call-seq:
-  #   new( size, opts={} )
-  #   new( size, depth=0, flags=[] )  # DEPRECATED
-  # 
   # Create a new Rubygame window if there is none, or modify the
   # existing one. You cannot create more than one Screen; the existing
   # one will be replaced. (This is a limitation of SDL.)
   # 
   # Returns the resulting Screen.
   #
-  # size:: Screen size to create, [width, height] (in pixels).
-  # 
-  # opts::
-  #   Hash of options. The possible options are:
-  # 
-  #   :depth::      Requested color depth (in bits per pixel). If this
-  #                 is 0 or unspecified, Rubygame automatically
-  #                 chooses the depth based on the system depth.
-  #                 Possible values: 0, 8, 15, 16, 24, 32. Default: 0.
-  # 
-  #   :fullscreen:: If true, use fullscreen mode. If a hardware
-  #                 resolution change is not possible (for whatever
-  #                 reason), the next higher resolution will be used
-  #                 and the display window centered on a black
-  #                 background. Default: false.
-  # 
-  #   :resizable::  If true, the user will be able to resize the
-  #                 Rubygame window. When the window is resized, a
-  #                 ResizeEvent or Events::WindowResized event is
-  #                 generated. You should then use Screen.open to
-  #                 re-create the display surface at the new size.
-  #                 Default: false.
-  # 
-  #   :noframe::    If true, try to create a window with no title bar
-  #                 or frame decoration. This is automatically true
-  #                 when :fullscreen is true. Default: false.
-  # 
-  #   :hardware::   If true, try to create a hardware accelerated
-  #                 Surface (using a graphics card), which may be very
-  #                 fast to blit onto other hardware accelerated
-  #                 Surfaces, but somewhat slower to access in other
-  #                 ways. Creates a normal, non-accelerated Surface if
-  #                 hardware Surfaces are not available. Default:
-  #                 false.
-  # 
-  #   :doublebuf::  If true, enable hardware double buffering; only
-  #                 valid when :hardware is true. Calling #flip will
-  #                 switch the buffers and update the screen. All
-  #                 drawing will take place on the surface that is not
-  #                 displayed at the moment. If double buffering could
-  #                 not be enabled then #flip will just update the
-  #                 entire screen. Default: false.
-  # 
-  #   :opengl::     If true, create an OpenGL rendering context
-  #                 instead of a normal SDL display. You must set
-  #                 proper OpenGL video attributes with GL#set_attrib
-  #                 before calling this method with this flag. You can
-  #                 then use an OpenGL library (e.g. ruby-opengl) to
-  #                 do all OpenGL-related functions. Please note that
-  #                 you can't blit or draw regular SDL Surfaces onto
-  #                 an OpenGL-mode screen; you must use OpenGL
-  #                 functions. Default: false.
-  # 
-  # For backwards compatibility, you can provide the following
-  # arguments instead of the ones above. However, this form is
-  # DEPRECATED and will be removed in Rubygame 3.0:
-  # 
   # size::  requested window size (in pixels), in the form [width,height]
   # depth:: requested color depth (in bits per pixel). If 0 (default), the
   #         current system color depth.
@@ -265,7 +204,7 @@ class Rubygame::Screen < Rubygame::Surface
   #                      frame decoration.
   #                      Fullscreen modes automatically have this flag set.
   #
-  def initialize( size, *args )
+  def initialize(  size, depth=0, flags=[Rubygame::SWSURFACE] )
 
     # Cheating a bit. First arg can be a SDL::Surface to wrap it.
     #
@@ -281,41 +220,7 @@ class Rubygame::Screen < Rubygame::Surface
       return
     end
 
-    # Support old argument style for backwards compatibility.
-    if args.size > 1 or not args[0].is_a? Hash
-      _initialize_old( size, *args )
-      return
-    end
-
-    args = _parse_args( size, args[0] )
 
-    @struct = SDL.SetVideoMode( args[:width], args[:height],
-                                args[:depth], args[:flags] )
-
-    if( @struct.pointer.null? )
-      @struct = nil
-      raise( Rubygame::SDLError,
-             "Couldn't set [%d x %d] %d bpp video mode: %s"%\
-             [args[:width], args[:height], args[:depth], SDL.GetError()] )
-    end
-  end
-
-
-  def _parse_args( size, options ) # :nodoc:
-    args = super
-
-    flags = args[:flags]
-
-    flags |= SDL::FULLSCREEN if options[:fullscreen]
-    flags |= SDL::RESIZABLE  if options[:resizable]
-    flags |= SDL::NOFRAME    if options[:noframe]
-    flags |= SDL::DOUBLEBUF  if options[:doublebuf]
-    flags |= SDL::OPENGL     if options[:opengl]
-
-    args.merge( :flags => flags )
-  end
-
-  def _initialize_old( size, depth=0, flags=[] ) # :nodoc:
     w,h = size
     flags = Rubygame.collapse_flags(flags)
 
@@ -327,6 +232,7 @@ class Rubygame::Screen < Rubygame::Surface
              "Couldn't set [%d x %d] %d bpp video mode: %s"%\
              [w, h, depth, SDL.GetError()] )
     end
+
   end
 
 

data/lib/rubygame/sound.rb

@@ -73,7 +73,7 @@ class Rubygame::Sound
     def load( filename )
       Rubygame.open_audio
 
-      sound = SDL::Mixer.LoadWAV( filename.to_s )
+      sound = SDL::Mixer.LoadWAV( filename )
 
       if( sound.pointer.null? )
         raise( Rubygame::SDLError, "Could not load Sound file '%s': %s"%

data/lib/rubygame/surface.rb

@@ -48,53 +48,18 @@ class Rubygame::Surface
   protected :struct
 
 
-  # call-seq:
-  #   new( size, opts={} )
-  #   new( size, depth=0, flags=[] )  # DEPRECATED
-  # 
-  # Create and initialize a new Surface.
+  # Create and initialize a new Surface object.
   #
-  # A Surface is a grid of image data which you blit (i.e. copy) onto
-  # other Surfaces. Since the Screen is also a Surface, Surfaces can
-  # be blit to the screen; this is the most common way to display
-  # images on the screen.
+  # A Surface is a grid of image data which you blit (i.e. copy) onto other
+  # Surfaces. Since the Rubygame display is also a Surface (see the Screen
+  # class), Surfaces can be blit to the screen; this is the most common way
+  # to display images on the screen.
   #
   # This method may raise SDLError if the SDL video subsystem could
   # not be initialized for some reason.
   #
   # This function takes these arguments:
-  # 
-  # size:: Surface size to create, [width, height] (in pixels).
-  # 
-  # opts::
-  #   Hash of options. The possible options are:
-  # 
-  #   :depth::    Requested color depth (in bits per pixel). If this
-  #               is 0 or unspecified, Rubygame automatically chooses
-  #               the depth based on the Screen mode or system depth.
-  #               Possible values: 0, 8, 15, 16, 24, 32. Default: 0.
-  # 
-  #   :alpha::    If true, Surfaces with depth 32 will have an alpha
-  #               channel (per-pixel transparency). Default: true.
-  #               (Note: Other depths cannot have an alpha channel.)
-  # 
-  #   :hardware:: If true, try to create a hardware accelerated
-  #               Surface (using a graphics card), which may be very
-  #               fast to blit onto other hardware accelerated
-  #               Surfaces, but somewhat slower to access in other
-  #               ways. Creates a normal, non-accelerated Surface if
-  #               hardware Surfaces are not available. Default: false.
-  # 
-  #   :masks::    For advanced users. Set the Surface's color masks
-  #               manually, as [r,g,b,a]. If this is nil or
-  #               unspecified, the color masks are calculated
-  #               automatically.
-  # 
-  # For backwards compatibility, you can provide the following
-  # arguments instead of the ones above. However, this form is
-  # DEPRECATED and will be removed in Rubygame 3.0:
-  # 
-  # size::  Surface size to create, [width, height] (in pixels).
+  # size::  requested surface size; an array of the form [width, height].
   # depth:: requested color depth (in bits per pixel). If depth is 0 (default),
   #         automatically choose a color depth: either the depth of the Screen
   #         mode (if one has been set), or the greatest color depth available
@@ -115,7 +80,7 @@ class Rubygame::Surface
   #                       also enable alpha. as needed. For a description
   #                       of alpha, see #alpha.
   #
-  def initialize( size, *args )
+  def initialize( size, depth=0, flags=[] )
 
     # Cheating a bit. First arg can be a SDL::Surface to wrap it.
     #
@@ -129,85 +94,6 @@ class Rubygame::Surface
       return
     end
 
-    # Support old argument style for backwards compatibility.
-    if args.size > 1 or not args[0].is_a? Hash
-      _initialize_old( size, *args )
-      return
-    end
-
-    args = _parse_args( size, args[0] )
-
-    @struct = SDL.CreateRGBSurface( args[:flags],
-                                    args[:width], args[:height],
-                                    args[:depth], *args[:masks] )
-  end
-
-
-  private
-
-
-  def _parse_args( size, options )
-    unless size.is_a?(Array) and size.size == 2 and
-        size.all?{ |i| i.is_a?(Integer) and i > 0 }
-      raise( TypeError, "Invalid size: " + size.inspect +
-             " (expected [width,height] array of integers >= 0)" )
-    end
-
-    depth = options[:depth] || 0
-    unless depth.is_a?(Integer) and depth >= 0
-      raise( TypeError, "Invalid depth: " + depth.inspect +
-             " (expected integer >= 0)" )
-    end
-
-    alpha = options.has_key?(:alpha) ? options[:alpha] : true
-
-    masks = options[:masks]
-    if masks.nil?
-      masks = _make_masks( depth, alpha )
-    else
-      unless masks.size == 4 and masks.all?{|m| m.is_a?(Integer) and m >= 0}
-        raise( TypeError, "Invalid masks: " + masks.inspect +
-               " (expected [r,g,b,a] array of integers >= 0)" )
-      end
-    end
-
-    flags = 0
-    flags |= SDL::HWSURFACE if options[:hardware]    
-
-    { :width  => size[0],
-      :height => size[1],
-      :depth  => depth,
-      :masks  => masks,
-      :flags  => flags,
-    }
-  end
-
-
-  # Calculate color masks based on requested depth and (for 32 bit)
-  # whether or not to have an alpha channel.
-  def _make_masks( depth, alpha ) # :nodoc:
-    a = alpha ? 0xff000000 : 0
-
-    masks = case depth
-            when 32;  [0xff0000,  0x00ff00,  0x0000ff,  a]
-            when 24;  [0xff0000,  0x00ff00,  0x0000ff,  0]
-            when 16;  [0x00f800,  0x0007e0,  0x00001f,  0]
-            when 15;  [0x007c00,  0x0003e0,  0x00001f,  0]
-            else      [       0,         0,         0,  0]
-            end
-
-    if FFI::Platform::BYTE_ORDER == FFI::Platform::BIG_ENDIAN
-      masks[0,3] = masks[0,3].reverse
-    end
-
-    masks
-  end
-
-
-  # Initialize the Surface in the deprecated (pre-2.7) way.
-  def _initialize_old( size, depth=0, flags=[] ) # :nodoc:
-    Rubygame.deprecated("Old Surface#new arguments style", "3.0")
-
     unless size.kind_of? Array
       raise TypeError, "Surface size is not an Array: #{size.inspect}"
     end
@@ -253,8 +139,6 @@ class Rubygame::Surface
   end
 
 
-  public
-
 
   # Return the width (in pixels) of the surface.
   #
@@ -717,7 +601,7 @@ class Rubygame::Surface
   # May raise SDLError if a problem occurs.
   #
   def savebmp( filename )
-    result = SDL.SaveBMP( @struct, filename.to_s )
+    result = SDL.SaveBMP( @struct, filename )
     if(result != 0)
       raise( Rubygame::SDLError, "Couldn't save surface to file %s: %s"%\
              [filename, SDL.GetError()] )

data/lib/rubygame/ttf.rb

@@ -75,7 +75,7 @@ class Rubygame::TTF
              "You must call TTF.setup before opening a font." )
     end
 
-    @struct = SDL::TTF.OpenFont( file.to_s, size )
+    @struct = SDL::TTF.OpenFont( file, size )
 
     if( @struct.pointer.null? )
       raise Rubygame::SDLError, "Could not open font: #{SDL.GetError()}"

data/samples/demo_curve.rb

@@ -0,0 +1,177 @@
+#!/usr/bin/env ruby
+
+require "rubygame"
+require "rubygame/ftor"
+
+
+include Rubygame
+include Rubygame::Events
+include Rubygame::EventActions
+include Rubygame::EventTriggers
+
+
+# Represents a modifiable Bézier curve.
+class Curve
+
+  def initialize( points, color=:white )
+    @points = []
+    points.each { |point| add_point( point ) }
+    @color  = :white
+    @steps  = 10
+  end
+
+
+  attr_accessor :points, :color, :steps
+
+
+  # Draw the curve on the given Surface.
+  def draw( surface )
+    unless @points.empty?
+      surface.draw_curve( @points, @color, @steps )
+    end
+  end
+
+
+  # Draw the curve's control points on the given Surface,
+  # as squares of the given color and size (even numbers work best).
+  #
+  def draw_points( surface, color=:red, size=2 )
+    rect = Rect.new(0,0,size,size)
+    @points.each do |point|
+      rect.center = point.to_a
+      surface.fill( color, rect )
+    end
+  end
+
+
+  # Appends the given point to the list of control points.
+  # +point+ must be an [x,y] array, Ftor, vector, or similar.
+  #
+  def add_point( point )
+    @points << _make_point(point)
+  end
+
+
+  # Replaces the control point at the given index with the new point.
+  # E.g. if index is 2, it sets @points[2] = new_point.
+  #
+  def replace_point( index, new_point )
+    @points[index] = _make_point( new_point )
+  end
+
+
+  # Returns the index and coordinates of the control point nearest to
+  # +pos+. +pos+ must be an [x,y] array, Ftor, vector, or similar.
+  #
+  def nearest_point( pos )
+    pos = Ftor.new(pos[0], pos[1])
+    pts = @points.to_enum(:each_with_index).collect{ |p,i| [i,p] }
+    return pts.sort_by{ |index_and_point|
+      point = index_and_point[1]
+      (pos - point).magnitude
+    }.first
+  end
+
+
+  private
+
+
+  # Construct an integer Ftor version of the point.
+  def _make_point( point )
+    begin 
+      Ftor.new(point[0].round, point[1].round)
+    rescue NoMethodError
+      raise ArgumentError, "Invalid point: #{point.inspect}"
+    end
+  end
+
+end
+
+
+
+class App
+	include EventHandler::HasEventHandler
+
+	attr_reader :screen, :clock, :queue
+
+
+  def initialize
+    @screen = Screen.new([640,480])
+
+    @queue = EventQueue.new
+    @queue.enable_new_style_events
+
+    setup_clock
+    setup_hooks
+
+    @curve = Curve.new( [[5,5], [320,240], [635,4]], :white )
+
+  end
+
+
+  def go
+		catch(:quit) do
+			loop do
+				step
+			end
+		end
+  end
+
+
+  private
+
+
+	# Do everything needed for one frame.
+	def step
+		@queue.fetch_sdl_events
+		@queue << @clock.tick
+		@queue.each do |event|
+			handle( event )
+		end
+	end  
+
+
+  def setup_clock
+    @clock = Clock.new
+    @clock.target_framerate = 30
+    @clock.calibrate
+    @clock.enable_tick_events
+  end
+
+
+  def setup_hooks
+		hooks = {
+			:escape           => :quit,
+			:q                => :quit,
+			QuitRequested     => :quit,
+
+			InputFocusGained  => :update_screen,
+			WindowUnminimized => :update_screen,
+			WindowExposed     => :update_screen,
+
+      MousePressed      => :handle_mouse,
+      MouseReleased     => :handle_mouse,
+		}
+
+		make_magic_hooks( hooks )
+  end
+
+
+	# Quit the app
+	def quit
+		throw :quit
+	end
+
+
+	# Refresh the whole screen.
+	def update_screen
+		@screen.update()
+	end
+
+
+  def handle_mouse( event )
+    
+  end
+
+
+end

data/samples/demo_gl.rb

@@ -27,7 +27,7 @@ Rubygame::GL.set_attrib(Rubygame::GL::BLUE_SIZE, 5)
 Rubygame::GL.set_attrib(Rubygame::GL::DEPTH_SIZE, 16)
 Rubygame::GL.set_attrib(Rubygame::GL::DOUBLEBUFFER, 1)
 
-Rubygame::Screen.open([WIDE,HIGH], :depth => 16, :opengl => true)
+Rubygame::Screen.open([WIDE,HIGH], 16, [Rubygame::OPENGL])
 queue = Rubygame::EventQueue.new()
 clock = Rubygame::Clock.new { |c| c.target_framerate = 60 }
 

data/samples/demo_gl_tex.rb

@@ -31,7 +31,7 @@ Rubygame::GL.set_attrib(Rubygame::GL::BLUE_SIZE, 5)
 Rubygame::GL.set_attrib(Rubygame::GL::DEPTH_SIZE, 16)
 Rubygame::GL.set_attrib(Rubygame::GL::DOUBLEBUFFER, 1)
 
-Rubygame::Screen.open([WIDE,HIGH], :depth => 16, :opengl => true)
+Rubygame::Screen.open([WIDE,HIGH], 16, [Rubygame::OPENGL])
 queue = Rubygame::EventQueue.new()
 clock = Rubygame::Clock.new { |c| c.target_framerate = 60 }
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 2
   - 6
-  - 3
-  version: 2.6.3
+  - 4
+  version: 2.6.4
 platform: ruby
 authors: 
 - John Croisant
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-31 00:00:00 -05:00
+date: 2010-04-16 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -57,6 +57,7 @@ extra_rdoc_files:
 - doc/keyboard_symbols.rdoc
 - doc/macosx_install.rdoc
 - doc/managing_framerate.rdoc
+- doc/surface_palettes.rdoc
 - doc/getting_started.rdoc
 - README
 - LICENSE
@@ -133,12 +134,14 @@ files:
 - samples/demo_gl_tex.rb
 - samples/ruby.png
 - samples/load_and_blit.rb
+- samples/demo_curve.rb
 - samples/fist.bmp
 - doc/windows_install.rdoc
 - doc/custom_sdl_load_paths.rdoc
 - doc/keyboard_symbols.rdoc
 - doc/macosx_install.rdoc
 - doc/managing_framerate.rdoc
+- doc/surface_palettes.rdoc
 - doc/getting_started.rdoc
 - README
 - LICENSE
@@ -154,7 +157,6 @@ rdoc_options: []
 
 require_paths: 
 - lib
-- lib/rubygame/
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="