sdl2_ffi 0.0.5 → 0.0.6

data/lib/sdl2/gem_version.rb

@@ -1,4 +1,4 @@
 
 module SDL2
-  GEM_VERSION = "0.0.5"
+  GEM_VERSION = "0.0.6"
 end

data/lib/sdl2/gesture.rb

@@ -7,9 +7,17 @@ module SDL2
   
   typedef :int64, :gesture_id
   
-  api :SDL_RecordGesture, [:touch_id], :int
-  api :SDL_SaveAllDollarTemplates, [RWops.by_ref], :int
-  api :SDL_SaveDollarTemplate, [:gesture_id, RWops.by_ref], :int
-  api :SDL_LoadDollarTemplates, [:touch_id, RWops.by_ref], :int
+  ##
+	#
+	api :SDL_RecordGesture, [:touch_id], :int
+  ##
+	#
+	api :SDL_SaveAllDollarTemplates, [RWops.by_ref], :int
+  ##
+	#
+	api :SDL_SaveDollarTemplate, [:gesture_id, RWops.by_ref], :int
+  ##
+	#
+	api :SDL_LoadDollarTemplates, [:touch_id, RWops.by_ref], :int
 
 end

data/lib/sdl2/haptic.rb

@@ -436,35 +436,95 @@ module SDL2
 
   ##
   # Get the number of haptics?
-  api :SDL_NumHaptics, [], :int
-  api :SDL_HapticName, [:int], :string
-  api :SDL_HapticOpen, [:int], Haptic.auto_ptr
-  api :SDL_HapticOpened, [:int], :int
-  api :SDL_HapticIndex, [Haptic.by_ref], :int
-  api :SDL_MouseIsHaptic, [], :int
-  api :SDL_HapticOpenFromMouse, [], Haptic.auto_ptr
-  api :SDL_JoystickIsHaptic, [Joystick.by_ref], :int
-  api :SDL_HapticOpenFromJoystick, [Joystick.by_ref], Haptic.auto_ptr
-  api :SDL_HapticClose, [Haptic.by_ref], :void
-  api :SDL_HapticNumEffects, [Haptic.by_ref], :int
-  api :SDL_HapticNumEffectsPlaying, [Haptic.by_ref], :int
-  api :SDL_HapticQuery, [Haptic.by_ref], :int
-  api :SDL_HapticNumAxes, [Haptic.by_ref], :int
-  api :SDL_HapticEffectSupported, [Haptic.by_ref, Haptic::Effect.by_ref], :int
-  api :SDL_HapticNewEffect, [Haptic.by_ref, Haptic::Effect.by_ref], :int
-  api :SDL_HapticUpdateEffect, [Haptic.by_ref, :int, Haptic::Effect.by_ref], :int
-  api :SDL_HapticRunEffect, [Haptic.by_ref, :int, :uint32], :int
-  api :SDL_HapticStopEffect, [Haptic.by_ref, :int], :int
-  api :SDL_HapticDestroyEffect, [Haptic.by_ref, :int], :int
-  api :SDL_HapticGetEffectStatus, [Haptic.by_ref, :int], :int
-  api :SDL_HapticSetGain, [Haptic.by_ref, :int], :int
-  api :SDL_HapticSetAutocenter, [Haptic.by_ref, :int], :int
-  api :SDL_HapticPause, [Haptic.by_ref], :int
-  api :SDL_HapticUnpause, [Haptic.by_ref], :int
-  api :SDL_HapticStopAll, [Haptic.by_ref], :int
-  api :SDL_HapticRumbleSupported, [Haptic.by_ref], :int
-  api :SDL_HapticRumbleInit, [Haptic.by_ref], :int
-  api :SDL_HapticRumblePlay, [Haptic.by_ref], :int
-  api :SDL_HapticRumbleStop, [Haptic.by_ref], :int
+  ##
+	#
+	api :SDL_NumHaptics, [], :int
+  ##
+	#
+	api :SDL_HapticName, [:int], :string
+  ##
+	#
+	api :SDL_HapticOpen, [:int], Haptic.auto_ptr
+  ##
+	#
+	api :SDL_HapticOpened, [:int], :int
+  ##
+	#
+	api :SDL_HapticIndex, [Haptic.by_ref], :int
+  ##
+	#
+	api :SDL_MouseIsHaptic, [], :int
+  ##
+	#
+	api :SDL_HapticOpenFromMouse, [], Haptic.auto_ptr
+  ##
+	#
+	api :SDL_JoystickIsHaptic, [Joystick.by_ref], :int
+  ##
+	#
+	api :SDL_HapticOpenFromJoystick, [Joystick.by_ref], Haptic.auto_ptr
+  ##
+	#
+	api :SDL_HapticClose, [Haptic.by_ref], :void
+  ##
+	#
+	api :SDL_HapticNumEffects, [Haptic.by_ref], :int
+  ##
+	#
+	api :SDL_HapticNumEffectsPlaying, [Haptic.by_ref], :int
+  ##
+	#
+	api :SDL_HapticQuery, [Haptic.by_ref], :int
+  ##
+	#
+	api :SDL_HapticNumAxes, [Haptic.by_ref], :int
+  ##
+	#
+	api :SDL_HapticEffectSupported, [Haptic.by_ref, Haptic::Effect.by_ref], :int
+  ##
+	#
+	api :SDL_HapticNewEffect, [Haptic.by_ref, Haptic::Effect.by_ref], :int
+  ##
+	#
+	api :SDL_HapticUpdateEffect, [Haptic.by_ref, :int, Haptic::Effect.by_ref], :int
+  ##
+	#
+	api :SDL_HapticRunEffect, [Haptic.by_ref, :int, :uint32], :int
+  ##
+	#
+	api :SDL_HapticStopEffect, [Haptic.by_ref, :int], :int
+  ##
+	#
+	api :SDL_HapticDestroyEffect, [Haptic.by_ref, :int], :int
+  ##
+	#
+	api :SDL_HapticGetEffectStatus, [Haptic.by_ref, :int], :int
+  ##
+	#
+	api :SDL_HapticSetGain, [Haptic.by_ref, :int], :int
+  ##
+	#
+	api :SDL_HapticSetAutocenter, [Haptic.by_ref, :int], :int
+  ##
+	#
+	api :SDL_HapticPause, [Haptic.by_ref], :int
+  ##
+	#
+	api :SDL_HapticUnpause, [Haptic.by_ref], :int
+  ##
+	#
+	api :SDL_HapticStopAll, [Haptic.by_ref], :int
+  ##
+	#
+	api :SDL_HapticRumbleSupported, [Haptic.by_ref], :int
+  ##
+	#
+	api :SDL_HapticRumbleInit, [Haptic.by_ref], :int
+  ##
+	#
+	api :SDL_HapticRumblePlay, [Haptic.by_ref], :int
+  ##
+	#
+	api :SDL_HapticRumbleStop, [Haptic.by_ref], :int
 
 end

data/lib/sdl2/hints.rb

@@ -51,9 +51,17 @@ module SDL2
     end
   end
 
-  api :SDL_ClearHints, [], :void
-  api :SDL_GetHint, [:string], :string
-  api :SDL_SetHint, [:string, :string], :bool, {error: true}
-  api :SDL_SetHintWithPriority, [:string, :string, :hint_priority], :bool
+  ##
+	#
+	api :SDL_ClearHints, [], :void
+  ##
+	#
+	api :SDL_GetHint, [:string], :string
+  ##
+	#
+	api :SDL_SetHint, [:string, :string], :bool, {error: true}
+  ##
+	#
+	api :SDL_SetHintWithPriority, [:string, :string, :hint_priority], :bool
 
 end

data/lib/sdl2/image.rb

@@ -10,49 +10,131 @@ module SDL2
     extend Library
     ffi_lib SDL_IMAGE_MODULE
 
+    module INIT
+      include EnumerableConstants
+      JPG = next_const_value
+      PNG = next_const_value
+      TIF = next_const_value
+      WEBP = next_const_value
+    end
+    enum :init_flags, INIT.flatten_consts
 
-    enum :init_flags, [:JPG, :PNG, :TIF, :WEBP]
-
-    api :IMG_Init, [:init_flags], :int
+    ##
+    # Loads dynamic libraries and prepares them for use.  Flags should be
+    # one or more flags from IMG_InitFlags OR'd together.
+    # It returns the flags successfully initialized, or 0 on failure.
+    api :IMG_Init, [:init_flags], :int, {error: true, filter: TRUE_WHEN_NOT_ZERO}
+    ##
+    #
     api :IMG_Quit, [], :void
+    ##
+    #
     api :IMG_LoadTyped_RW, [RWops.by_ref, :int, :string], Surface.auto_ptr
+    ##
+    #
     api :IMG_Load, [:string], Surface.auto_ptr, {error: true, filter: TRUE_WHEN_NOT_NULL }
+    ##
+    #
     api :IMG_Load_RW, [RWops.by_ref, :int], Surface.auto_ptr
 
+    ##
+    #
     api :IMG_isICO, [RWops.by_ref], :int
+    ##
+    #
     api :IMG_isCUR, [RWops.by_ref], :int
+    ##
+    #
     api :IMG_isBMP, [RWops.by_ref], :int
+    ##
+    #
     api :IMG_isGIF, [RWops.by_ref], :int
+    ##
+    #
     api :IMG_isJPG, [RWops.by_ref], :int
+    ##
+    #
     api :IMG_isLBM, [RWops.by_ref], :int
+    ##
+    #
     api :IMG_isPCX, [RWops.by_ref], :int
+    ##
+    #
     api :IMG_isPNG, [RWops.by_ref], :int
+    ##
+    #
     api :IMG_isPNM, [RWops.by_ref], :int
+    ##
+    #
     api :IMG_isTIF, [RWops.by_ref], :int
+    ##
+    #
     api :IMG_isXCF, [RWops.by_ref], :int
+    ##
+    #
     api :IMG_isXPM, [RWops.by_ref], :int
+    ##
+    #
     api :IMG_isXV, [RWops.by_ref], :int
+    ##
+    #
     api :IMG_isWEBP, [RWops.by_ref], :int
 
+    ##
+    #
     api :IMG_LoadICO_RW, [RWops.by_ref], Surface.auto_ptr
+    ##
+    #
     api :IMG_LoadCUR_RW, [RWops.by_ref], Surface.auto_ptr
+    ##
+    #
     api :IMG_LoadBMP_RW, [RWops.by_ref], Surface.auto_ptr
+    ##
+    #
     api :IMG_LoadGIF_RW, [RWops.by_ref], Surface.auto_ptr
+    ##
+    #
     api :IMG_LoadJPG_RW, [RWops.by_ref], Surface.auto_ptr
+    ##
+    #
     api :IMG_LoadLBM_RW, [RWops.by_ref], Surface.auto_ptr
+    ##
+    #
     api :IMG_LoadPCX_RW, [RWops.by_ref], Surface.auto_ptr
+    ##
+    #
     api :IMG_LoadPNG_RW, [RWops.by_ref], Surface.auto_ptr
+    ##
+    #
     api :IMG_LoadPNM_RW, [RWops.by_ref], Surface.auto_ptr
+    ##
+    #
     api :IMG_LoadTGA_RW, [RWops.by_ref], Surface.auto_ptr
+    ##
+    #
     api :IMG_LoadTIF_RW, [RWops.by_ref], Surface.auto_ptr
+    ##
+    #
     api :IMG_LoadXCF_RW, [RWops.by_ref], Surface.auto_ptr
+    ##
+    #
     api :IMG_LoadXPM_RW, [RWops.by_ref], Surface.auto_ptr
+    ##
+    #
     api :IMG_LoadXV_RW, [RWops.by_ref], Surface.auto_ptr
+    ##
+    #
     api :IMG_LoadWEBP_RW, [RWops.by_ref], Surface.auto_ptr
 
+    ##
+    #
     api :IMG_ReadXPMFromArray, [:pointer], Surface.auto_ptr
 
+    ##
+    #
     api :IMG_SavePNG, [Surface.by_ref, :string], :int
+    ##
+    #
     api :IMG_SavePNG_RW, [Surface.by_ref, RWops.by_ref, :int], :int
 
   end

data/lib/sdl2/init.rb

@@ -22,10 +22,14 @@ module SDL2
   enum :init_flag, INIT.flatten_consts
   
 
-  api :SDL_Init, [:init_flag], :int, {error: true}
+  ##
+	#
+	api :SDL_Init, [:init_flag], :int, {error: true}
 
 
-  api :SDL_InitSubSystem, [:init_flag], :int, {error: true}
+  ##
+	#
+	api :SDL_InitSubSystem, [:init_flag], :int, {error: true}
 
   def init_sub_system!(flags)
     error_code = init_sub_system(flags)
@@ -34,11 +38,17 @@ module SDL2
     end
   end
 
-  api :SDL_WasInit, [:init_flag], :uint32
+  ##
+	#
+	api :SDL_WasInit, [:init_flag], :uint32
     
   boolean? :was_init, TRUE_WHEN_NOT_ZERO
 
-  api :SDL_Quit, [], :void
+  ##
+	#
+	api :SDL_Quit, [], :void
 
-  api :SDL_QuitSubSystem, [:init_flag], :void
+  ##
+	#
+	api :SDL_QuitSubSystem, [:init_flag], :void
 end

data/lib/sdl2/joystick.rb

@@ -22,23 +22,57 @@ module SDL2
   typedef :int32, :joystick_id
   typedef :int32, :joystick_index # Dunno
 
-  api :SDL_NumJoysticks, [], :int
-  api :SDL_JoystickNameForIndex, [:int], :string
-  api :SDL_JoystickOpen, [:int], Joystick.auto_ptr
-  api :SDL_JoystickName, [Joystick.by_ref], :string
-  api :SDL_JoystickGetDeviceGUID, [:int], JoystickGUID
-  api :SDL_JoystickGetGUID, [Joystick.by_ref], JoystickGUID
-  api :SDL_JoystickGetGUIDString, [JoystickGUID.by_value, :pointer, :int], :void
-  api :SDL_JoystickGetGUIDFromString, [:string], JoystickGUID
-  api :SDL_JoystickGetAttached, [Joystick.by_ref], :bool
-  api :SDL_JoystickInstanceID, [Joystick.by_ref], :joystick_id
-  api :SDL_JoystickNumAxes, [Joystick.by_ref], :int
-  api :SDL_JoystickNumBalls, [Joystick.by_ref], :int
-  api :SDL_JoystickNumHats, [Joystick.by_ref], :int
-  api :SDL_JoystickNumButtons, [Joystick.by_ref], :int
-  api :SDL_JoystickUpdate, [], :void
-  api :SDL_JoystickEventState, [:int], :int
-  api :SDL_JoystickGetAxis, [Joystick.by_ref, :int], :int16
+  ##
+	#
+	api :SDL_NumJoysticks, [], :int
+  ##
+	#
+	api :SDL_JoystickNameForIndex, [:int], :string
+  ##
+	#
+	api :SDL_JoystickOpen, [:int], Joystick.auto_ptr
+  ##
+	#
+	api :SDL_JoystickName, [Joystick.by_ref], :string
+  ##
+	#
+	api :SDL_JoystickGetDeviceGUID, [:int], JoystickGUID
+  ##
+	#
+	api :SDL_JoystickGetGUID, [Joystick.by_ref], JoystickGUID
+  ##
+	#
+	api :SDL_JoystickGetGUIDString, [JoystickGUID.by_value, :pointer, :int], :void
+  ##
+	#
+	api :SDL_JoystickGetGUIDFromString, [:string], JoystickGUID
+  ##
+	#
+	api :SDL_JoystickGetAttached, [Joystick.by_ref], :bool
+  ##
+	#
+	api :SDL_JoystickInstanceID, [Joystick.by_ref], :joystick_id
+  ##
+	#
+	api :SDL_JoystickNumAxes, [Joystick.by_ref], :int
+  ##
+	#
+	api :SDL_JoystickNumBalls, [Joystick.by_ref], :int
+  ##
+	#
+	api :SDL_JoystickNumHats, [Joystick.by_ref], :int
+  ##
+	#
+	api :SDL_JoystickNumButtons, [Joystick.by_ref], :int
+  ##
+	#
+	api :SDL_JoystickUpdate, [], :void
+  ##
+	#
+	api :SDL_JoystickEventState, [:int], :int
+  ##
+	#
+	api :SDL_JoystickGetAxis, [Joystick.by_ref, :int], :int16
 
   # Hat positions
   module HAT
@@ -54,8 +88,16 @@ module SDL2
     LEFTDOWN = LEFT | DOWN
   end
 
-  api :SDL_JoystickGetHat, [Joystick.by_ref, :int], :uint8
-  api :SDL_JoystickGetBall, [Joystick.by_ref, :int, IntStruct.by_ref, IntStruct.by_ref], :int
-  api :SDL_JoystickGetButton, [Joystick.by_ref, :int], :uint8
-  api :SDL_JoystickClose, [Joystick.by_ref], :void
+  ##
+	#
+	api :SDL_JoystickGetHat, [Joystick.by_ref, :int], :uint8
+  ##
+	#
+	api :SDL_JoystickGetBall, [Joystick.by_ref, :int, IntStruct.by_ref, IntStruct.by_ref], :int
+  ##
+	#
+	api :SDL_JoystickGetButton, [Joystick.by_ref, :int], :uint8
+  ##
+	#
+	api :SDL_JoystickClose, [Joystick.by_ref], :void
 end

data/lib/sdl2/keyboard.rb

@@ -7,7 +7,9 @@ module SDL2
   
   typedef :int16, :keymod
   
-  
+  # The SDL keysym structure, used in key events.
+  #
+  # @note: If you are looking for translated character input, see the TextInputEvent.
   class Keysym < Struct
     layout :scancode, :int32,
       :sym, :keycode,
@@ -18,20 +20,102 @@ module SDL2
     member_writers *members
   end
   
-  api :SDL_GetKeyboardFocus, [], Window.by_ref
-  api :SDL_GetKeyboardState, [:count], UInt8Struct.by_ref
-  api :SDL_GetModState, [], :keymod
-  api :SDL_SetModState, [:keymod], :void
-  api :SDL_GetKeyFromScancode, [:scancode], :keycode
-  api :SDL_GetScancodeFromKey, [:keycode], :scancode
-  api :SDL_GetScancodeName, [:scancode], :string
-  api :SDL_GetScancodeFromName, [:string], :scancode
-  api :SDL_GetKeyName, [:keycode], :string
-  api :SDL_GetKeyFromName, [:string], :keycode
-  api :SDL_StartTextInput, [], :void
-  api :SDL_IsTextInputActive, [], :bool
-  api :SDL_StopTextInput, [], :void
-  api :SDL_SetTextInputRect, [Rect.by_ref], :void
-  api :SDL_HasScreenKeyboardSupport, [], :bool
-  api :SDL_IsScreenKeyboardShown, [], :bool
+  ##
+	# Get the window which currently has keyboard focus.
+  # :call-seq:
+  #   get_keyboard_focus()
+  #   get_keyboard_focus!
+	api :SDL_GetKeyboardFocus, [], Window.by_ref
+	  
+  ##
+	#  brief Get a snapshot of the current state of the keyboard.
+  #
+  #  @param numkeys if non-NULL, receives the length of the returned array.
+  #
+  #  @return An array of key states. 
+	#   Indexes into this array are obtained by using ::SDL_Scancode values.
+	#
+  #
+  #  Example: See Keyboard::get_state()
+  #  @code
+  #    count = FFI::MemoryPointer.new :int, 1
+  #    state = FFI::Pointer.new :uint8, SDL2::get_keyboard_state(count)
+  #    if state[SDL2::SCANCODE::RETURN]
+  #      puts("<RETURN> is pressed.\n");
+	#    end
+	api :SDL_GetKeyboardState, [:pointer], :pointer
+	  
+  
+  ##
+	#
+	api :SDL_GetModState, [], :keymod
+  ##
+	#
+	api :SDL_SetModState, [:keymod], :void
+  ##
+	#
+	api :SDL_GetKeyFromScancode, [:scancode], :keycode
+  ##
+	#
+	api :SDL_GetScancodeFromKey, [:keycode], :scancode
+  ##
+	#
+	api :SDL_GetScancodeName, [:scancode], :string
+  ##
+	#
+	api :SDL_GetScancodeFromName, [:string], :scancode
+  ##
+	#
+	api :SDL_GetKeyName, [:keycode], :string
+  ##
+	#
+	api :SDL_GetKeyFromName, [:string], :keycode
+  ##
+	#
+	api :SDL_StartTextInput, [], :void
+  ##
+	#
+	api :SDL_IsTextInputActive, [], :bool
+  ##
+	#
+	api :SDL_StopTextInput, [], :void
+  ##
+	#
+	api :SDL_SetTextInputRect, [Rect.by_ref], :void
+  ##
+	#
+	api :SDL_HasScreenKeyboardSupport, [], :bool
+  ##
+	#
+	api :SDL_IsScreenKeyboardShown, [], :bool
+	  
+	module Keyboard
+	  # Get the window which currently has keyboard focus
+	  def self.get_focus()
+	    SDL2::get_keyboard_focus()
+	  end
+	  
+	  # Get a snapshot of the current state of the keyboard.  
+    def self.get_state()      
+      count = FFI::MemoryPointer.new :int, 1
+      state = FFI::Pointer.new :uint8, SDL2::get_keyboard_state(count)
+      result = state.get_array_of_int(0, count.get_int(0))      
+      count.free
+      state.free
+      return result
+    end
+    
+    # Get the current key modifier state for the keyboard.
+    def self.get_mod()
+      SDL2::get_mod_state()
+    end    
+    
+    # Set the current key modifire state for the keyboard.
+    # @note This does not change the keyboard state, only the key modifier flags.
+    def self.set_mod(modstate)
+      SDL2::set_mod_state(modstate)
+    end
+    
+   
+	end
 end