rb_sdl2 0.1.2 → 0.2.0

data/lib/rb_sdl2/timer.rb

@@ -1,31 +1,36 @@
-module RbSDL2
-  module Timer
-    class << self
-      # ms へ与えたミリ秒だけスレッドを停止します。SDL のタイマーを使用しています。
-      # ms が負の数だった場合 ArgumentError が発生します。
-      def delay(ms)
-        raise ArgumentError if ms < 0
-        ::SDL2.SDL_Delay(ms)
-      end
-
-      # performance_count の 1 秒あたりの増加量を返します。
-      def performance_frequency = ::SDL2.SDL_GetPerformanceFrequency
-
-      # SDL が提供する高精度カウンターの値を返します。
-      # 返ってくる値には意味がありません。精度も SDL の実装や動作環境ごとに違います。
-      def performance_count = ::SDL2.SDL_GetPerformanceCounter
-
-      # 与えられたブロックの実行時間を返します。単位は秒です。
-      # 実行時間の計測に SDL の高精度カウンターを使用しています。
-      def realtime
-        t = performance_count
-        yield
-        (performance_count - t).fdiv(performance_frequency)
-      end
-
-      # SDL が起動してからの経過時間をミリ秒で返します。
-      # SDL のタイマーを使用しており、49日ほどで 0 に戻ります。
-      def ticks = ::SDL2.SDL_GetTicks
-    end
-  end
-end
+module RbSDL2
+  module Timer
+    class << self
+      # ms へ与えたミリ秒だけスレッドを停止します。SDL のタイマーを使用しています。
+      # ms が負の数だった場合 ArgumentError が発生します。
+      # このメソッドは SDL_Init の前に呼び出すことができます。
+      def delay(ms)
+        raise ArgumentError if ms < 0
+        ::SDL.Delay(ms)
+      end
+
+      # performance_count の 1 秒あたりの増加量を返します。
+      def performance_frequency = ::SDL.GetPerformanceFrequency
+
+      # SDL が提供する高精度カウンターの値を返します。
+      # 返ってくる値には意味がありません。精度も SDL の実装や動作環境ごとに違います。
+      # このメソッドは SDL_Init の前に呼び出すことができます。
+      def performance_count = ::SDL.GetPerformanceCounter
+
+      # 与えられたブロックの実行時間を返します。単位は秒です。
+      # 実行時間の計測に SDL の高精度カウンターを使用しています。
+      # このメソッドは SDL_Init の前に呼び出すことができます。
+      def realtime
+        t = performance_count
+        yield
+        (performance_count - t).fdiv(performance_frequency)
+      end
+
+      # SDL が起動してからの経過時間をミリ秒で返します。
+      # このメソッドは SDL_Init の前に呼び出すことができます。
+      # タイマーの開始は SDL_Init を呼ぶか、このメソッドをその前に呼び出したときです。
+      # SDL のタイマーを使用しており、49日ほどで 0 に戻ります。
+      def ticks = ::SDL.GetTicks
+    end
+  end
+end

data/lib/rb_sdl2/version.rb

@@ -2,12 +2,12 @@ module RbSDL2
   module Version
     class << self
       # SDL ライブラリのリビジョンを文字列で返します。
-      def revision = ::SDL2.SDL_GetRevision.read_string
+      def revision = ::SDL.GetRevision.read_string
 
       # SDL ライブラリのバージョン番号を文字列で返します。形式はセマンティックバージョニングです。
       def version
-        st = ::SDL2::SDL_version.new
-        ::SDL2.SDL_GetVersion(st)
+        st = ::SDL::Version.new
+        ::SDL.GetVersion(st)
         "#{st[:major]}.#{st[:minor]}.#{st[:patch]}"
       end
     end

data/lib/rb_sdl2/video.rb

@@ -2,24 +2,36 @@ module RbSDL2
   module Video
     class << self
       def init(driver = nil)
-        raise RbSDL2Error if ::SDL2.SDL_VideoInit(driver) < 0
+        raise RbSDL2Error if ::SDL.VideoInit(driver) < 0
       end
 
       def current
-        ptr = ::SDL2.SDL_GetCurrentVideoDriver
+        ptr = ::SDL.GetCurrentVideoDriver
         raise RbSDL2Error if ptr.null?
         ptr.read_string
       end
 
       def drivers
-        ::SDL2.SDL_GetNumVideoDrivers.times.map do |num|
-          ptr = ::SDL2.SDL_GetVideoDriver(num)
+        ::SDL.GetNumVideoDrivers.times.map do |num|
+          ptr = ::SDL.GetVideoDriver(num)
           raise RbSDL2Error if ptr.null?
           ptr.read_string
         end
       end
 
-      def quit = ::SDL2.SDL_VideoQuit
+      def quit = ::SDL.VideoQuit
+
+      # SDL アプリケーションがスクリーンセーバーの起動を有効にしている場合に true を戻します。
+      # false が戻る場合はスクリーンセーバーの起動が無効です。
+      # SDL アプリケーションが起動している間はスクリーンセーバーが起動しません。
+      def screen_saver? = ::SDL.IsScreenSaverEnabled == ::SDL::TRUE
+
+      # bool に false を与えたときスクリーンセーバーの起動を無効にすることができます。
+      # これは SDL アプリケーション実行中のみシステムに影響を与えます。システムの設定を変更しません。
+      # SDL 2.0.2以降 のデフォルトは false です。
+      def screen_saver=(bool)
+        bool ? ::SDL.EnableScreenSaver : ::SDL.DisableScreenSaver
+      end
     end
   end
 end

data/lib/rb_sdl2/window/accessor.rb

@@ -0,0 +1,135 @@
+module RbSDL2
+  class Window
+    module Accessor
+      def border_size
+        top_left_bottom_right = Array.new(4) { ::FFI::MemoryPointer.new(:int) }
+        err = ::SDL.GetWindowBordersSize(self, *top_left_bottom_right)
+        raise RbSDL2Error if err < 0
+        top_left_bottom_right.map(&:read_int)
+      end
+
+      def height
+        ptr = ::FFI::MemoryPointer.new(:int)
+        ::SDL.GetWindowSize(self, nil, ptr)
+        ptr.read_int
+      end
+      alias h height
+
+      def height=(num)
+        self.size = [w, num]
+      end
+      alias h= height=
+
+      def icon=(surface)
+        ::SDL.SetWindowIcon(self, surface)
+      end
+
+      def maximum_size
+        w_h = Array.new(2) { ::FFI::MemoryPointer.new(:int) }
+        ::SDL.GetWindowMaximumSize(self, *w_h)
+        w_h.map(&:read_int)
+      end
+
+      def maximum_size=(w_h)
+        ::SDL.SetWindowMaximumSize(self, *w_h)
+      end
+
+      def minimum_size
+        w_h = Array.new(2) { ::FFI::MemoryPointer.new(:int) }
+        ::SDL.GetWindowMinimumSize(self, *w_h)
+        w_h.map(&:read_int)
+      end
+
+      def minimum_size=(w_h)
+        ::SDL.SetWindowMinimumSize(self, *w_h)
+      end
+
+      # 戻り値が nil の場合は範囲が設定されていません。
+      def mouse_rect
+        ptr = ::SDL.GetWindowMouseRect(self)
+        ptr.null? ? nil : Rect.to_ary(ptr)
+      end
+
+      # 範囲を破棄する場合は rect には nil を与えます。
+      def mouse_rect=(rect)
+        err = ::SDL.SetWindowMouseRect(self, rect && Rect.new(*rect))
+        raise RbSDL2Error if err < 0
+      end
+
+      # ウィンドウの透明度を戻す。値は 0.0 から 1.0。値が低いほど透明になる。
+      def opacity
+        out_opacity = ::FFI::MemoryPointer.new(:float)
+        err = ::SDL.GetWindowOpacity(self, out_opacity)
+        raise RbSDL2Error if err < 0
+        out_opacity.read_float
+      end
+
+      # ウィンドウの透明度を変更する。値は 0.0 から 1.0。値が低いほど透明になる。
+      def opacity=(val)
+        err = ::SDL.SetWindowOpacity(self, val)
+        raise RbSDL2Error if err < 0
+      end
+
+      def position
+        x_y = Array.new(2) { ::FFI::MemoryPointer.new(:int) }
+        ::SDL.GetWindowPosition(self, *x_y)
+        x_y.map(&:read_int)
+      end
+
+      def position=(x_y)
+        wx, wy = x_y
+        ::SDL.SetWindowPosition(self,
+                                wx || SDL_WINDOWPOS_CENTERED_MASK,
+                                wy || SDL_WINDOWPOS_CENTERED_MASK)
+      end
+
+      def size
+        w_h = Array.new(2) { ::FFI::MemoryPointer.new(:int) }
+        ::SDL.GetWindowSize(self, *w_h)
+        w_h.map(&:read_int)
+      end
+
+      def size=(w_h)
+        ::SDL.SetWindowSize(self, *w_h)
+      end
+
+      def title = SDL.ptr_to_str(::SDL.GetWindowTitle(self))
+
+      def title=(s)
+        ::SDL.SetWindowTitle(self, SDL.str_to_sdl(s))
+      end
+
+      def width
+        ptr = ::FFI::MemoryPointer.new(:int)
+        ::SDL.GetWindowSize(self, ptr, nil)
+        ptr.read_int
+      end
+      alias w width
+
+      def width=(num)
+        self.size = [num, h]
+      end
+      alias w= width=
+
+      def x
+        ptr = ::FFI::MemoryPointer.new(:int)
+        ::SDL.GetWindowPosition(self, ptr, nil)
+        ptr.read_int
+      end
+
+      def x=(num)
+        self.position = [num, y]
+      end
+
+      def y
+        ptr = ::FFI::MemoryPointer.new(:int)
+        ::SDL.GetWindowPosition(self, nil, ptr)
+        ptr.read_int
+      end
+
+      def y=(num)
+        self.position = [x, num]
+      end
+    end
+  end
+end

data/lib/rb_sdl2/window/display.rb

@@ -3,10 +3,10 @@ module RbSDL2
     module Display
       # Brightness はウィンドウ単体ではなくウインドウの中心があるディスプレイの輝度の取得、変更を行う。
       # 対象となるディスプレイの取得は Window＃display メソッドを呼び出す。
-      def brightness = ::SDL2.SDL_GetWindowBrightness(self)
+      def brightness = ::SDL.GetWindowBrightness(self)
 
       def brightness=(float)
-        err = ::SDL2.SDL_SetWindowBrightness(self, float)
+        err = ::SDL.SetWindowBrightness(self, float)
         raise RbSDL2Error if err < 0
       end
 
@@ -15,7 +15,7 @@ module RbSDL2
       def display = Display.new(display_index)
 
       def display_index
-        index = ::SDL2.SDL_GetWindowDisplayIndex(to_ptr)
+        index = ::SDL.GetWindowDisplayIndex(to_ptr)
         raise RbSDL2Error if index < 0
         index
       end
@@ -23,13 +23,13 @@ module RbSDL2
       require_relative '../display_mode'
       def fullscreen_display_mode
         obj = DisplayMode.new
-        err = ::SDL2.SDL_GetWindowDisplayMode(self, obj)
+        err = ::SDL.GetWindowDisplayMode(self, obj)
         raise RbSDL2Error if err < 0
         obj
       end
 
       def fullscreen_display_mode=(display_mode)
-        err = ::SDL2.SDL_SetWindowDisplayMode(self, display_mode)
+        err = ::SDL.SetWindowDisplayMode(self, display_mode)
         raise RbSDL2Error if err < 0
       end
 
@@ -45,7 +45,7 @@ module RbSDL2
 
           def new(gamma)
             ptr = ::FFI::MemoryPointer.new(:uint16, 256)
-            ::SDL2.SDL_CalculateGammaRamp(gamma, ptr)
+            ::SDL.CalculateGammaRamp(gamma, ptr)
             super(ptr)
           end
         end
@@ -68,7 +68,7 @@ module RbSDL2
 
       def gamma_ramp
         rgb = Array.new(3) { GammaRamp.new }
-        err = ::SDL2.SDL_GetWindowGammaRamp(self, *rgb)
+        err = ::SDL.GetWindowGammaRamp(self, *rgb)
         raise RbSDL2Error if err < 0
         rgb.map(&:to_a)
       end
@@ -77,7 +77,7 @@ module RbSDL2
       # 画面全体に影響を与える。OSからリセットされることもある。
       # アプリケーションが終了しても永続的に影響をあたえる。ユーザにとって望ましくないだろう。
       def gamma_ramp=(r_g_b)
-        err = ::SDL2.SDL_SetWindowGammaRamp(self, *r_g_b.map { |a| GammaRamp[*a] })
+        err = ::SDL.SetWindowGammaRamp(self, *r_g_b.map { |a| GammaRamp[*a] })
         raise RbSDL2Error if err < 0
       end
     end

data/lib/rb_sdl2/window/flash.rb

@@ -0,0 +1,22 @@
+module RbSDL2
+  class Window
+    module Flash
+      SDL_FLASH_CANCEL = 0
+      SDL_FLASH_BRIEFLY = 1
+      SDL_FLASH_UNTIL_FOCUSED = 2
+
+      def flash(bool = true)
+        operation = bool ? SDL_FLASH_UNTIL_FOCUSED : SDL_FLASH_CANCEL
+        err = ::SDL.FlashWindow(self, operation)
+        raise RbSDL2Error if err < 0
+        bool
+      end
+
+      def flash!
+        err = ::SDL.FlashWindow(self, SDL_FLASH_BRIEFLY)
+        raise RbSDL2Error if err < 0
+        self
+      end
+    end
+  end
+end

data/lib/rb_sdl2/window/hit_test.rb

@@ -1,50 +1,29 @@
 module RbSDL2
   class Window
-    class HitTest < ::FFI::Function
-      @callbacks = {}
-      @mutex = Mutex.new
-
-      class << self
-        def callback_set(window, obj, userdata = nil)
-          func = if Proc === obj
-                   new(&obj)
-                 else
-                   obj
-                 end
-          @mutex.synchronize do
-            err = ::SDL2.SDL_SetWindowHitTest(window, func, userdata)
-            raise RbSDL2Error if err < 0
-            id = window.id
-            if obj
-              @callbacks[id] = [func, userdata]
-            else
-              @callbacks.delete(id)
-            end
-          end
-          [obj, userdata]
-        end
-      end
-
-      HIT_TEST_RESULT = Hash.new(::SDL2::SDL_HITTEST_NORMAL).merge!(
-        :normal => ::SDL2::SDL_HITTEST_NORMAL,
-        :draggable => ::SDL2::SDL_HITTEST_DRAGGABLE,
-        :top_left => ::SDL2::SDL_HITTEST_RESIZE_TOPLEFT,
-        :top => ::SDL2::SDL_HITTEST_RESIZE_TOP,
-        :top_right => ::SDL2::SDL_HITTEST_RESIZE_TOPRIGHT,
-        :resize_right => ::SDL2::SDL_HITTEST_RESIZE_RIGHT,
-        :bottom_right => ::SDL2::SDL_HITTEST_RESIZE_BOTTOMRIGHT,
-        :bottom => ::SDL2::SDL_HITTEST_RESIZE_BOTTOM,
-        :bottom_left => ::SDL2::SDL_HITTEST_RESIZE_BOTTOMLEFT,
-        :resize_left => ::SDL2::SDL_HITTEST_RESIZE_LEFT,
-      ).freeze
+    SDL_HITTEST_NORMAL             = 0
+    SDL_HITTEST_DRAGGABLE          = 1
+    SDL_HITTEST_RESIZE_TOPLEFT     = 2
+    SDL_HITTEST_RESIZE_TOP         = 3
+    SDL_HITTEST_RESIZE_TOPRIGHT    = 4
+    SDL_HITTEST_RESIZE_RIGHT       = 5
+    SDL_HITTEST_RESIZE_BOTTOMRIGHT = 6
+    SDL_HITTEST_RESIZE_BOTTOM      = 7
+    SDL_HITTEST_RESIZE_BOTTOMLEFT  = 8
+    SDL_HITTEST_RESIZE_LEFT        = 9
 
-      def initialize(&block)
-        # typedef SDL_HitTestResult (*SDL_HitTest)(SDL_Window *win,
-        #                                          const SDL_Point *area, void *data);
-        super(:int, [:pointer, :pointer, :pointer]) do |win, area, _data|
+    class HitTest < ::FFI::Function
+      # proc には引数を１つ取るコーラブル・オブジェクトを与えます。
+      # コーラブル・オブジェクトの引数に与えられる値はウィンドウのクリックされた位置を表す配列（[x, y]）です。
+      # コールバックは整数を戻す必要があります。何もしないのであれば SDL_HITTEST_NORMAL を戻します。
+      # 詳しくは SDL_HitTestResult 列挙体を参照してください。
+      # コールバックを呼び出したウィンドウの情報を受け取ることはできません。
+      # コーラブル・オブジェクトに対応するウィンドウ・オブジェクトを取り込むことで同じことができます。
+      def initialize(proc)
+        # SDL_HitTestResult SDL_HitTest(SDL_Window* win, const SDL_Point* area, void* data)
+        super(:int, [:pointer, :pointer, :pointer]) do |_win, area, _data|
           # コールバック実行終了を OS が待つようなので、与えらえた window ポインターは有効なものとしてよいだろう。
-          # area には SDL_Point のアドレスが入る。SDL_Point は x, y の２つの int 型メンバーである。
-          HIT_TEST_RESULT[yield(Window.to_ptr(win), ::SDL2::SDL_Point.new(area).values)]
+          # area には Point のアドレスが入る。Point は x, y の２つの int 型メンバーである。
+          proc.call(::SDL::Point.new(area).values)
         end
       end
     end

data/lib/rb_sdl2/window/shape.rb

@@ -1,65 +1,80 @@
 module RbSDL2
   class Window
     module Shape
+
+      class WindowShapeMode < ::SDL::WindowShapeMode
+        def alpha_test = self[:parameters][:binarizationCutoff]
+
+        def alpha_test? = [::SDL::ShapeModeBinarizeAlpha, ::SDL::ShapeModeDefault].include?(mode)
+
+        def alpha_test=(num)
+          self[:parameters][:binarizationCutoff] = num
+        end
+
+        def color_key = self[:parameters][:colorKey].values.first(3)
+
+        def color_key? = ::SDL::ShapeModeColorKey == mode
+
+        def color_key=(color)
+          self[:parameters][:colorKey].tap { |c| c[:r], c[:g], c[:b] = color }
+        end
+
+        def mode = self[:mode]
+
+        def mode=(num)
+          self[:mode] = num
+        end
+
+        def reverse_alpha_test? = ::SDL::ShapeModeReverseBinarizeAlpha == mode
+      end
+
       private def shape_mode
-        mode = ::SDL2::SDL_WindowShapeMode.new
-        num = ::SDL2.SDL_GetShapedWindowMode(self, mode)
-        # SDL_GetShapedWindowMode は SDL_INVALID_SHAPE_ARGUMENT を返すことはない。
-        if num == ::SDL2::SDL_NONSHAPEABLE_WINDOW
+        mode = WindowShapeMode.new
+        err = ::SDL.GetShapedWindowMode(self, mode)
+        # GetShapedWindowMode は INVALID_SHAPE_ARGUMENT を返すことはない。
+        if err == ::SDL::NONSHAPEABLE_WINDOW
           raise RbSDL2Error, "unshaped window"
-        elsif num == ::SDL2::SDL_WINDOW_LACKS_SHAPE
+        elsif err == ::SDL::WINDOW_LACKS_SHAPE
           raise RbSDL2Error, "window lacks shape"
-        elsif num < 0
+        elsif err < 0
           raise RbSDL2Error
         end
         mode
       end
 
-      def alpha_test
-        shape_mode[:parameters][:binarizationCutoff] unless shaped? && color_key?
-      end
+      def alpha_test = shaped? && alpha_test? ? shape_mode.alpha_test : nil
 
-      def alpha_test?
-        shaped? && [::SDL2::ShapeModeBinarizeAlpha,
-                    ::SDL2::ShapeModeDefault].include?(shape_mode[:mode])
-      end
+      def alpha_test? = shaped? && shape_mode.alpha_test?
 
-      def color_key
-        shape_mode[:parameters][:colorKey].values if shaped? && color_key?
-      end
+      def color_key = shaped? && color_key? ? shape_mode.color_key : nil
 
-      def color_key?
-        shaped? && ::SDL2::ShapeModeColorKey == shape_mode[:mode]
-      end
+      def color_key? = shaped? && shape_mode.color_key?
 
-      def reverse_alpha_test?
-        shaped? && ::SDL2::ShapeModeReverseBinarizeAlpha == shape_mode[:mode]
-      end
+      def reverse_alpha_test? = shaped? && shape_mode.reverse_alpha_test?
 
       # サーフェスにアルファ―チャンネルが含まれていない場合、color_key オプションを与える必要がある。
       # 形状マスクの設定を行う。ウィンドウの描画域は透明なピクセルで埋められている。
       # このメソッド呼び出しの成功後にウィンドウのサーフェスへ描画を行う必要がある。
       # 描画方法はウィンドウのサーフェスまたはレンダラーのどちらを使用してもよい。
       def shape_set(surface, alpha_test: nil, color_key: nil)
-        mode = ::SDL2::SDL_WindowShapeMode.new.tap do |st|
-          st[:mode] = if color_key
-                        st[:parameters][:colorKey].tap { |c| c[:r], c[:g], c[:b] = color_key }
-                        ::SDL2::ShapeModeColorKey
-                      elsif alpha_test&.>= 0
-                        st[:parameters][:binarizationCutoff] = alpha_test
-                        ::SDL2::ShapeModeBinarizeAlpha
-                      elsif alpha_test&.< 0
-                        st[:parameters][:binarizationCutoff] = alpha_test.abs
-                        ::SDL2::ShapeModeReverseBinarizeAlpha
-                      else
-                        ::SDL2::ShapeModeDefault
-                      end
+        shape = WindowShapeMode.new
+        if color_key
+          shape.mode = ::SDL::ShapeModeColorKey
+          shape.color_key = color_key
+        elsif alpha_test&.>= 0
+          shape.mode = ::SDL::ShapeModeBinarizeAlpha
+          shape.alpha_test = alpha_test
+        elsif alpha_test&.< 0
+          shape.mode = ::SDL::ShapeModeReverseBinarizeAlpha
+          shape.alpha_test = alpha_test.abs
+        else
+          shape.mode = ::SDL::ShapeModeDefault
         end
-        err = ::SDL2.SDL_SetWindowShape(self, surface, mode)
-        # SDL_SetWindowShape は SDL_WINDOW_LACKS_SHAPE を返すことはない。
-        if err == ::SDL2::SDL_NONSHAPEABLE_WINDOW
+        err = ::SDL.SetWindowShape(self, surface, shape)
+        # SetWindowShape は WINDOW_LACKS_SHAPE を返すことはない。
+        if err == ::SDL::NONSHAPEABLE_WINDOW
           raise RbSDL2Error, "unshaped window"
-        elsif err == ::SDL2::SDL_INVALID_SHAPE_ARGUMENT
+        elsif err == ::SDL::INVALID_SHAPE_ARGUMENT
           raise RbSDL2Error,
                 "Invalid shape argument. \
 The size of the window and the size of the surface do not match. \
@@ -70,7 +85,7 @@ Or the color key is not specified in the surface without alpha channel."
         surface
       end
 
-      def shaped? = ::SDL2.SDL_IsShapedWindow(self) == ::SDL2::SDL_TRUE
+      def shaped? = ::SDL.IsShapedWindow(self) == ::SDL::TRUE
     end
   end
 end