allegro4r 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 / 2009-04-17
+
+* Initial Release.
+* Added Ruby ports and API support for the Allegro examples exhello, exmem, expal, expat, exflame, exdbuf, exflip, exfixed, exfont, exmouse, extimer, exkeys (limited support), exjoy, exsample, and exmidi.

data/Manifest.txt

@@ -0,0 +1,58 @@
+ext/a4r_API_BITMAP.c
+ext/a4r_API_bitmap_objects.c
+ext/a4r_API_blitting_and_sprites.c
+ext/a4r_API_digital_sample_routines.c
+ext/a4r_API_DIGI_DRIVER.c
+ext/a4r_API_direct_access_to_video_memory.c
+ext/a4r_API_drawing_primitives.c
+ext/a4r_API_file_and_compression_routines.c
+ext/a4r_API_fixed_point_math_routines.c
+ext/a4r_API_fonts.c
+ext/a4r_API_GFX_DRIVER.c
+ext/a4r_API_graphics_modes.c
+ext/a4r_API_JOYSTICK_AXIS_INFO.c
+ext/a4r_API_JOYSTICK_BUTTON_INFO.c
+ext/a4r_API_JOYSTICK_DRIVER.c
+ext/a4r_API_JOYSTICK_INFO.c
+ext/a4r_API_joystick_routines.c
+ext/a4r_API_JOYSTICK_STICK_INFO.c
+ext/a4r_API_KEYBOARD_DRIVER.c
+ext/a4r_API_keyboard_routines.c
+ext/a4r_API_MIDI_DRIVER.c
+ext/a4r_API_misc.c
+ext/a4r_API_MOUSE_DRIVER.c
+ext/a4r_API_mouse_routines.c
+ext/a4r_API_music_routines_midi.c
+ext/a4r_API_PALETTE.c
+ext/a4r_API_palette_routines.c
+ext/a4r_API_RGB.c
+ext/a4r_API_sound_init_routines.c
+ext/a4r_API_text_output.c
+ext/a4r_API_TIMER_DRIVER.c
+ext/a4r_API_timer_routines.c
+ext/a4r_API_transparency_and_patterned_drawing.c
+ext/a4r_API_truecolor_pixel_formats.c
+ext/a4r_API_unicode_routines.c
+ext/a4r_API_using_allegro.c
+ext/allegro4r.c
+ext/allegro4r.h
+ext/extconf.rb
+examples/exdbuf.rb
+examples/exfixed.rb
+examples/exflame.rb
+examples/exflip.rb
+examples/exfont.rb
+examples/exhello.rb
+examples/exjoy.rb
+examples/exkeys.rb
+examples/exmem.rb
+examples/exmidi.rb
+examples/exmouse.rb
+examples/expal.rb
+examples/expat.rb
+examples/exsample.rb
+examples/extimer.rb
+examples/unifont.dat
+Manifest.txt
+README.txt
+History.txt

data/README.txt

@@ -0,0 +1,94 @@
+     ______   ___    ___                               __ __
+    /\  _  \ /\_ \  /\_ \                             /\ \\ \
+    \ \ \L\ \\//\ \ \//\ \      __     __   _ __   ___\ \ \\ \    _ __
+     \ \  __ \ \ \ \  \ \ \   /'__`\ /'_ `\/\`'__\/ __`\ \ \\ \_ /\`'__\
+      \ \ \/\ \ \_\ \_ \_\ \_/\  __//\ \L\ \ \ \//\ \L\ \ \__ ,__\ \ \/
+       \ \_\ \_\/\____\/\____\ \____\ \____ \ \_\\ \____/\/_/\_\_/\ \_\
+        \/_/\/_/\/____/\/____/\/____/\/___L\ \/_/ \/___/    \/_/   \/_/
+                                       /\____/
+                                       \_/__/     Version 0.0.1
+
+= Allegro4r
+
+http://allegro4r.rubyforge.org
+
+Ruby binding to the Allegro game programming library. <http://alleg.sourceforge.net>
+
+== REQUIREMENTS:
+
+* Allegro 4.2.2 <http://alleg.sourceforge.net/wip.html>
+
+== INSTALL:
+
+* Install Allegro 4.2.2
+
+  Windows:: The easiest way to install Allegro is to download the precompiled binaries found here[http://www.allegro.cc/files/].
+            Download the MinGW binary version.  For 32 bit Windows, put the files in the System32 directory.  For 64 bit Windows, put the files in the SysWOW64 directory.
+
+  Linux:: For Debian based Linux (e.g. Ubuntu), install the allegro4.2 or liballegro4.2 package: <tt>sudo apt-get install allegro4.2</tt>
+          More package information can be found here[http://packages.debian.org/source/lenny/allegro4.2].
+
+* <tt>gem install allegro4r</tt>
+
+== EXAMPLES:
+
+See code examples in the examples directory.
+
+== HISTORY:
+
+See History.txt
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Jason Frey
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+Except as contained in this notice, the name(s) of the above copyright
+holders shall not be used in advertising or otherwise to promote the
+sale, use, or other dealings in this Software without prior written
+authorization.
+
+== ALLEGRO LICENSE:
+
+Allegro is gift-ware. It was created by a number of people working in
+cooperation, and is given to you freely as a gift. You may use, modify,
+redistribute, and generally hack it about in any way you like, and you do not
+have to give us anything in return.
+
+However, if you like this product you are encouraged to thank us by making a
+return gift to the Allegro community. This could be by writing an add-on
+package, providing a useful bug report, making an improvement to the library,
+or perhaps just releasing the sources of your program so that other people can
+learn from them. If you redistribute parts of this code or make a game using
+it, it would be nice if you mentioned Allegro somewhere in the credits, but
+you are not required to do this. We trust you not to abuse our generosity.
+
+By Shawn Hargreaves, 18 October 1998.
+
+DISCLAIMER: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT.
+IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE
+LIABLE FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+OR OTHER DEALINGS IN THE SOFTWARE.

data/examples/exdbuf.rb

@@ -0,0 +1,58 @@
+#
+# Example program (C Version) for the Allegro library, by Shawn Hargreaves.
+#   (Ruby port by Jason Frey)
+#
+# This program demonstrates the use of double buffering.
+# It moves a circle across the screen, first just erasing and
+# redrawing directly to the screen, then with a double buffer.
+#
+
+require 'rubygems'
+require 'allegro4r'
+include Allegro4r::API
+
+exit 1 if allegro_init != 0
+install_timer
+install_keyboard
+
+if set_gfx_mode(GFX_AUTODETECT, 320, 200, 0, 0) != 0
+  if set_gfx_mode(GFX_SAFE, 320, 200, 0, 0) != 0
+    set_gfx_mode(GFX_TEXT, 0, 0, 0, 0)
+    allegro_message("Unable to set any graphic mode\n%s\n" % allegro_error)
+    exit 1
+  end
+end
+
+set_palette(desktop_palette)
+
+# allocate the memory buffer
+buffer = create_bitmap(SCREEN_W(), SCREEN_H())
+
+# First without any buffering...
+# Note use of the global retrace_counter to control the speed. We also
+# compensate screen size (GFX_SAFE) with a virtual 320 screen width.
+clear_keybuf
+c = retrace_count + 32
+while retrace_count - c <= 320 + 32
+  acquire_screen
+  clear_to_color(screen, makecol(255, 255, 255))
+  circlefill(screen, (retrace_count - c) * SCREEN_W()/320, SCREEN_H()/2, 32, makecol(0, 0, 0))
+  textprintf_ex(screen, font, 0, 0, makecol(0, 0, 0), -1, "No buffering (%s)" % gfx_driver.name)
+  release_screen
+
+  break if keypressed
+end
+
+# and now with a double buffer...
+clear_keybuf
+c = retrace_count + 32;
+while retrace_count - c <= 320 + 32
+  clear_to_color(buffer, makecol(255, 255, 255))
+  circlefill(buffer, (retrace_count - c) * SCREEN_W()/320, SCREEN_H()/2, 32, makecol(0, 0, 0))
+  textprintf_ex(buffer, font, 0, 0, makecol(0, 0, 0), -1, "Double buffered (%s)" % gfx_driver.name)
+  blit(buffer, screen, 0, 0, 0, 0, SCREEN_W(), SCREEN_H())
+
+  break if keypressed
+end
+
+destroy_bitmap(buffer)

data/examples/exfixed.rb

@@ -0,0 +1,46 @@
+#
+# Example program (C Version) for the Allegro library, by Shawn Hargreaves.
+#   (Ruby port by Jason Frey)
+#
+# This program demonstrates how to use fixed point numbers, which
+# are signed 32-bit integers storing the integer part in the
+# upper 16 bits and the decimal part in the 16 lower bits. This
+# example also uses the unusual approach of communicating with
+# the user exclusively via the allegro_message() function.
+#
+
+require 'rubygems'
+require 'allegro4r'
+include Allegro4r::API
+
+exit 1 if allegro_init != 0
+
+# convert integers to fixed point like this
+x = itofix(10)
+
+# convert floating point to fixed point like this
+y = ftofix(3.14)
+
+# fixed point variables can be assigned, added, subtracted, negated,
+# and compared just like integers, eg:
+z = x + y
+allegro_message("%f + %f = %f\n" % [fixtof(x), fixtof(y), fixtof(z)])
+
+# you can't add integers or floating point to fixed point, though:
+#    z = x + 3
+# would give the wrong result.
+
+# fixed point variables can be multiplied or divided by integers or
+# floating point numbers, eg:
+z = y * 2
+allegro_message("%f * 2 = %f\n" % [fixtof(y), fixtof(z)])
+
+# you can't multiply or divide two fixed point numbers, though:
+#    z = x * y;
+# would give the wrong result. Use fixmul() and fixdiv() instead, eg:
+z = fixmul(x, y)
+allegro_message("%f * %f = %f\n" % [fixtof(x), fixtof(y), fixtof(z)])
+
+# fixed point trig and square root are also available, eg:
+z = fixsqrt(x)
+allegro_message("fixsqrt(%f) = %f\n" % [fixtof(x), fixtof(z)])

data/examples/exflame.rb

@@ -0,0 +1,200 @@
+#
+# Example program (C Version) for the Allegro library, by Shawn Hargreaves.
+#   (Ruby port by Jason Frey)
+#
+# This program demonstrates how to write directly to video memory.
+# It implements a simple fire effect, first by calling getpixel() and
+# putpixel(), then by accessing video memory directly a byte at a
+# time, and finally using block memory copy operations.
+#
+
+require 'rubygems'
+require 'allegro4r'
+include Allegro4r::API
+
+# The fire is formed from several 'hotspots' which are moved randomly
+# across the bottom of the screen.
+FIRE_HOTSPOTS = 48
+$hotspot = Array.new(FIRE_HOTSPOTS, 0)
+
+# This function updates the bottom line of the screen with a pattern
+# of varying intensities which are then moved upwards and faded out
+# by the code in main.
+def draw_bottom_line_of_fire
+  # zero the buffer
+  (0...SCREEN_W()).each do |c|
+    $temp[c] = 0
+  end
+
+  (0...FIRE_HOTSPOTS).each do |c|
+    ($hotspot[c] - 20...$hotspot[c] + 20).each do |c2|
+      if c2 >= 0 && c2 < SCREEN_W()
+        $temp[c2] = MIN($temp[c2] + 20 - ABS($hotspot[c] - c2), 192)
+      end
+    end
+
+    # move the hotspots
+    $hotspot[c] += (AL_RAND() & 7) - 3
+    if $hotspot[c] < 0
+      $hotspot[c] += SCREEN_W()
+    elsif $hotspot[c] >= SCREEN_W()
+      $hotspot[c] -= SCREEN_W()
+    end
+  end
+
+  # display the buffer
+  (0...SCREEN_W()).each do |c|
+    putpixel(screen, c, SCREEN_H() - 1, $temp[c])
+  end
+end
+
+palette = PALETTE.new
+
+exit 1 if allegro_init != 0
+install_keyboard
+if set_gfx_mode(GFX_AUTODETECT, 320, 200, 0, 0) != 0
+  if set_gfx_mode(GFX_AUTODETECT, 640, 480, 0, 0) != 0
+    allegro_message("Error setting graphics mode\n%s\n" % allegro_error)
+    exit 1
+  end
+end
+
+begin
+  $temp = "\0" * SCREEN_W()
+rescue NoMemoryError
+  set_gfx_mode(GFX_TEXT, 0, 0, 0, 0)
+  allegro_message("Not enough memory? This is a joke right!?!\n")
+  exit 0
+end
+
+(0...FIRE_HOTSPOTS).each do |c|
+  $hotspot[c] = AL_RAND() % SCREEN_W()
+end
+
+# fill our palette with a gradually altering sequence of colors
+(0...64).each do |c|
+  palette[c].r = c;
+  palette[c].g = 0;
+  palette[c].b = 0;
+end
+(64...128).each do |c|
+  palette[c].r = 63;
+  palette[c].g = c - 64;
+  palette[c].b = 0;
+end
+(128...192).each do |c|
+  palette[c].r = 63;
+  palette[c].g = 63;
+  palette[c].b = c - 128;
+end
+(192...256).each do |c|
+  palette[c].r = 63;
+  palette[c].g = 63;
+  palette[c].b = 63;
+end
+
+set_palette(palette)
+
+textout_ex(screen, font, "Using get/putpixel", 0, 0, makecol(255,255,255), makecol(0, 0, 0))
+
+# using getpixel and putpixel is slow :-)
+while !keypressed
+  acquire_screen
+
+  draw_bottom_line_of_fire
+
+  (64...SCREEN_H() - 1).each do |y|
+    # read line
+    (0...SCREEN_W()).each do |x|
+      c = getpixel(screen, x, y + 1)
+
+      c -= 1 if c > 0
+
+      putpixel(screen, x, y, c)
+    end
+  end
+  release_screen
+end
+
+clear_keybuf
+textout_ex(screen, font, "Using direct memory writes", 0, 0, makecol(255,255,255), makecol(0, 0, 0))
+
+# It is much faster if we access the screen memory directly. This
+# time we read an entire line of the screen into our own buffer,
+# modify it there, and then write the whole line back in one go.
+# That is to avoid having to keep switching back and forth between
+# different scanlines: if we only copied one pixel at a time, we
+# would have to call bmp_write_line for every single pixel rather
+# than just twice per line.
+while !keypressed
+  acquire_screen
+  draw_bottom_line_of_fire
+
+  bmp_select(screen)
+
+  (64...SCREEN_H() - 1).each do |y|
+    # get an address for reading line y+1
+    address = bmp_read_line(screen, y + 1)
+
+    # read line with farptr functions
+    (0...SCREEN_W()).each do |x|
+      $temp[x] = bmp_read8(address + x)
+    end
+
+    # adjust it
+    (0...SCREEN_W()).each do |x|
+      $temp[x] -= 1 if $temp[x] > 0
+    end
+
+    # get an address for writing line y
+    address = bmp_write_line(screen, y)
+
+    # write line with farptr functions
+    (0...SCREEN_W()).each do |x|
+      bmp_write8(address + x, $temp[x,1])
+    end
+  end
+
+  bmp_unwrite_line(screen)
+  release_screen
+end
+
+clear_keybuf
+textout_ex(screen, font, "Using block data transfers", 0, 0, makecol(255,255,255), makecol(0, 0, 0))
+
+# It is even faster if we transfer the data in 32 bit chunks, rather
+# than only one pixel at a time. This method may not work on really
+# unusual machine architectures, but should be ok on just about
+# anything that you are practically likely to come across.
+while !keypressed
+  acquire_screen
+  draw_bottom_line_of_fire
+
+  bmp_select(screen)
+
+  (64...SCREEN_H() - 1).each do |y|
+    # get an address for reading line y+1
+    address = bmp_read_line(screen, y + 1)
+
+    # read line in 32 bit chunks
+    (0...SCREEN_W()).step(4) do |x|    # JF - sizeof(uint32_t)
+      $temp[x...x + 4] = bmp_read32(address + x)
+    end
+
+    # adjust it
+    (0...SCREEN_W()).each do |x|
+      $temp[x] -= 1 if $temp[x] > 0
+    end
+
+    # get an address for writing line y
+    address = bmp_write_line(screen, y)
+
+    # write line in 32 bit chunks
+    (0...SCREEN_W()).step(4) do |x|    # JF - sizeof(uint32_t)
+      bmp_write32(address + x, $temp[x...x + 4])
+    end
+  end
+
+  bmp_unwrite_line(screen)
+  release_screen
+end