ruby-sfml 3.0.0.6 → 3.0.0.7

data/lib/sfml/system/vector3.rb

@@ -1,10 +1,16 @@
 module SFML
-  # 3D vector with float components. Mirrors Vector2's surface.
+  # 3D vector with float components. Mirrors Vector2's surface — same
+  # arithmetic, same coerce trick for `2 * v`, same pattern-match
+  # support. Used by the 3D-audio API (`Sound#position`, `Listener`,
+  # …) and as a back-end for `Image` size hints.
   class Vector3
     attr_reader :x, :y, :z
 
+    # Compact constructor: `Vector3[1, 2, 3]`.
     def self.[](x, y, z) = new(x, y, z)
-    def self.zero        = new(0, 0, 0)
+
+    # The (0, 0, 0) vector.
+    def self.zero = new(0, 0, 0)
 
     def initialize(x = 0, y = 0, z = 0)
       @x = x
@@ -13,29 +19,44 @@ module SFML
       freeze
     end
 
+    # Component-wise addition.
     def +(other) = Vector3.new(@x + other.x, @y + other.y, @z + other.z)
+    # Component-wise subtraction.
     def -(other) = Vector3.new(@x - other.x, @y - other.y, @z - other.z)
+    # Multiply every component by `scalar`.
     def *(scalar) = Vector3.new(@x * scalar, @y * scalar, @z * scalar)
+    # Divide every component by `scalar` (promotes to Float).
     def /(scalar) = Vector3.new(@x / scalar.to_f, @y / scalar.to_f, @z / scalar.to_f)
+    # Negate every component.
     def -@ = Vector3.new(-@x, -@y, -@z)
 
+    # Value equality — all three components must match.
     def ==(other)
       other.is_a?(Vector3) && @x == other.x && @y == other.y && @z == other.z
     end
     alias eql? ==
+    # Hash key support.
     def hash = [@x, @y, @z].hash
 
+    # Euclidean length √(x² + y² + z²). Prefer `length_sq` for
+    # comparisons to skip the square root.
     def length    = Math.sqrt(length_sq)
+    # Squared length (x² + y² + z²) — faster than `length` when you
+    # only need to compare magnitudes.
     def length_sq = (@x * @x) + (@y * @y) + (@z * @z)
 
+    # Unit vector in the same direction. Zero vector returns itself
+    # unchanged.
     def normalize
       len = length
       return Vector3.zero if len.zero?
       self / len
     end
 
+    # Scalar dot product.
     def dot(other) = (@x * other.x) + (@y * other.y) + (@z * other.z)
 
+    # 3D cross product (vector perpendicular to both).
     def cross(other)
       Vector3.new(
         (@y * other.z) - (@z * other.y),
@@ -50,9 +71,13 @@ module SFML
       [self, other]
     end
 
+    # Euclidean distance between two points — accepts Vector3 or
+    # `[x, y, z]`.
     def distance(other)    = (self - _coerce(other)).length
+    # Squared distance (skip the square root) for comparisons.
     def distance_sq(other) = (self - _coerce(other)).length_sq
 
+    # Linear interpolation toward `other` at parameter `t` ∈ [0, 1].
     def lerp(other, t)
       o = _coerce(other)
       Vector3.new(@x + (o.x - @x) * t, @y + (o.y - @y) * t, @z + (o.z - @z) * t)
@@ -69,6 +94,7 @@ module SFML
       Math.acos(cos)
     end
 
+    # Vector projection of `self` onto `other`.
     def project_on(other)
       o = _coerce(other)
       d = o.length_sq
@@ -76,11 +102,15 @@ module SFML
       o * (dot(o) / d)
     end
 
+    # Reflect this vector across the plane defined by `normal`.
+    # `normal` should be unit-length.
     def reflect(normal)
       n = _coerce(normal)
       self - (n * (2 * dot(n)))
     end
 
+    # Clamp the magnitude into [min_len, max_len]. Either bound may
+    # be `nil` to leave that side unclamped.
     def clamp_length(min_len = nil, max_len)
       len = length
       return self if len.zero?
@@ -93,15 +123,28 @@ module SFML
       self * (target / len)
     end
 
+    # `true` iff all three components are zero.
     def zero? = @x.zero? && @y.zero? && @z.zero?
+
+    # Per-component absolute value.
     def abs   = Vector3.new(@x.abs, @y.abs, @z.abs)
+
+    # Drop the z component → Vector2.
     def to_v2 = Vector2.new(@x, @y)
 
+    # As `[x, y, z]`.
     def to_a = [@x, @y, @z]
+
+    # As `{x:, y:, z:}`.
     def to_h = { x: @x, y: @y, z: @z }
+
+    # Pattern-match support for `in [x, y, z]`.
     def deconstruct = [@x, @y, @z]
+
+    # Pattern-match support for `in {x:, y:, z:}`.
     def deconstruct_keys(_keys) = { x: @x, y: @y, z: @z }
 
+    # String representation for debugging.
     def to_s = "Vector3(#{@x}, #{@y}, #{@z})"
     alias inspect to_s
 

data/lib/sfml/version.rb

@@ -15,5 +15,5 @@ module SFML
   #   "3.0.1.0"  — CSFML 3.0.1 ships, we re-cut from upstream
   #   "3.0.1.1"  — our patch on top of CSFML 3.0.1
   #   "3.1.0.0"  — CSFML 3.1.0 ships, we add new bindings
-  VERSION = "3.0.0.6"
+  VERSION = "3.0.0.7"
 end

data/lib/sfml/window/clipboard.rb

@@ -26,6 +26,7 @@ module SFML
       codepoints.pack("U*")
     end
 
+    # Set the text.
     def text=(value)
       str = value.to_s.encode("UTF-8")
       cps = str.unpack("U*")

data/lib/sfml/window/context_settings.rb

@@ -89,6 +89,7 @@ module SFML
     end
     alias eql? ==
 
+    # Returns the hash.
     def hash = [@depth_bits, @stencil_bits, @antialiasing,
                 @major_version, @minor_version, @attribute_flags,
                 @srgb_capable].hash

data/lib/sfml/window/event.rb

@@ -34,6 +34,7 @@ module SFML
       { type: @type, **@data }
     end
 
+    # `true` if respond to missing.
     def respond_to_missing?(name, _private = false)
       @data.key?(name) || super
     end
@@ -43,6 +44,7 @@ module SFML
       super
     end
 
+    # String representation for debugging.
     def to_s = "#<SFML::Event #{@type} #{@data.inspect}>"
     alias inspect to_s
 

data/lib/sfml/window/joystick.rb

@@ -29,6 +29,7 @@ module SFML
 
     module_function
 
+    # `true` if connected.
     def connected?(joystick)
       C::Window.sfJoystick_isConnected(_id(joystick))
     end
@@ -37,6 +38,7 @@ module SFML
       C::Window.sfJoystick_getButtonCount(_id(joystick))
     end
 
+    # `true` if has axis.
     def has_axis?(joystick, axis)
       C::Window.sfJoystick_hasAxis(_id(joystick), _axis_code(axis))
     end
@@ -48,6 +50,7 @@ module SFML
       C::Window.sfJoystick_getAxisPosition(_id(joystick), _axis_code(axis))
     end
 
+    # `true` if button pressed.
     def button_pressed?(joystick, button)
       C::Window.sfJoystick_isButtonPressed(_id(joystick), Integer(button))
     end

data/lib/sfml/window/sensor.rb

@@ -22,6 +22,7 @@ module SFML
 
     module_function
 
+    # `true` if available.
     def available?(type)
       C::Window.sfSensor_isAvailable(_index(type))
     end

data/lib/sfml/window/video_mode.rb

@@ -39,8 +39,10 @@ module SFML
       C::Window.sfVideoMode_isValid(to_native)
     end
 
+    # Returns the size.
     def size = Vector2.new(@width, @height)
 
+    # String representation for debugging.
     def to_s = "#<SFML::VideoMode #{@width}x#{@height}@#{@bits_per_pixel}>"
     alias inspect to_s
 

data/lib/sfml/window/window.rb

@@ -43,6 +43,7 @@ module SFML
       self.vsync = opts[:vsync]               unless opts[:vsync].nil?
     end
 
+    # `true` if open.
     def open?
       C::Window.sfWindow_isOpen(@handle)
     end
@@ -71,6 +72,7 @@ module SFML
       self
     end
 
+    # Set the title.
     def title=(value)
       C::Window.sfWindow_setTitle(@handle, value.to_s)
     end
@@ -80,6 +82,7 @@ module SFML
       Vector2.new(v[:x], v[:y])
     end
 
+    # Set the size.
     def size=(value)
       vec = value.is_a?(Vector2) ? value : Vector2.new(*value)
       v = C::System::Vector2u.new
@@ -92,6 +95,7 @@ module SFML
       Vector2.new(v[:x], v[:y])
     end
 
+    # Set the position.
     def position=(value)
       vec = value.is_a?(Vector2) ? value : Vector2.new(*value)
       v = C::System::Vector2i.new
@@ -99,18 +103,22 @@ module SFML
       C::Window.sfWindow_setPosition(@handle, v)
     end
 
+    # Set the visible.
     def visible=(value)
       C::Window.sfWindow_setVisible(@handle, value ? true : false)
     end
 
+    # Set the framerate limit.
     def framerate_limit=(value)
       C::Window.sfWindow_setFramerateLimit(@handle, Integer(value))
     end
 
+    # Set the vsync.
     def vsync=(enabled)
       C::Window.sfWindow_setVerticalSyncEnabled(@handle, enabled ? true : false)
     end
 
+    # Set the key repeat enabled.
     def key_repeat_enabled=(value)
       C::Window.sfWindow_setKeyRepeatEnabled(@handle, value ? true : false)
     end
@@ -119,6 +127,7 @@ module SFML
       C::Window.sfWindow_requestFocus(@handle)
     end
 
+    # `true` if focused.
     def focused?
       C::Window.sfWindow_hasFocus(@handle)
     end
@@ -137,10 +146,12 @@ module SFML
       @cursor = cursor   # keep alive
     end
 
+    # Set the cursor visible.
     def cursor_visible=(visible)
       C::Window.sfWindow_setMouseCursorVisible(@handle, visible ? true : false)
     end
 
+    # Set the cursor grabbed.
     def cursor_grabbed=(grabbed)
       C::Window.sfWindow_setMouseCursorGrabbed(@handle, grabbed ? true : false)
     end
@@ -187,6 +198,7 @@ module SFML
       C::Window.sfWindow_setMinimumSize(@handle, _vec2u_or_nil(value))
     end
 
+    # Set the maximum size.
     def maximum_size=(value)
       C::Window.sfWindow_setMaximumSize(@handle, _vec2u_or_nil(value))
     end

data/ruby-sfml.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"]      = spec.homepage
   spec.metadata["source_code_uri"]   = spec.homepage
   spec.metadata["bug_tracker_uri"]   = "#{spec.homepage}/issues"
-  spec.metadata["documentation_uri"] = "https://www.rubydoc.info/gems/#{spec.name}"
+  spec.metadata["documentation_uri"] = "https://ruby-sfml-doc.netlify.app/"
   spec.metadata["changelog_uri"]     = "#{spec.homepage}/blob/main/CHANGELOG.md"
 
   spec.files = Dir[
@@ -25,7 +25,11 @@ Gem::Specification.new do |spec|
     "README.md",
     "CHANGELOG.md",
     "LICENSE.txt",
-    "ruby-sfml.gemspec"
+    "ruby-sfml.gemspec",
+    # Shipping .rdoc_options means the docs site (and anyone running
+    # `rdoc` against the unpacked gem) gets the project's preferred
+    # title, markup dialect, template, and exclude list automatically.
+    ".rdoc_options"
   ]
   spec.require_paths = ["lib"]
   spec.extensions    = ["ext/ruby-sfml/extconf.rb"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-sfml
 version: !ruby/object:Gem::Version
-  version: 3.0.0.6
+  version: 3.0.0.7
 platform: ruby
 authors:
 - Mykhailo Melnyk
@@ -74,6 +74,7 @@ extensions:
 - ext/ruby-sfml/extconf.rb
 extra_rdoc_files: []
 files:
+- ".rdoc_options"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
@@ -165,7 +166,7 @@ metadata:
   homepage_uri: https://github.com/sOM2H/ruby-sfml
   source_code_uri: https://github.com/sOM2H/ruby-sfml
   bug_tracker_uri: https://github.com/sOM2H/ruby-sfml/issues
-  documentation_uri: https://www.rubydoc.info/gems/ruby-sfml
+  documentation_uri: https://ruby-sfml-doc.netlify.app/
   changelog_uri: https://github.com/sOM2H/ruby-sfml/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths: