ruby-sfml 3.0.0.7 → 3.0.0.8

data/lib/sfml/window/event.rb

@@ -17,28 +17,38 @@ module SFML
     # extra1, extra2. (CSFML 2 called the last two x_button1/x_button2,
     # but SFML 3 dropped the X-button terminology.)
     MOUSE_BUTTONS = %i[left right middle extra1 extra2].freeze
+    # Mouse wheel axes — `:vertical` / `:horizontal`.
     MOUSE_WHEELS  = %i[vertical horizontal].freeze
 
+    # The type, data components.
     attr_reader :type, :data
 
+    # Build directly (rare — `Event.from_native` is the usual path).
     def initialize(type, data = {})
       @type = type
       @data = data.freeze
       freeze
     end
 
+    # Hash-style lookup into the event payload.
     def [](key)        = @data[key]
+    # Hash-style fetch with the standard fallback / block behaviour.
     def fetch(*args, &) = @data.fetch(*args, &)
 
+    # Pattern-match hook — flattens `{type:, ...payload}` into one
+    # hash so callers can write `in {type: :key_pressed, code:}`.
     def deconstruct_keys(_keys)
       { type: @type, **@data }
     end
 
-    # `true` if respond to missing.
+    # `respond_to?` answer for payload keys — keeps `#method_missing`
+    # safe under introspection.
     def respond_to_missing?(name, _private = false)
       @data.key?(name) || super
     end
 
+    # Payload keys are exposed as method calls so `event.code` works
+    # alongside `event[:code]`.
     def method_missing(name, *args)
       return @data[name] if args.empty? && @data.key?(name)
       super
@@ -60,6 +70,7 @@ module SFML
       new(type_sym, data)
     end
 
+    # Returns the self.
     def self.decode(type_sym, ptr)
       case type_sym
       when :closed, :focus_lost, :focus_gained,
@@ -143,6 +154,7 @@ module SFML
       end
     end
 
+    # Frozen empty Hash — shared default for missing event payloads.
     EMPTY = {}.freeze
     private_constant :EMPTY
   end

data/lib/sfml/window/joystick.rb

@@ -34,6 +34,7 @@ module SFML
       C::Window.sfJoystick_isConnected(_id(joystick))
     end
 
+    # Returns the button count.
     def button_count(joystick)
       C::Window.sfJoystick_getButtonCount(_id(joystick))
     end

data/lib/sfml/window/keyboard.rb

@@ -14,6 +14,7 @@ module SFML
   # The KEY_CODES / SCAN_CODES arrays are load-bearing: order matches
   # the sfKeyCode / sfScancode enums in CSFML/Window/Keyboard.h.
   module Keyboard
+    # All key symbols in CSFML `sfKeyCode` enum order.
     KEY_CODES = %i[
       a b c d e f g h i j k l m n o p q r s t u v w x y z
       num0 num1 num2 num3 num4 num5 num6 num7 num8 num9
@@ -33,6 +34,7 @@ module SFML
       pause
     ].freeze
 
+    # Key symbol → integer code Hash.
     SYMBOL_TO_CODE = KEY_CODES.each_with_index.to_h.freeze
 
     # Matches sfScancode in CSFML/Window/Keyboard.h exactly.
@@ -68,6 +70,7 @@ module SFML
       scan_launch_application1 scan_launch_application2 scan_launch_mail scan_launch_media_select
     ].freeze
 
+    # Scancode symbol → integer code Hash.
     SCAN_SYMBOL_TO_CODE = SCAN_CODES.each_with_index.to_h.freeze
 
     # Friendly aliases users might reach for naturally.
@@ -83,11 +86,13 @@ module SFML
 
     module_function
 
+    # Returns the code to symbol.
     def code_to_symbol(code)
       return :unknown if code < 0 || code >= KEY_CODES.length
       KEY_CODES[code]
     end
 
+    # Returns the symbol to code.
     def symbol_to_code(symbol)
       symbol = ALIASES.fetch(symbol, symbol)
       SYMBOL_TO_CODE.fetch(symbol) do
@@ -96,11 +101,13 @@ module SFML
       end
     end
 
+    # Returns the scancode to symbol.
     def scancode_to_symbol(code)
       return :scan_unknown if code < 0 || code >= SCAN_CODES.length
       SCAN_CODES[code]
     end
 
+    # Returns the symbol to scancode.
     def symbol_to_scancode(symbol)
       SCAN_SYMBOL_TO_CODE.fetch(symbol) do
         raise ArgumentError, "Unknown scancode symbol: #{symbol.inspect}. " \

data/lib/sfml/window/mouse.rb

@@ -11,7 +11,9 @@ module SFML
   # Buttons are addressed by symbol; the raw sfMouseButton enum order is
   # exposed via BUTTONS for users who need it.
   module Mouse
+    # Recognised button symbols.
     BUTTONS = %i[left right middle extra1 extra2].freeze
+    # Symbol → integer index for each button.
     BUTTON_INDEX = BUTTONS.each_with_index.to_h.freeze
 
     # Friendly aliases — SFML 2 used "X-button" terminology; some users

data/lib/sfml/window/sensor.rb

@@ -17,7 +17,9 @@ module SFML
   # Sensor data also surfaces through the event loop as
   # `{type: :sensor_changed, sensor: :accelerometer, value: Vector3}`.
   module Sensor
+    # Recognised type symbols.
     TYPES       = C::Window::SENSOR_TYPES
+    # Type symbol → integer index Hash.
     TYPE_INDEX  = TYPES.each_with_index.to_h.freeze
 
     module_function
@@ -27,14 +29,17 @@ module SFML
       C::Window.sfSensor_isAvailable(_index(type))
     end
 
+    # Returns the enable.
     def enable(type)
       C::Window.sfSensor_setEnabled(_index(type), true)
     end
 
+    # Returns the disable.
     def disable(type)
       C::Window.sfSensor_setEnabled(_index(type), false)
     end
 
+    # Returns the value.
     def value(type)
       v = C::Window.sfSensor_getValue(_index(type))
       Vector3.new(v[:x], v[:y], v[:z])

data/lib/sfml/window/video_mode.rb

@@ -4,6 +4,7 @@ module SFML
   #   SFML::VideoMode.new(800, 600)
   #   SFML::VideoMode.desktop_mode
   class VideoMode
+    # The width, height, bits per pixel components.
     attr_reader :width, :height, :bits_per_pixel
 
     def initialize(width, height, bits_per_pixel = 32)
@@ -13,6 +14,7 @@ module SFML
       freeze
     end
 
+    # Returns the self.
     def self.desktop_mode
       from_native(C::Window.sfVideoMode_getDesktopMode)
     end
@@ -46,10 +48,12 @@ module SFML
     def to_s = "#<SFML::VideoMode #{@width}x#{@height}@#{@bits_per_pixel}>"
     alias inspect to_s
 
+    # Returns the self.
     def self.from_native(struct) # :nodoc:
       new(struct[:size][:x], struct[:size][:y], struct[:bits_per_pixel])
     end
 
+    # Returns the to native.
     def to_native # :nodoc:
       C::Window::VideoMode.new.tap do |m|
         m[:size][:x] = @width

data/lib/sfml/window/window.rb

@@ -20,8 +20,11 @@ module SFML
   #     win.display
   #   end
   class Window
+    # Default window style bitmask.
     DEFAULT_STYLE = C::Window::Style::DEFAULT
 
+    # Construct a Window. Same constructor forms as `RenderWindow.new`
+    # (`(w, h, title, **opts)` or `(video_mode, title, **opts)`).
     def initialize(*args, **opts)
       mode, title = parse_args(args)
       style = opts.fetch(:style, DEFAULT_STYLE)
@@ -43,16 +46,20 @@ module SFML
       self.vsync = opts[:vsync]               unless opts[:vsync].nil?
     end
 
-    # `true` if open.
+    # `true` while the window is alive (not closed by `#close` or
+    # the user).
     def open?
       C::Window.sfWindow_isOpen(@handle)
     end
 
+    # Close the window.
     def close
       C::Window.sfWindow_close(@handle)
       self
     end
 
+    # Swap front/back buffers, presenting whatever was rendered
+    # since the last call.
     def display
       C::Window.sfWindow_display(@handle)
       self
@@ -64,6 +71,8 @@ module SFML
       Event.from_native(@event_buffer)
     end
 
+    # Yields each pending event then returns. Without a block,
+    # returns an Enumerator.
     def each_event
       return enum_for(:each_event) unless block_given?
       while (event = poll_event)
@@ -77,6 +86,7 @@ module SFML
       C::Window.sfWindow_setTitle(@handle, value.to_s)
     end
 
+    # Current window size as a `Vector2`.
     def size
       v = C::Window.sfWindow_getSize(@handle)
       Vector2.new(v[:x], v[:y])
@@ -90,6 +100,7 @@ module SFML
       C::Window.sfWindow_setSize(@handle, v)
     end
 
+    # Window top-left in desktop coordinates.
     def position
       v = C::Window.sfWindow_getPosition(@handle)
       Vector2.new(v[:x], v[:y])
@@ -123,6 +134,8 @@ module SFML
       C::Window.sfWindow_setKeyRepeatEnabled(@handle, value ? true : false)
     end
 
+    # Ask the OS to give this window focus. Cooperative — most
+    # window managers will defer until the user clicks.
     def request_focus
       C::Window.sfWindow_requestFocus(@handle)
     end
@@ -140,6 +153,8 @@ module SFML
 
     # ---- Mouse cursor ----
 
+    # Apply a `SFML::Cursor` as the visible mouse pointer over this
+    # window. Keeps a Ruby reference so the Cursor outlives the call.
     def cursor=(cursor)
       raise ArgumentError, "Window#cursor= requires a SFML::Cursor" unless cursor.is_a?(Cursor)
       C::Window.sfWindow_setMouseCursor(@handle, cursor.handle)
@@ -158,6 +173,8 @@ module SFML
 
     # ---- Misc state ----
 
+    # Dead-zone for joystick axis events in [0, 100]. Axes whose
+    # absolute value is below this are reported as 0.
     def joystick_threshold=(value)
       C::Window.sfWindow_setJoystickThreshold(@handle, Float(value))
     end
@@ -240,6 +257,7 @@ module SFML
       v
     end
 
+    # Returns the parse args.
     def parse_args(args)
       case args.length
       when 2

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-sfml
 version: !ruby/object:Gem::Version
-  version: 3.0.0.7
+  version: 3.0.0.8
 platform: ruby
 authors:
 - Mykhailo Melnyk