rb_sdl2 0.1.0

data/lib/rb_sdl2/display.rb

@@ -0,0 +1,103 @@
+module RbSDL2
+  class Display
+    class << self
+      def displays
+        count = ::SDL2.SDL_GetNumVideoDisplays
+        raise RbSDL2Error if count < 0
+        count.times.map { |num| Display.new(num) }
+      end
+    end
+
+    def initialize(num)
+      @num = num
+    end
+
+    def bounds
+      rect = Rect.new
+      err = ::SDL2.SDL_GetDisplayBounds(index, rect)
+      raise RbSDL2Error if err < 0
+      rect.to_a
+    end
+
+    require_relative 'display_mode'
+
+    def closest_display_mode(**display_mode)
+      mode ||= DisplayMode.new(**display_mode)
+      closest = DisplayMode.new
+      err = ::SDL2.SDL_GetClosestDisplayMode(self, mode, closest)
+      raise RbSDL2Error if err.null?
+      closest
+      # 利用可能なディスプレイモードが検索され, 要求と最も近いモードがclosestに代入される.
+      # modeのformatとrefresh_rateが0の場合, デスクトップのモードとなる.
+      # モードは, サイズを最優先で検索し, ピクセル形式は次の優先度となる.
+      # そして最後に更新周期をチェックする. 利用可能なモードが要求に対して小さすぎる場合, NULLを戻す.
+    end
+
+    def current_display_mode
+      obj = DisplayMode.new
+      err = ::SDL2.SDL_GetCurrentDisplayMode(index, obj)
+      raise RbSDL2Error if err < 0
+      obj
+    end
+
+    def desktop_display_mode
+      obj = DisplayMode.new
+      err = ::SDL2.SDL_GetDesktopDisplayMode(index, obj)
+      raise RbSDL2Error if err < 0
+      obj
+    end
+
+    def display_modes
+      num = ::SDL2.SDL_GetNumDisplayModes(index)
+      raise RbSDL2Error if num < 0
+      num.times.map do |mode_index|
+        obj = DisplayMode.new
+        err = ::SDL2.SDL_GetDisplayMode(index, mode_index, obj)
+        raise RbSDL2Error if err < 0
+        obj
+      end
+    end
+
+    # ディスプレイピクセルの斜め、水平、垂直方向の DPI を配列で戻す。
+    def dpi
+      d_h_v_dpi = Array.new(3) { ::FFI::MemoryPointer.new(:float) }
+      err = ::SDL2.SDL_GetDisplayDPI(index, *d_h_v_dpi)
+      raise RbSDL2Error if err < 0
+      d_h_v_dpi.map { |v| v.read_float }
+    end
+
+    def index = @num
+    alias to_int index
+
+    def inspect
+      "#<#{self.class.name} name=#{name.inspect} bounds=#{bounds} dpi=#{dpi}>"
+    end
+
+    def name
+      ptr = ::SDL2.SDL_GetDisplayName(index)
+      raise RbSDL2Error if ptr.null?
+      ptr.read_string.force_encoding(Encoding::UTF_8)
+    end
+    alias to_s name
+
+    def orientation = ::SDL2.SDL_GetDisplayOrientation(index)
+
+    module DisplayOrientation
+      def flipped_landscape? = ::SDL2::SDL_ORIENTATION_LANDSCAPE_FLIPPED == orientation
+
+      def flipped_portrait? = ::SDL2::SDL_ORIENTATION_PORTRAIT_FLIPPED == orientation
+
+      def landscape? = ::SDL2::SDL_ORIENTATION_LANDSCAPE == orientation
+
+      def portrait? = ::SDL2::SDL_ORIENTATION_PORTRAIT == orientation
+    end
+    include DisplayOrientation
+
+    def usable_bounds
+      rect = Rect.new
+      err = ::SDL2.SDL_GetDisplayUsableBounds(index, rect)
+      raise RbSDL2Error if err < 0
+      rect.to_a
+    end
+  end
+end

data/lib/rb_sdl2/display_mode.rb

@@ -0,0 +1,35 @@
+module RbSDL2
+  class DisplayMode
+    def initialize(format: 0, h: 0, height: h, refresh_rate: 0, w: 0, width: w)
+      @st = ::SDL2::SDL_DisplayMode.new
+      @st[:format] = PixelFormatEnum.to_num(format)
+      @st[:w] = width
+      @st[:h] = height
+      @st[:refresh_rate] = refresh_rate
+    end
+
+    def format = @st[:format]
+
+    require_relative 'pixel_format_enum'
+    include PixelFormatEnum
+
+    def inspect
+      "#<#{self.class.name} pixel_format_name=#{pixel_format_name} w=#{w} h=#{h}\
+ refresh_rate=#{refresh_rate}>"
+    end
+
+    def width = @st[:w]
+
+    alias w width
+
+    def height = @st[:h]
+
+    alias h height
+
+    def refresh_rate = @st[:refresh_rate]
+
+    def to_h = {format: format, w: w, h: h, refresh_rate: refresh_rate}
+
+    def to_ptr = @st.to_ptr
+  end
+end

data/lib/rb_sdl2/error.rb

@@ -0,0 +1,9 @@
+module RbSDL2
+  module Error
+    class << self
+      def clear = ::SDL2.SDL_ClearError
+
+      def message = ::SDL2.SDL_GetError.read_string
+    end
+  end
+end

data/lib/rb_sdl2/event/event_filter.rb

@@ -0,0 +1,83 @@
+module RbSDL2
+  class Event
+    class EventFilter < ::FFI::Function
+      @filter_callback = nil, nil
+      @filter_mutex = Mutex.new
+
+      class << self
+        def filter_callback_set(obj, userdata = nil)
+          func = if Proc === obj
+                   # イベントを削除する時にイベントメンバーのポインターを開放（Event#clear）する。
+                   new { |event| obj.call(event) || (event.clear; nil) }
+                 else
+                   obj
+                 end
+          # func, userdata の対の関係を保つ。
+          @filter_mutex.synchronize do
+            ::SDL2.SDL_SetEventFilter(func, userdata)
+            @filter_callback = [func, userdata]
+          end
+          [obj, userdata]
+        end
+
+        # SDL にフィルターコールバック関数が設定されている場合に true を戻す。
+        def filter_callback_defined?
+          _func_userdata = Array.new(2) { ::FFI::MemoryPointer.new(:pointer) }
+          # SDL_GetEventFilter はコールバックのポインター関数が NULL の場合に SDL_FALSE となる。
+          # userdata ポインターが設定されていても SDL_GetEventFilter の戻り値に関与しない。
+          ::SDL2.SDL_GetEventFilter(*_func_userdata) == ::SDL2::SDL_TRUE
+        end
+      end
+
+      @watch_callbacks = []
+      @watch_mutex = Mutex.new
+
+      class << self
+        def add_watch_callback(obj, userdata = nil)
+          func = if Proc === obj
+                   new(&obj)
+                 else
+                   obj
+                 end
+          obj_userdata = [obj, userdata]
+          @watch_mutex.synchronize do
+            ::SDL2.SDL_AddEventWatch(func, userdata)
+            @watch_callbacks << [obj_userdata, func]
+          end
+          obj_userdata
+        end
+
+        def remove_watch_callback(obj, userdata = nil)
+          obj_userdata = [obj, userdata]
+          @watch_mutex.synchronize do
+            idx = @watch_callbacks.index { |obj| obj.first == obj_userdata }
+            if idx
+              _, func = @watch_callbacks.delete_at(idx)
+              ::SDL2.SDL_DelEventWatch(func, userdata)
+            end
+          end
+          obj_userdata
+        end
+      end
+
+      require 'delegate'
+
+      # 引数ブロックへはコールバック実行時に Event のインスタンス（のデリゲーター）が与えられる。
+      # 与えられた Event インスタンスは引数ブロック終了後に nil に変化する(デリゲート先を変更している)。
+      # SDL がイベントコールバックへ与えるイベントへのポインターがイベントキューの一部を直接指しているため
+      # コールバックを抜けた後にイベント内容の永続性が保証ができない（たぶん別のイベント内容になるだろう）。
+      # 引数ブロックに与えられたオブジェクトをスコープ外に持ち出しても安全である。
+      # オブジェクトではなくイベントの内容をスコープ外に持ち出したい場合は
+      # 与えられたオブジェクトをコピー（clone, dup）すればよい。
+      def initialize
+        # typedef int (SDLCALL * SDL_EventFilter) (void *userdata, SDL_Event * event);
+        super(:int, [:pointer, :pointer]) do |_userdata, ptr|
+          obj = SimpleDelegator.new(Event.to_ptr(ptr))
+          yield(obj) ? 1 : 0
+        ensure
+          obj.__setobj__(nil)
+        end
+      end
+    end
+  end
+end

data/lib/rb_sdl2/event/event_queue.rb

@@ -0,0 +1,137 @@
+module RbSDL2
+  class Event
+    module EventQueue
+      class << self
+        require_relative 'event_type'
+
+        def clear
+          # type が ::SDL2::SDL_DROPFILE, ::SDL2::SDL_DROPTEXT の場合に
+          # イベントに含まれる file メンバーのポインターが開放されない。そのため Ruby 側で開放処理を行う。
+          event = Event.new
+          while peep(event, ::SDL2::SDL_GETEVENT,
+                     type: ::SDL2::SDL_DROPFILE..::SDL2::SDL_DROPTEXT) > 0
+            event.clear
+          end
+          ::SDL2.SDL_FlushEvents(*EventType.minmax)
+        end
+
+        def count(type: nil) = peep(nil, ::SDL2::SDL_PEEKEVENT, type: type)
+        alias length count
+        alias size count
+
+        def deq(non_block = false, type: nil)
+          event = Event.new
+          while peep(event, ::SDL2::SDL_GETEVENT, type: type) == 0
+            raise ThreadError, Error.message if non_block
+          end
+          event
+        end
+
+        # ブロックにはイベントキューにあるイベントが渡される。
+        # ブロックへ渡されるイベントはコピーされたものでありブロックの外へ持ち出すことができる。
+        # このメソッドは SDL のイベントキューをロックする。
+        def each = block_given? ? reject! { |event| yield(event.dup); true } : to_enum
+
+        def empty? = length == 0
+
+        # イベントキューが一杯の時に 例外
+        def enq(event, non_block = false)
+          event_copy(event) do |copy|
+            while peep(copy, ::SDL2::SDL_ADDEVENT) == 0
+              raise ThreadError, Error.message if non_block
+            end
+            event
+          end
+        end
+
+        private def event_copy(event)
+          copy = event.dup
+          yield(copy).tap do
+            # 成功した場合はメンバーポインターはキューにコピーされた。
+            # ブロックの実行が成功したらメンバーポインターの開放を防ぐ。
+            if event.drop_file? || event.drop_text?
+              copy.to_ptr.autorelease = false
+              ::SDL2.SDL_free(copy)
+            end
+          end
+        end
+
+        private def main_thread!
+          if Thread.main != Thread.current
+            raise ThreadError, "the current thread is not the main thread"
+          end
+        end
+
+        private def peep(event, action, type: nil)
+          min_type, max_type = case type
+                               when nil
+                                 EventType.minmax
+                               when Range
+                                 type.minmax
+                               else
+                                 [type, type]
+                               end
+          num = ::SDL2.SDL_PeepEvents(event, event ? 1 : 0, action, min_type, max_type)
+          raise RbSDL2Error if num < 0
+          num
+        end
+
+        def poll
+          main_thread!
+          event = Event.new
+          ::SDL2::SDL_PollEvent(event).nonzero? && event
+        end
+        alias get poll
+
+        def pump
+          main_thread!
+          ::SDL2.SDL_PumpEvents
+        end
+
+        # イベントをキューに入れる。enq との違いは push ではイベントコールバックを起動する。
+        # イベントがキューに入った場合は引数のイベントを戻す。フィルターされた場合は nil を戻す。
+        # キューに入れることを失敗したら例外が発生する。
+        def push(event)
+          event_copy(event) do |copy|
+            num = ::SDL2.SDL_PushEvent(copy)
+            if num > 0
+              event
+            elsif num == 0
+              nil
+            else
+              raise RbSDL2Error
+            end
+          end
+        end
+
+        def quit?
+          pump
+          ::SDL2.SDL_HasEvent(::SDL2::SDL_QUIT) == ::SDL2::SDL_TRUE
+        end
+
+        require_relative 'event_filter'
+
+        # ブロックへ与えられたイベントは外に持ち出すことはできない。
+        # このメソッドは SDL のイベントキューをロックする。
+        # ブロックの戻り値が false の場合、イベントはキューから取り除かれる。
+        # userdata に渡されたオブジェクトはポインターに変換可能なものである必要がある。
+        def reject!(userdata = nil)
+          func = EventFilter.new { |event| yield(event) || (event.clear; nil) }
+          ::SDL2.SDL_FilterEvents(func, userdata)
+        end
+
+        def wait(sec = nil)
+          main_thread!
+          event = Event.new
+          if sec.nil?
+            ::SDL2::SDL_WaitEvent(event).nonzero? && event
+          elsif sec >= 0
+            ::SDL2::SDL_WaitEventTimeout(event, sec * 1000).nonzero? && event
+          else
+            raise ArgumentError
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rb_sdl2/event/event_type.rb

@@ -0,0 +1,271 @@
+# frozen_string_literal: true
+module RbSDL2
+  class Event
+    module EventType
+      RANGE = ::SDL2::SDL_FIRSTEVENT..::SDL2::SDL_LASTEVENT
+      EVENT_TYPES = RANGE.first.succ...::SDL2::SDL_LASTEVENT
+      COMMON_EVENT_TYPES = EVENT_TYPES.first...::SDL2::SDL_USEREVENT
+      USER_EVENT_TYPES = ::SDL2::SDL_USEREVENT...EVENT_TYPES.last
+
+      default_type = -> (_, key) do
+        case key
+        when 0 then :common
+        when COMMON_EVENT_TYPES then :common
+        when USER_EVENT_TYPES then :user
+        else raise KeyError, "(#{key})"
+        end
+      end
+
+      MEMBER_MAP = Hash.new(&default_type).merge!(
+        ::SDL2::SDL_AUDIODEVICEADDED => :adevice,
+        ::SDL2::SDL_AUDIODEVICEREMOVED => :adevice,
+        ::SDL2::SDL_DISPLAYEVENT => :display,
+        ::SDL2::SDL_KEYDOWN => :key,
+        ::SDL2::SDL_KEYUP => :key,
+        ::SDL2::SDL_CONTROLLERAXISMOTION => :caxis,
+        ::SDL2::SDL_CONTROLLERBUTTONDOWN => :cbutton,
+        ::SDL2::SDL_CONTROLLERBUTTONUP => :cbutton,
+        ::SDL2::SDL_CONTROLLERDEVICEADDED => :cdevice,
+        ::SDL2::SDL_CONTROLLERDEVICEREMAPPED => :cdevice,
+        ::SDL2::SDL_CONTROLLERDEVICEREMOVED => :cdevice,
+        ::SDL2::SDL_CONTROLLERSENSORUPDATE => :csensor,
+        ::SDL2::SDL_CONTROLLERTOUCHPADDOWN => :ctouchpad,
+        ::SDL2::SDL_CONTROLLERTOUCHPADMOTION => :ctouchpad,
+        ::SDL2::SDL_CONTROLLERTOUCHPADUP => :ctouchpad,
+        ::SDL2::SDL_DOLLARGESTURE => :dgesture,
+        ::SDL2::SDL_DOLLARRECORD => :dgesture,
+        ::SDL2::SDL_DROPBEGIN => :drop,
+        ::SDL2::SDL_DROPCOMPLETE => :drop,
+        ::SDL2::SDL_DROPFILE => :drop,
+        ::SDL2::SDL_DROPTEXT => :drop,
+        ::SDL2::SDL_FINGERDOWN => :tfinger,
+        ::SDL2::SDL_FINGERMOTION => :tfinger,
+        ::SDL2::SDL_FINGERUP => :tfinger,
+        ::SDL2::SDL_JOYAXISMOTION => :jaxis,
+        ::SDL2::SDL_JOYBALLMOTION => :jball,
+        ::SDL2::SDL_JOYBUTTONDOWN => :jbutton,
+        ::SDL2::SDL_JOYBUTTONUP => :jbutton,
+        ::SDL2::SDL_JOYDEVICEADDED => :jdevice,
+        ::SDL2::SDL_JOYDEVICEREMOVED => :jdevice,
+        ::SDL2::SDL_JOYHATMOTION => :jhat,
+        ::SDL2::SDL_MOUSEBUTTONDOWN => :button,
+        ::SDL2::SDL_MOUSEBUTTONUP => :button,
+        ::SDL2::SDL_MOUSEMOTION => :motion,
+        ::SDL2::SDL_MOUSEWHEEL => :wheel,
+        ::SDL2::SDL_MULTIGESTURE => :mgesture,
+        ::SDL2::SDL_QUIT => :quit,
+        ::SDL2::SDL_SENSORUPDATE => :sensor,
+        ::SDL2::SDL_SYSWMEVENT => :syswm,
+        ::SDL2::SDL_TEXTEDITING => :edit,
+        ::SDL2::SDL_TEXTINPUT => :text,
+        ::SDL2::SDL_WINDOWEVENT => :window,
+      ).freeze
+
+      default_name = -> (_, key) do
+        case key
+        when 0 then ""
+        when COMMON_EVENT_TYPES then "common_event"
+        when USER_EVENT_TYPES then "user_event"
+        else raise KeyError, "(#{key})"
+        end
+      end
+
+      @name_map = Hash.new(&default_name).merge!(
+        ::SDL2::SDL_APP_DIDENTERBACKGROUND => "app_did_enter_background",
+        ::SDL2::SDL_APP_DIDENTERFOREGROUND => "app_did_enter_foreground",
+        ::SDL2::SDL_APP_LOWMEMORY => "app_low_memory",
+        ::SDL2::SDL_APP_TERMINATING => "app_terminating",
+        ::SDL2::SDL_APP_WILLENTERBACKGROUND => "app_will_enter_background",
+        ::SDL2::SDL_APP_WILLENTERFOREGROUND => "app_will_enter_foreground",
+        ::SDL2::SDL_AUDIODEVICEADDED => "audio_device_added",
+        ::SDL2::SDL_AUDIODEVICEREMOVED => "audio_device_removed",
+        ::SDL2::SDL_CLIPBOARDUPDATE => "clipboard_update",
+        ::SDL2::SDL_CONTROLLERAXISMOTION => "controller_axis_motion",
+        ::SDL2::SDL_CONTROLLERBUTTONDOWN => "controller_button_down",
+        ::SDL2::SDL_CONTROLLERBUTTONUP => "controller_button_up",
+        ::SDL2::SDL_CONTROLLERDEVICEADDED => "controller_device_added",
+        ::SDL2::SDL_CONTROLLERDEVICEREMAPPED => "controller_device_remapped",
+        ::SDL2::SDL_CONTROLLERDEVICEREMOVED => "controller_device_removed",
+        ::SDL2::SDL_CONTROLLERSENSORUPDATE => "controller_sensor_update",
+        ::SDL2::SDL_CONTROLLERTOUCHPADDOWN => "controller_touchpad_down",
+        ::SDL2::SDL_CONTROLLERTOUCHPADMOTION => "controller_touchpad_motion",
+        ::SDL2::SDL_CONTROLLERTOUCHPADUP => "controller_touchpad_up",
+        ::SDL2::SDL_DISPLAYEVENT => "display_event",
+        ::SDL2::SDL_DOLLARGESTURE => "dollar_gesture",
+        ::SDL2::SDL_DOLLARRECORD => "dollar_record",
+        ::SDL2::SDL_DROPBEGIN => "drop_begin",
+        ::SDL2::SDL_DROPCOMPLETE => "drop_complete",
+        ::SDL2::SDL_DROPFILE => "drop_file",
+        ::SDL2::SDL_DROPTEXT => "drop_text",
+        ::SDL2::SDL_FINGERDOWN => "finger_down",
+        ::SDL2::SDL_FINGERUP => "finger_up",
+        ::SDL2::SDL_FINGERMOTION => "finger_motion",
+        ::SDL2::SDL_JOYAXISMOTION => "joy_axis_motion",
+        ::SDL2::SDL_JOYBALLMOTION => "joy_ball_motion",
+        ::SDL2::SDL_JOYBUTTONDOWN => "joy_button_down",
+        ::SDL2::SDL_JOYBUTTONUP => "joy_button_up",
+        ::SDL2::SDL_JOYDEVICEADDED => "joy_device_added",
+        ::SDL2::SDL_JOYDEVICEREMOVED => "joy_device_removed",
+        ::SDL2::SDL_JOYHATMOTION => "joy_hat_motion",
+        ::SDL2::SDL_KEYDOWN => "key_down",
+        ::SDL2::SDL_KEYUP => "key_up",
+        ::SDL2::SDL_KEYMAPCHANGED => "keymap_changed",
+        ::SDL2::SDL_LOCALECHANGED => "locale_changed",
+        ::SDL2::SDL_MULTIGESTURE => "multi_gesture",
+        ::SDL2::SDL_MOUSEBUTTONDOWN => "mouse_button_down",
+        ::SDL2::SDL_MOUSEBUTTONUP => "mouse_button_up",
+        ::SDL2::SDL_MOUSEMOTION => "mouse_motion",
+        ::SDL2::SDL_MOUSEWHEEL =>  "mouse_wheel",
+        ::SDL2::SDL_QUIT => "quit",
+        ::SDL2::SDL_RENDER_DEVICE_RESET => "render_device_reset",
+        ::SDL2::SDL_RENDER_TARGETS_RESET => "render_targets_reset",
+        ::SDL2::SDL_SENSORUPDATE => "sensor_update",
+        ::SDL2::SDL_SYSWMEVENT => "sys_wm_event",
+        ::SDL2::SDL_TEXTEDITING => "text_editing",
+        ::SDL2::SDL_TEXTINPUT => "text_input",
+        ::SDL2::SDL_WINDOWEVENT => "window_event",
+      )
+
+      @mutex = Mutex.new
+
+      class << self
+        def define_user_event(name = "user_event")
+          @mutex.synchronize do
+            num = ::SDL2::SDL_RegisterEvents(1)
+            if num == 0xFFFFFFFF
+              raise RbSDL2Error, "unable to register user events because too many requests"
+            end
+            @name_map[num] = name
+            num
+          end
+        end
+
+        def disable(type) = ::SDL2.SDL_EventState(type, ::SDL2::SDL_DISABLE) == ::SDL2::SDL_ENABLE
+
+        def enable(type) = ::SDL2.SDL_EventState(type, ::SDL2::SDL_ENABLE) == ::SDL2::SDL_DISABLE
+
+        def ignore?(type) = ::SDL2.SDL_EventState(type, ::SDL2::SDL_QUERY) == ::SDL2::SDL_IGNORE
+
+        def minmax = RANGE.minmax
+
+        def to_name(num) = @name_map[num]
+
+        def to_num(obj)
+          num =  @name_map.key(obj.to_s)
+          raise ArgumentError unless num
+          num
+        end
+
+        def to_type(num) = MEMBER_MAP[num]
+      end
+
+      def app_did_enter_background? = ::SDL2::SDL_APP_DIDENTERBACKGROUND == type
+
+      def app_did_enter_foreground? = ::SDL2::SDL_APP_DIDENTERFOREGROUND == type
+
+      def app_low_memory? = ::SDL2::SDL_APP_LOWMEMORY == type
+
+      def app_terminating? = ::SDL2::SDL_APP_TERMINATING == type
+
+      def app_will_enter_background? = ::SDL2::SDL_APP_WILLENTERBACKGROUND == type
+
+      def app_will_enter_foreground? = ::SDL2::SDL_APP_WILLENTERFOREGROUND == type
+
+      def audio_device_added? = ::SDL2::SDL_AUDIODEVICEADDED == type
+
+      def audio_device_removed? = ::SDL2::SDL_AUDIODEVICEREMOVED == type
+
+      def clipboard_update? = ::SDL2::SDL_CLIPBOARDUPDATE == type
+
+      def controller_axis_motion? = ::SDL2::SDL_CONTROLLERAXISMOTION == type
+
+      def controller_button_down? = ::SDL2::SDL_CONTROLLERBUTTONDOWN == type
+
+      def controller_button_up? = ::SDL2::SDL_CONTROLLERBUTTONUP == type
+
+      def controller_device_added? = ::SDL2::SDL_CONTROLLERDEVICEADDED == type
+
+      def controller_device_remapped? = ::SDL2::SDL_CONTROLLERDEVICEREMAPPED == type
+
+      def controller_device_removed? = ::SDL2::SDL_CONTROLLERDEVICEREMOVED == type
+
+      def controller_sensor_update? = ::SDL2::SDL_CONTROLLERSENSORUPDATE == type
+
+      def controller_touchpad_down? = ::SDL2::SDL_CONTROLLERTOUCHPADDOWN == type
+
+      def controller_touchpad_motion? = ::SDL2::SDL_CONTROLLERTOUCHPADMOTION == type
+
+      def controller_touchpad_up? = ::SDL2::SDL_CONTROLLERTOUCHPADUP == type
+
+      def display_event? = ::SDL2::SDL_DISPLAYEVENT == type
+
+      def dollar_gesture? = ::SDL2::SDL_DOLLARGESTURE == type
+
+      def dollar_record? = ::SDL2::SDL_DOLLARRECORD == type
+
+      def drop_begin? = ::SDL2::SDL_DROPBEGIN == type
+
+      def drop_complete? = ::SDL2::SDL_DROPCOMPLETE == type
+
+      def drop_file? = ::SDL2::SDL_DROPFILE == type
+
+      def drop_text? = ::SDL2::SDL_DROPTEXT == type
+
+      def finger_down? = ::SDL2::SDL_FINGERDOWN == type
+
+      def finger_up? = ::SDL2::SDL_FINGERUP == type
+
+      def finger_motion? = ::SDL2::SDL_FINGERMOTION == type
+
+      def joy_axis_motion? = ::SDL2::SDL_JOYAXISMOTION == type
+
+      def joy_ball_motion? = ::SDL2::SDL_JOYBALLMOTION == type
+
+      def joy_button_down? = ::SDL2::SDL_JOYBUTTONDOWN == type
+
+      def joy_button_up? = ::SDL2::SDL_JOYBUTTONUP == type
+
+      def joy_device_added? = ::SDL2::SDL_JOYDEVICEADDED == type
+
+      def joy_device_removed? = ::SDL2::SDL_JOYDEVICEREMOVED == type
+
+      def joy_hat_motion? = ::SDL2::SDL_JOYHATMOTION == type
+
+      def key_down? = ::SDL2::SDL_KEYDOWN == type
+
+      def key_up? = ::SDL2::SDL_KEYUP == type
+
+      def keymap_changed? = ::SDL2::SDL_KEYMAPCHANGED == type
+
+      def locale_changed? = ::SDL2::SDL_LOCALECHANGED == type
+
+      def multi_gesture? = ::SDL2::SDL_MULTIGESTURE == type
+
+      def mouse_button_down? = ::SDL2::SDL_MOUSEBUTTONDOWN == type
+
+      def mouse_button_up? = ::SDL2::SDL_MOUSEBUTTONUP == type
+
+      def mouse_motion? = ::SDL2::SDL_MOUSEMOTION == type
+
+      def mouse_wheel? = ::SDL2::SDL_MOUSEWHEEL == type
+
+      def quit? = ::SDL2::SDL_QUIT == type
+
+      def render_device_reset? = ::SDL2::SDL_RENDER_DEVICE_RESET == type
+
+      def render_targets_reset? = ::SDL2::SDL_RENDER_TARGETS_RESET == type
+
+      def sensor_update? = ::SDL2::SDL_SENSORUPDATE == type
+
+      def sys_wm_event? = ::SDL2::SDL_SYSWMEVENT == type
+
+      def text_editing? = ::SDL2::SDL_TEXTEDITING == type
+
+      def text_input? = ::SDL2::SDL_TEXTINPUT == type
+
+      def user_event? = USER_EVENT_TYPES === type
+
+      def window_event? = ::SDL2::SDL_WINDOWEVENT == type
+    end
+  end
+end