ruby-sdl-ffi 0.1

data/README.rdoc

@@ -0,0 +1,90 @@
+
+= Ruby-SDL-FFI
+
+Version::    0.1
+Date::       2009-10-24
+
+Homepage::   http://github.com/jacius/ffi-sdl/
+Author::     John Croisant <jacius@gmail.com>
+Copyright::  2009  John Croisant
+
+
+== Description
+
+Ruby-SDL-FFI is a low-level binding to SDL [1] and related
+libraries using Ruby-FFI [2]. It provides very basic access
+to SDL from Ruby [3] without the need for a compiled C
+wrapper. It aims to be platform and Ruby implementation
+independent.
+
+Ruby-SDL-FFI does not attempt to provide any high-level
+functionality, only to mirror the standard SDL interface.
+For higher-level functionality, you should use other
+libraries (Rubygame [4], Gosu [5], etc.).
+
+1. SDL: http://www.libsdl.org/
+2. Ruby-FFI: http://kenai.com/projects/ruby-ffi/
+3. Ruby: http://www.ruby-lang.org/en/
+4. Rubygame: http://rubygame.org/
+5. Gosu: http://www.libgosu.org/
+
+
+== Caveats
+
+Ruby-SDL-FFI is still in VERY EARLY DEVELOPMENT STAGES. That means:
+
+* It may not work correctly (or at all).
+* It may not be complete.
+* It may change drastically with no advanced notice.
+
+As such, this library is currently FOR THE ADVENTUROUS ONLY.
+If you are not willing to continuously update your code to
+match the new API, then you should wait until Ruby-SDL-FFI is
+more mature and stable (i.e. version 1.0+).
+
+
+== Requirements
+
+* SDL       >= 1.2.13
+* Ruby-FFI  >= 0.4.0 (or compatible FFI implementation)
+* Nice-FFI  >= 0.2.0
+
+Optional:
+
+* SDL_image >= 1.2.7
+* SDL_gfx   >= 2.0.17
+* SDL_mixer >= 1.2.8
+* SDL_ttf   >= 2.0.9
+
+Ruby-SDL-FFI may work with older versions, but hasn't been tried on them.
+
+So far, Ruby-SDL-FFI has only been tested on 32-bit Linux with
+the standard Ruby implementation (aka MRI) version 1.8.6.
+However, with a few tweaks it should work on any system with
+compatible FFI functionality.
+
+
+== License
+
+Ruby-SDL-FFI is licensed under the following terms (the "MIT License"):
+
+Copyright (c) 2009 John Croisant
+
+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.

data/lib/ruby-sdl-ffi.rb

@@ -0,0 +1,56 @@
+#--
+#
+# This file is one part of:
+#
+# Ruby-SDL-FFI - Ruby-FFI bindings to SDL
+#
+# Copyright (c) 2009 John Croisant
+#
+# 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.
+#
+#++
+
+
+this_dir = File.expand_path( File.dirname(__FILE__) )
+
+
+# sdl.rb is absolutely required. If it fails, don't catch the error.
+require File.join( this_dir, 'ruby-sdl-ffi', 'sdl' )
+
+
+# The others are "optional", so just give a warning if they fail.
+# Users who really need them should load them directly, with
+# e.g. 'require "ruby-sdl-ffi/gfx"'.
+%w{
+
+  image
+  ttf
+  mixer
+  gfx
+
+}.each do |f|
+
+  begin
+    require File.join( this_dir, 'ruby-sdl-ffi', f )
+  rescue LoadError => e
+    warn "Warning: " + e.message
+  end
+
+end

data/lib/ruby-sdl-ffi/gfx.rb

@@ -0,0 +1,56 @@
+#--
+#
+# This file is one part of:
+#
+# Ruby-SDL-FFI - Ruby-FFI bindings to SDL
+#
+# Copyright (c) 2009 John Croisant
+#
+# 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.
+#
+#++
+
+
+this_dir = File.expand_path( File.dirname(__FILE__) )
+
+
+require File.join( this_dir, "sdl" )
+
+
+module SDL
+  module Gfx
+    extend NiceFFI::Library
+    load_library "SDL_gfx", SDL::LOAD_PATHS
+
+    def self.sdl_func( name, args, ret )
+      func name, "SDL_#{name}", args, ret
+    end
+  end
+end
+
+%w{
+  framerate
+  blitfunc
+  primitives
+  imagefilter
+  rotozoom
+}.each do |f|
+  require File.join( this_dir, "gfx", f )
+end

data/lib/ruby-sdl-ffi/gfx/blitfunc.rb

@@ -0,0 +1,56 @@
+#--
+#
+# This file is one part of:
+#
+# Ruby-SDL-FFI - Ruby-FFI bindings to SDL
+#
+# Copyright (c) 2009 John Croisant
+#
+# 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.
+#
+#++
+
+
+module SDL
+  module Gfx
+
+    optfunc  :BlitRGBA, "SDL_gfxBlitRGBA",
+             [ :pointer, :pointer, :pointer, :pointer ], :int
+
+    optfunc  :SetAlpha, "SDL_gfxSetAlpha", [ :pointer, :uint8 ], :int
+
+
+    class BlitInfo < NiceFFI::Struct
+      layout( :s_pixels, :pointer,
+              :s_width,  :int,
+              :s_height, :int,
+              :s_skip,   :int,
+              :d_pixels, :pointer,
+              :d_width,  :int,
+              :d_height, :int,
+              :d_skip,   :int,
+              :aux_data, :pointer,
+              :src,      SDL::PixelFormat.typed_pointer,
+              :table,    :pointer,
+              :dst,      SDL::PixelFormat.typed_pointer )
+    end
+
+  end
+end

data/lib/ruby-sdl-ffi/gfx/framerate.rb

@@ -0,0 +1,51 @@
+#--
+#
+# This file is one part of:
+#
+# Ruby-SDL-FFI - Ruby-FFI bindings to SDL
+#
+# Copyright (c) 2009 John Croisant
+#
+# 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.
+#
+#++
+
+
+module SDL
+  module Gfx
+
+    FPS_UPPER_LIMIT = 200
+    FPS_LOWER_LIMIT = 1
+    FPS_DEFAULT     = 30
+
+    class FPSmanager < NiceFFI::Struct
+      layout( :framecount, :uint32,
+              :rateticks,  :float,
+              :lastticks,  :uint32,
+              :rate,       :uint32 )
+    end
+
+    sdl_func  :initFramerate,  [ :pointer       ], :void
+    sdl_func  :setFramerate,   [ :pointer, :int ], :int
+    sdl_func  :getFramerate,   [ :pointer       ], :int
+    sdl_func  :framerateDelay, [ :pointer       ], :void
+
+  end
+end

data/lib/ruby-sdl-ffi/gfx/imagefilter.rb

@@ -0,0 +1,176 @@
+#--
+#
+# This file is one part of:
+#
+# Ruby-SDL-FFI - Ruby-FFI bindings to SDL
+#
+# Copyright (c) 2009 John Croisant
+#
+# 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.
+#
+#++
+
+
+module SDL
+  module Gfx
+
+    sdl_func  :imageFilterMMXdetect, [ ], :int
+    sdl_func  :imageFilterMMXoff,    [ ], :void
+    sdl_func  :imageFilterMMXon,     [ ], :void
+
+
+    sdl_func  :imageFilterAdd, 
+              [ :pointer, :pointer, :pointer, :int ], :int
+
+    sdl_func  :imageFilterMean, 
+              [ :pointer, :pointer, :pointer, :int ], :int
+
+    sdl_func  :imageFilterSub, 
+              [ :pointer, :pointer, :pointer, :int ], :int
+
+    sdl_func  :imageFilterAbsDiff, 
+              [ :pointer, :pointer, :pointer, :int ], :int
+
+    sdl_func  :imageFilterMult, 
+              [ :pointer, :pointer, :pointer, :int ], :int
+
+    sdl_func  :imageFilterMultNor, 
+              [ :pointer, :pointer, :pointer, :int ], :int
+
+    sdl_func  :imageFilterMultDivby2, 
+              [ :pointer, :pointer, :pointer, :int ], :int
+
+    sdl_func  :imageFilterMultDivby4, 
+              [ :pointer, :pointer, :pointer, :int ], :int
+
+    sdl_func  :imageFilterBitAnd, 
+              [ :pointer, :pointer, :pointer, :int ], :int
+
+    sdl_func  :imageFilterBitOr, 
+              [ :pointer, :pointer, :pointer, :int ], :int
+
+    sdl_func  :imageFilterDiv, 
+              [ :pointer, :pointer, :pointer, :int ], :int
+
+    sdl_func  :imageFilterBitNegation, 
+              [ :pointer, :pointer, :int ], :int
+
+
+
+    sdl_func  :imageFilterAddByte, 
+              [ :pointer, :pointer, :int, :uchar ], :int
+
+    sdl_func  :imageFilterAddUint, 
+              [ :pointer, :pointer, :int, :uint ], :int
+
+    sdl_func  :imageFilterAddByteToHalf,
+              [ :pointer, :pointer, :int, :uchar ], :int
+
+
+    sdl_func  :imageFilterSubByte, 
+              [ :pointer, :pointer, :int, :uchar ], :int
+
+    sdl_func  :imageFilterSubUint, 
+              [ :pointer, :pointer, :int, :uint ], :int
+
+
+
+    sdl_func  :imageFilterShiftRight, 
+              [ :pointer, :pointer, :int, :uchar ], :int
+
+    sdl_func  :imageFilterShiftRightUint, 
+              [ :pointer, :pointer, :int, :uchar ], :int
+
+
+
+    sdl_func  :imageFilterMultByByte, 
+              [ :pointer, :pointer, :int, :uchar ], :int
+
+    sdl_func  :imageFilterShiftRightAndMultByByte, 
+              [ :pointer, :pointer, :int, :uchar, :uchar ], :int
+
+
+
+    sdl_func  :imageFilterShiftLeftByte, 
+              [ :pointer, :pointer, :int, :uchar ], :int
+
+    sdl_func  :imageFilterShiftLeftUint, 
+              [ :pointer, :pointer, :int, :uchar ], :int
+
+    sdl_func  :imageFilterShiftLeft, 
+              [ :pointer, :pointer, :int, :uchar ], :int
+
+
+
+    sdl_func  :imageFilterBinarizeUsingThreshold, 
+              [ :pointer, :pointer, :int, :uchar ], :int
+
+
+    sdl_func  :imageFilterClipToRange, 
+              [ :pointer, :pointer, :int, :uchar, :uchar ], :int
+
+
+    sdl_func  :imageFilterNormalizeLinear, 
+              [ :pointer, :pointer, :int, :int, :int, :int, :int ], :int
+
+
+
+    sdl_func  :imageFilterConvolveKernel3x3Divide, 
+              [ :pointer, :pointer, :int, :int, :pointer, :uchar ], :int
+
+    sdl_func  :imageFilterConvolveKernel5x5Divide, 
+              [ :pointer, :pointer, :int, :int, :pointer, :uchar ], :int
+
+    sdl_func  :imageFilterConvolveKernel7x7Divide, 
+              [ :pointer, :pointer, :int, :int, :pointer, :uchar ], :int
+
+    sdl_func  :imageFilterConvolveKernel9x9Divide, 
+              [ :pointer, :pointer, :int, :int, :pointer, :uchar ], :int
+
+
+
+    sdl_func  :imageFilterConvolveKernel3x3ShiftRight, 
+              [ :pointer, :pointer, :int, :int, :pointer, :uchar ], :int
+
+    sdl_func  :imageFilterConvolveKernel5x5ShiftRight, 
+              [ :pointer, :pointer, :int, :int, :pointer, :uchar ], :int
+
+    sdl_func  :imageFilterConvolveKernel7x7ShiftRight, 
+              [ :pointer, :pointer, :int, :int, :pointer, :uchar ], :int
+
+    sdl_func  :imageFilterConvolveKernel9x9ShiftRight, 
+              [ :pointer, :pointer, :int, :int, :pointer, :uchar ], :int
+
+
+
+    sdl_func  :imageFilterSobelX, 
+              [ :pointer, :pointer, :int, :int ], :int
+
+    sdl_func  :imageFilterSobelXShiftRight, 
+              [ :pointer, :pointer, :int, :int, :uchar ], :int
+
+
+
+    sdl_func  :imageFilterAlignStack, [ ], :void
+    sdl_func  :imageFilterRestoreStack, [ ], :void
+
+
+  end
+end