rubygame 2.1.0 → 2.2.0

data/doc/macosx_install.rdoc

@@ -49,15 +49,11 @@ In order to use Rubygame applications on Mac OS X, you must use a special wrappe
 
 == Installing Rubygame
 1. {Download and unpack Rubygame}[https://sourceforge.net/project/showfiles.php?group_id=172781].
-2. (For Rubygame-1.1.0) From the rubygame directory:
-   
-    sudo ruby setup.rb all
-
-3. (For Rubygame-2.0.0) From the rubygame directory:
+2. From within the rubygame directory:
 
     sudo rake install
 
-4. Please refer to the README file for options that you can pass to setup.rb
+3. Please refer to the README file for options that you can pass to setup.rb
    or rake (depending on your version of Rubygame)
 
 == Running an application

data/doc/windows_install.rdoc

@@ -96,19 +96,9 @@ the libraries.
  set LINK_FLAGS=-L \windows\system32 -lSDL
  set LIBRUBYARG_SHARED=-L \ruby\bin -lmsvcrt-ruby18
 
- set RUBYGAME_CONFIG=--no-sdl-config
-
 The -L parameter for LIBRUBYARG_SHARED may be different if you installed
 Ruby to a path other than C:/ruby.
 
-IMPORTANT: If you are missing an optional library (such as SDL_gfx), you need
-to add some extra flags on to the 'RUBYGAME_CONFIG=...' line. The flags you
-must add are of the style '--no-????' (without quotes), where ???? is the
-name of the missing library, dropping the 'SDL_' from in front. So, if you
-don't have SDL_gfx, the last line of your envsetup.bat should be this:
-
- set RUBYGAME_CONFIG=--no-sdl-config --no-gfx
-
 == Step 4: Compile and install Rubygame
 
 Open a command prompt and navigate to the root of your Rubygame source
@@ -117,8 +107,17 @@ directory.  Type:
  envsetup.bat
  rake install
 
-Congratulations!  If all goes well, you have built and installed Rubygame.
+IMPORTANT: If you are missing an optional library (such as SDL_gfx), you must
+disable optional features by passing a "no-???" command to rake before the word
+"install". For example, to disable features that depend on SDL_gfx, you would
+type this instead of the above:
+
+ envsetup.bat
+ rake no-gfx install
+
+If all goes well, you have built and installed Rubygame.
 Try to execute <code>require 'rubygame'</code> in an irb session and run
 the provided samples to ensure that everything is acceptable.
 
-(Thanks to Ash Wilson (smashwilson) for contributing these instructions.)
+(Thanks to Ash Wilson (smashwilson) for contributing the original version of 
+these instructions.)

data/ext/rubygame/rubygame_gfx.c

@@ -59,21 +59,6 @@ VALUE rbgm_draw_fillpolygon(VALUE, VALUE, VALUE);
  *  Clean up this ugly mess of code!
  */
 
-void extract_color(VALUE rgba, Uint8* r, Uint8* g, Uint8* b, Uint8* a)
-{
-  rgba = convert_to_array(rgba);
-  if(RARRAY(rgba)->len < 3)
-    rb_raise(rb_eArgError,"color must be [r,g,b] or [r,g,b,a] form");
-  *r = NUM2UINT(rb_ary_entry(rgba,0));
-  *g = NUM2UINT(rb_ary_entry(rgba,1));
-  *b = NUM2UINT(rb_ary_entry(rgba,2));
-  
-  if(RARRAY(rgba)->len > 3)
-    *a = NUM2UINT(rb_ary_entry(rgba,3));
-  else
-    *a = 255;
-}
-
 void extract_xy(VALUE point, Sint16* x, Sint16* y)
 {
 	point = convert_to_array(point);
@@ -97,7 +82,8 @@ void draw_line(VALUE target, VALUE pt1, VALUE pt2, VALUE rgba, int aa)
   extract_xy(pt1, &x1, &y1);
   extract_xy(pt2, &x2, &y2);
   
-  extract_color(rgba, &r, &g, &b, &a);
+  rgba = convert_color( rgba );
+  extract_rgba_u8_as_u8(rgba, &r, &g, &b, &a);
 
   Data_Get_Struct(target,SDL_Surface,dest);
   //printf("dest: %dx%d\n",dest->w,dest->h);
@@ -171,7 +157,8 @@ void draw_rect(VALUE target, VALUE pt1, VALUE pt2, VALUE rgba, int fill)
   extract_xy(pt1, &x1, &y1);
   extract_xy(pt2, &x2, &y2);
   
-  extract_color(rgba, &r, &g, &b, &a);
+  rgba = convert_color( rgba );
+  extract_rgba_u8_as_u8(rgba, &r, &g, &b, &a);
 
   Data_Get_Struct(target,SDL_Surface,dest);
   //printf("dest: %dx%d\n",dest->w,dest->h);
@@ -235,7 +222,8 @@ void draw_circle(VALUE target, VALUE center, VALUE radius, VALUE rgba, int aa, i
   extract_xy(center, &x, &y);
   rad = NUM2INT(radius);
   
-  extract_color(rgba, &r, &g, &b, &a);
+  rgba = convert_color( rgba );
+  extract_rgba_u8_as_u8(rgba, &r, &g, &b, &a);
 
   Data_Get_Struct(target,SDL_Surface,dest);
   //printf("dest: %dx%d\n",dest->w,dest->h);
@@ -318,7 +306,8 @@ void draw_ellipse(VALUE target, VALUE center, VALUE radii, VALUE rgba, int aa, i
   extract_xy(center, &x, &y);
   extract_xy(radii, &radx, &rady);
   
-  extract_color(rgba, &r, &g, &b, &a);
+  rgba = convert_color( rgba );
+  extract_rgba_u8_as_u8(rgba, &r, &g, &b, &a);
 
   Data_Get_Struct(target,SDL_Surface,dest);
 
@@ -403,7 +392,8 @@ void draw_pie(VALUE target, VALUE center, VALUE radius, VALUE angles, VALUE rgba
   extract_xy(angles, &start, &end);
   rad = NUM2INT(radius);
   
-  extract_color(rgba, &r, &g, &b, &a);
+  rgba = convert_color( rgba );
+  extract_rgba_u8_as_u8(rgba, &r, &g, &b, &a);
 
   Data_Get_Struct(target,SDL_Surface,dest);
 
@@ -431,7 +421,7 @@ void draw_pie(VALUE target, VALUE center, VALUE radius, VALUE angles, VALUE rgba
 
 /* 
  *  call-seq:
- *    draw_pie(center, radius, angles, color)
+ *    draw_arc(center, radius, angles, color)
  *
  *  Draw a non-solid arc (part of a circle), given the coordinates of
  *  its center, radius, and starting/ending angles.
@@ -499,7 +489,8 @@ void draw_polygon(VALUE target, VALUE points, VALUE rgba, int aa, int fill)
     extract_xy(each_point, &(x[loop]), &(y[loop]));
   }
 
-  extract_color(rgba, &r, &g, &b, &a);
+  rgba = convert_color( rgba );
+  extract_rgba_u8_as_u8(rgba, &r, &g, &b, &a);
 
   Data_Get_Struct(target,SDL_Surface,dest);
 

data/ext/rubygame/rubygame_gfx.h

@@ -63,7 +63,6 @@
 #endif
 
 extern void Init_rubygame_gfx();
-extern void extract_color(VALUE, Uint8*, Uint8*, Uint8*, Uint8*);
 extern void extract_xy(VALUE, Sint16*, Sint16*);
 
 extern void draw_line(VALUE, VALUE, VALUE, VALUE, int);

data/ext/rubygame/rubygame_screen.c

@@ -35,6 +35,8 @@ VALUE rbgm_screen_getsurface(VALUE);
 VALUE rbgm_screen_getcaption(VALUE);
 VALUE rbgm_screen_setcaption(VALUE, VALUE);
 
+VALUE rbgm_screen_seticon(VALUE, VALUE);
+
 VALUE rbgm_screen_update(int, VALUE*, VALUE);
 VALUE rbgm_screen_updaterects(VALUE, VALUE);
 VALUE rbgm_screen_flip(VALUE);
@@ -190,6 +192,31 @@ VALUE rbgm_screen_setcaption(VALUE self, VALUE title)
   return self;
 }
 
+/*  call-seq:
+ *    icon = icon
+ *
+ *  Sets the window icon for the Screen.
+ *
+ *  icon::    a Rubygame::Surface to be displayed at the top of the Rubygame
+ *            window (when not in fullscreen mode), and in other OS-specific
+ *            areas (like the taskbar entry). If omitted or +nil+, no icon
+ *            will be shown at all.
+ *
+ *  NOTE: The SDL docs state that icons on Win32 systems must be 32x32 pixels.
+ *  That may or may not be true anymore, but you might want to consider it
+ *  when creating games to run on Windows.
+ *
+ */
+VALUE rbgm_screen_seticon(VALUE self, VALUE data)
+{
+  SDL_Surface *icon;
+  
+  Data_Get_Struct(data, SDL_Surface, icon);
+  SDL_WM_SetIcon(icon, NULL);
+  
+  return self;
+}
+
 /*  call-seq:
  *     update()
  *     update(rect)
@@ -290,7 +317,7 @@ VALUE rbgm_screen_updaterects(VALUE self, VALUE array_rects)
   /* initialize the array of Rects from array_rects */
   for( i=0; i < num_rects; i++ )
   {
-    each_rect = rb_ary_entry(array_rects,i);
+    each_rect = convert_to_array(rb_ary_entry(array_rects,i));
 
     Sint16 x,y,left,top,right,bottom;
     Uint16 w,h;
@@ -404,6 +431,7 @@ void Rubygame_Init_Screen()
   /* Screen methods */
   rb_define_method(cScreen,"title",rbgm_screen_getcaption,0);
   rb_define_method(cScreen,"title=",rbgm_screen_setcaption,1);
+  rb_define_method(cScreen,"icon=",rbgm_screen_seticon,1);
   rb_define_method(cScreen,"update",rbgm_screen_update,-1);
   rb_define_method(cScreen,"update_rects",rbgm_screen_updaterects,1);
   rb_define_method(cScreen,"flip",rbgm_screen_flip,0);

data/ext/rubygame/rubygame_screen.h

@@ -31,6 +31,8 @@ extern VALUE rbgm_screen_getsurface(VALUE);
 extern VALUE rbgm_screen_getcaption(VALUE);
 extern VALUE rbgm_screen_setcaption(VALUE, VALUE);
 
+extern VALUE rbgm_screen_seticon(VALUE, VALUE);
+
 extern VALUE rbgm_screen_update(int, VALUE*, VALUE);
 extern VALUE rbgm_screen_updaterects(VALUE, VALUE);
 extern VALUE rbgm_screen_flip(VALUE);

data/ext/rubygame/rubygame_shared.c

@@ -27,6 +27,7 @@ VALUE cSurface;
 VALUE cRect;
 VALUE eSDLError;
 SDL_Rect *make_rect(int, int, int, int);
+SDL_Color make_sdl_color(VALUE);
 int init_video_system();
 void Init_rubygame_shared();
 
@@ -91,6 +92,62 @@ VALUE convert_to_array(VALUE val)
 	return v;
 }
 
+/* Takes a Color, Array, or color name (Symbol or String).
+ * Returns an RGBA Array, or raises eTypeError if it can't.
+ */
+VALUE convert_color(VALUE color)
+{
+	if( rb_respond_to(color, rb_intern("to_sdl_rgba_ary")) )
+	{
+		return rb_funcall( color, rb_intern("to_sdl_rgba_ary"), 0 );
+	}
+	else if( rb_respond_to(color, rb_intern("to_ary")) )
+	{
+		return convert_to_array( color );
+	}
+	else if( TYPE(color) == T_SYMBOL || TYPE(color) == T_STRING )
+	{
+		VALUE mColor = rb_const_get( mRubygame, rb_intern("Color") );
+		return convert_color( rb_funcall( mColor, rb_intern("[]"), 1, color) );
+	}
+	else
+	{
+		rb_raise(rb_eTypeError, "unsupported type %s for color",
+						 rb_obj_classname(color));
+	}
+}
+
+SDL_Color make_sdl_color(VALUE vcolor)
+{
+	SDL_Color color;
+	vcolor = convert_color(vcolor);
+	extract_rgb_u8_as_u8(vcolor, &(color.r), &(color.g), &(color.b));
+	return color;
+}
+
+void extract_rgb_u8_as_u8(VALUE color, Uint8 *r, Uint8 *g, Uint8 *b)
+{
+	*r = NUM2UINT(rb_ary_entry(color, 0));
+	*g = NUM2UINT(rb_ary_entry(color, 1));
+	*b = NUM2UINT(rb_ary_entry(color, 2));
+}
+
+void extract_rgba_u8_as_u8(VALUE color, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a)
+{
+	*r = NUM2UINT(rb_ary_entry(color, 0));
+	*g = NUM2UINT(rb_ary_entry(color, 1));
+	*b = NUM2UINT(rb_ary_entry(color, 2));
+
+	if( RARRAY(color)->len > 3 )
+	{
+		*a = NUM2UINT(rb_ary_entry(color, 3));
+	}
+	else
+	{
+		*a = 255;
+	}
+}
+
 /* --
  *
  *  call-seq:

data/ext/rubygame/rubygame_shared.h

@@ -30,10 +30,16 @@ extern VALUE mRubygame;
 extern VALUE eSDLError;
 extern VALUE cSurface;
 extern VALUE cRect;
+
 extern SDL_Rect *make_rect(int, int, int, int);
 extern VALUE make_symbol(char *);
 extern Uint32 collapse_flags(VALUE);
 extern VALUE convert_to_array(VALUE);
+
+extern SDL_Color make_sdl_color(VALUE);
+extern void extract_rgb_u8_as_u8(VALUE, Uint8*, Uint8*, Uint8*);
+extern void extract_rgba_u8_as_u8(VALUE, Uint8*, Uint8*, Uint8*, Uint8*);
+
 extern int init_video_system();
 extern void Init_rubygame_shared();
 

data/ext/rubygame/rubygame_surface.c

@@ -379,10 +379,8 @@ VALUE rbgm_surface_set_colorkey( int argc, VALUE *argv, VALUE self)
 
 	if( RTEST(vcolor) )
 	{
-		vcolor = convert_to_array(vcolor);
-		r = NUM2UINT(rb_ary_entry(vcolor,0));
-		g = NUM2UINT(rb_ary_entry(vcolor,1));
-		b = NUM2UINT(rb_ary_entry(vcolor,2));
+		vcolor = convert_color(vcolor);
+		extract_rgb_u8_as_u8(vcolor, &r, &g, &b);
 		color = SDL_MapRGB(surf->format, r,g,b);
 	}
 	else
@@ -508,20 +506,9 @@ VALUE rbgm_surface_fill( int argc, VALUE *argv, VALUE self )
 
 	rb_scan_args(argc, argv, "11", &vcolor, &vrect);
 
-	vcolor = convert_to_array(vcolor);
-	r = NUM2UINT(rb_ary_entry(vcolor,0));
-	g = NUM2UINT(rb_ary_entry(vcolor,1));
-	b = NUM2UINT(rb_ary_entry(vcolor,2));
-	/* if the array is larger than [R,G,B], it should be [R,G,B,A] */
-	if(RARRAY(vcolor)->len > 3)
-	{
-		a = NUM2UINT(rb_ary_entry(vcolor,3));
-		color = SDL_MapRGBA(surf->format, r,g,b,a);
-	}
-	else
-	{
-		color = SDL_MapRGB(surf->format, r,g,b);
-	}
+	vcolor = convert_color(vcolor);
+	extract_rgba_u8_as_u8(vcolor, &r, &g, &b, &a);
+	color = SDL_MapRGBA(surf->format, r,g,b,a);
 
 	if( NIL_P(vrect) )
 	{
@@ -641,6 +628,57 @@ VALUE rbgm_surface_getat( int argc, VALUE *argv, VALUE self )
 	return rb_ary_new3(4,UINT2NUM(r),UINT2NUM(g),UINT2NUM(b),UINT2NUM(a));
 }
 
+
+/* 
+ *  call-seq:
+ *     set_at([x,y], color)
+ *
+ *  Set the color of the pixel at the given coordinate.
+ *
+ *  color can be one of:
+ *  * an Array, [r,g,b] or [r,g,b,a] with each component in 0-255
+ *  * an instance of ColorRGB, ColorHSV, etc.
+ *  * the name of a color in Rubygame::Color, as a Symbol or String
+ *
+ *  Raises IndexError if the coordinates are out of bounds.
+ *
+ *--
+ *
+ *  I'm lazy and just using SDL_FillRect. ;-P
+ *  It's easier and less bug-prone this way.
+ *  I have no idea about speed comparisons.
+ *
+ */
+VALUE rbgm_surface_setat( int argc, VALUE *argv, VALUE self )
+{
+	SDL_Surface *surf;
+	SDL_Rect *rect;
+	Uint32 color;
+	Uint8 r,g,b,a;
+	VALUE vpos, vcolor;
+
+	Data_Get_Struct(self, SDL_Surface, surf);
+
+	rb_scan_args(argc, argv, "2", &vpos, &vcolor);
+
+	vcolor = convert_color(vcolor);
+	extract_rgba_u8_as_u8(vcolor, &r, &g, &b, &a);
+	color = SDL_MapRGBA(surf->format, r,g,b,a);
+
+	vpos = convert_to_array(vpos);
+	rect = make_rect( NUM2INT(rb_ary_entry(vpos,0)),
+	                  NUM2INT(rb_ary_entry(vpos,1)),
+	                  1, 1 );
+
+	SDL_FillRect(surf,rect,color);
+
+	free(rect);
+
+	return self;
+}
+
+
+
 /*
  *  call-seq:
  *    pixels  ->  String
@@ -721,6 +759,7 @@ VALUE rbgm_surface_set_clip( VALUE self, VALUE clip )
 		                 );
 
 		SDL_SetClipRect(surf,rect);
+		free(rect);
 	}
 
 	return self;
@@ -1081,6 +1120,7 @@ void Rubygame_Init_Surface()
 	rb_define_method(cSurface,"blit",rbgm_surface_blit,-1);
 	rb_define_method(cSurface,"fill",rbgm_surface_fill,-1);
 	rb_define_method(cSurface,"get_at",rbgm_surface_getat,-1);
+	rb_define_method(cSurface,"set_at",rbgm_surface_setat,-1);
 	rb_define_method(cSurface,"pixels",rbgm_surface_pixels,0);
 	rb_define_method(cSurface,"clip",rbgm_surface_get_clip,0);
 	rb_define_method(cSurface,"clip=",rbgm_surface_set_clip,1);

data/ext/rubygame/rubygame_ttf.c

@@ -353,19 +353,6 @@ VALUE rbgm_ttf_size_unicode(VALUE self, VALUE string)
 	return result;
 }
 
-/*
-* Helper function for color handling for the rendering functions.
-*/
-
-static void RBGM_array_to_color(SDL_Color * color, VALUE arr) {
-	if( RTEST(arr) )
-	{
-		arr = convert_to_array(arr);
-		color->r = NUM2UINT(rb_ary_entry(arr, 0));
-		color->g = NUM2UINT(rb_ary_entry(arr, 1));
-		color->b = NUM2UINT(rb_ary_entry(arr, 2));
-	}
-}
 
 /*
  *--
@@ -397,8 +384,12 @@ VALUE rbgm_ttf_render(int argc, VALUE *argv, VALUE self)
 
 	Data_Get_Struct(self,TTF_Font,font);
 
-	RBGM_array_to_color(&fore, vfg);
-	RBGM_array_to_color(&back, vbg);
+	fore = make_sdl_color(vfg);
+
+	if( RTEST(vbg) )
+	{
+		back = make_sdl_color(vbg);
+	}
 
 	if( RTEST(vaa) ) /* anti-aliasing enabled */
 	{
@@ -452,8 +443,12 @@ VALUE rbgm_ttf_render_utf8(int argc, VALUE *argv, VALUE self)
  
  	Data_Get_Struct(self,TTF_Font,font);
  
-	RBGM_array_to_color(&fore, vfg);
-	RBGM_array_to_color(&back, vbg);
+	fore = make_sdl_color(vfg);
+
+	if( RTEST(vbg) )
+	{
+		back = make_sdl_color(vbg);
+	}
 
 	if( RTEST(vaa) ) /* anti-aliasing enabled */
  	{
@@ -507,8 +502,12 @@ VALUE rbgm_ttf_render_unicode(int argc, VALUE *argv, VALUE self)
  
  	Data_Get_Struct(self,TTF_Font,font);
 
-	RBGM_array_to_color(&fore, vfg);
-	RBGM_array_to_color(&back, vbg);
+	fore = make_sdl_color(vfg);
+
+	if( RTEST(vbg) )
+	{
+		back = make_sdl_color(vbg);
+	}
  
 	if( RTEST(vaa) ) /* anti-aliasing enabled */
  	{