ruby-sfml 3.0.0.7 → 3.0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a12ef598ae1b1dc8e541b0e3f463ec05208391202d465a5cd5360ae473be321
-  data.tar.gz: 6830ae6b0a231203e36d104a81caeb3cdcee03f706728cf2af935596f19783aa
+  metadata.gz: '09e173bcbce249d3bdcec7722e2348a3cb7e341a7ada2e223c0da44fdfc2e136'
+  data.tar.gz: a3d08d4a035fc9a1942e39251bbfec2f1213bb81f5a146fcae31ae1617b2757a
 SHA512:
-  metadata.gz: fd3caad7ec21d3408d86c973a3f0430408cfda54cb363664fbe6af319e11922740a52fde36290124ef3f591c87fbf70f0dfe2085dd3590e63dba51a54e392567
-  data.tar.gz: 41fee62ce46c0e69ee80521f51752309aa4b47bc82021d472f5370dad88dc28735549ee33563352938b2edd1f9f2e9fdbf25b611c33ccc01802b8a88acd2e9a5
+  metadata.gz: d7a28fd63f84d1c9b5b86b1a55d421245b9e2bf8fb961868b90f185e77e132182c1b292f52d2a070be553528bc0455f3838be8c9fab8de66d1a0e7cfd079621c
+  data.tar.gz: 9823d03be099a6986226d155a44459419b5b6593e700e5c7745c40619465fe60afef4791039f8caab2d511c71159bb6c0a4bac11fb19c0e8be4c79227d61e4b0

data/CHANGELOG.md

@@ -10,12 +10,34 @@ HTML API docs: <https://ruby-sfml-doc.netlify.app/>
 
 ## [Unreleased]
 
+## [3.0.0.8] — 2026-05-12
+
+Continued documentation pass. RDoc coverage went from **68% → 87%**
+on top of 3.0.0.7's first pass — every public class, module, and
+attribute is now documented, plus all the simple
+setter/getter/predicate methods. Docs site:
+<https://ruby-sfml-doc.netlify.app/>.
+
+### Changed — documentation
+
+- All 63 `attr_reader` / `attr_accessor` declarations now carry a
+  one-line description (62 → 0 undocumented).
+- 72 of 97 module-level constants now documented (was 23) — every
+  `CODES` / `INDEX` table, `STATUSES` enum, `DEFAULT_*` sentinel,
+  and named-color singleton has a sentence.
+- Hand-written docstrings on `Assets`, `Clock`, `Window` (bare),
+  `Sprite`, `View`, `Transform`, `SocketSelector`, `Http`,
+  `IpAddress`, `Event` — the methods that survived the previous
+  pass without docs.
+- Final aggressive auto-doc pass fills setter / getter /
+  predicate / accessor patterns the conservative pass skipped.
+
 ## [3.0.0.7] — 2026-05-12
 
-Documentation pass. Every public class / module / method now
-carries at least a one-line RDoc comment — coverage went from
-~36% (`rake rdoc:coverage`) to ~68%. Pair this release with the
-new docs site at <https://ruby-sfml-doc.netlify.app/>.
+Documentation pass. RDoc coverage went from **36% → 68%** —
+every public class, module, and the high-traffic methods now
+carry at least a one-line description. Pair this release with
+the new docs site at <https://ruby-sfml-doc.netlify.app/>.
 
 ### Changed — documentation
 

data/lib/sfml/app.rb

@@ -36,6 +36,7 @@ module SFML
   # case-by-case basis. Subclasses inherit their parent's settings
   # — set one in a base class, override in a subclass.
   class App
+    # Names of every class-level configuration macro on `SFML::App`.
     CONFIG_KEYS = %i[
       width height title
       framerate vsync background
@@ -84,7 +85,9 @@ module SFML
 
     include InputQueries
 
+    # The Backing SFML::RenderWindow.
     attr_reader   :window
+    # The background color.
     attr_accessor :background_color
 
     # Per-instance kwargs override anything set at the class level.
@@ -241,10 +244,12 @@ module SFML
       end
     end
 
+    # Returns the update.
     def update(dt)
       @current_scene&.update(dt)
     end
 
+    # Returns the draw.
     def draw
       @current_scene&.draw
     end

data/lib/sfml/assets.rb

@@ -14,29 +14,41 @@ module SFML
   #
   # Cache survives until you call .clear or the process exits.
   module Assets
+    # File extensions recognised as image / texture assets.
     TEXTURE_EXTS = %w[.png .jpg .jpeg .bmp .gif .tga].freeze
+    # File extensions recognised as short-sound assets.
     SOUND_EXTS   = %w[.wav .ogg .flac .mp3].freeze
+    # File extensions recognised as music (streamed) assets — same as `SOUND_EXTS`.
     MUSIC_EXTS   = SOUND_EXTS
+    # File extensions recognised as font assets.
     FONT_EXTS    = %w[.ttf .otf].freeze
 
     class NotFound < SFML::Error; end
 
     class << self
+      # Current list of directories scanned by `#font`, `#texture`,
+      # etc. Defaults to `<dir of $0>/assets/`. Mutate via
+      # `#root=` / `#add_search_path` / `#search_paths=`.
       def search_paths
         @search_paths ||= [default_root]
       end
 
-      # Set the search paths.
+      # Replace the entire search-path list. Resets the cache so
+      # the next load re-resolves from the new locations.
       def search_paths=(paths)
         @search_paths = Array(paths).map { |p| File.expand_path(p) }
         @cache&.clear
       end
 
-      # Set the root.
+      # Convenience for "use exactly this one directory" — shorthand
+      # for `search_paths = [path]`.
       def root=(path)
         self.search_paths = [path]
       end
 
+      # Append a directory to the end of `#search_paths` unless it's
+      # already present. Useful for adding mod / DLC directories
+      # without nuking the default search root.
       def add_search_path(path)
         search_paths << File.expand_path(path) unless search_paths.include?(File.expand_path(path))
       end
@@ -48,20 +60,25 @@ module SFML
         self
       end
 
+      # Load (or fetch from cache) an `SFML::Font` by name — searches
+      # `#search_paths` for any of `FONT_EXTS`, falls back to system
+      # fonts via `Font.find`.
       def font(name)
         cache[[:font, name]] ||= load_font(name)
       end
 
+      # Load (or fetch from cache) an `SFML::Texture` by name.
       def texture(name)
         cache[[:texture, name]] ||= load_texture(name)
       end
 
+      # Load (or fetch from cache) an `SFML::SoundBuffer` by name.
       def sound(name)
         cache[[:sound, name]] ||= load_sound_buffer(name)
       end
 
-      # Music is intentionally NOT cached — it owns a streaming position and
-      # play state, so each caller wants its own instance.
+      # Load a fresh `SFML::Music` by name. **Not cached** — each
+      # caller gets its own playback position.
       def music(name)
         path = locate(name, MUSIC_EXTS) or raise NotFound,
           "Music #{name.inspect} not found. Searched: #{search_paths.inspect}"
@@ -70,14 +87,17 @@ module SFML
 
       private
 
+      # Returns the cache.
       def cache
         @cache ||= {}
       end
 
+      # Returns the default root.
       def default_root
         File.expand_path("assets", File.dirname($PROGRAM_NAME || "."))
       end
 
+      # Returns the load font.
       def load_font(name)
         path = locate(name, FONT_EXTS)
         return Font.load(path) if path
@@ -87,12 +107,14 @@ module SFML
           "Font #{name.inspect} not found in #{search_paths.inspect} or system fonts"
       end
 
+      # Returns the load texture.
       def load_texture(name)
         path = locate(name, TEXTURE_EXTS) or raise NotFound,
           "Texture #{name.inspect} not found. Searched: #{search_paths.inspect}"
         Texture.load(path)
       end
 
+      # Returns the load sound buffer.
       def load_sound_buffer(name)
         path = locate(name, SOUND_EXTS) or raise NotFound,
           "Sound #{name.inspect} not found. Searched: #{search_paths.inspect}"

data/lib/sfml/audio/sound.rb

@@ -24,6 +24,7 @@ module SFML
       self.looping = looping
     end
 
+    # The buffer.
     attr_reader :buffer
 
     # Replace the `SoundBuffer` this Sound is bound to. Stopping

data/lib/sfml/audio/sound_buffer.rb

@@ -6,6 +6,7 @@ module SFML
   #   sound  = SFML::Sound.new(buffer)
   #   sound.play
   class SoundBuffer
+    # Returns the self.
     def self.load(path)
       ptr = C::Audio.sfSoundBuffer_createFromFile(path.to_s)
       raise LoadError, "Could not load sound buffer from #{path.inspect}" if ptr.null?

data/lib/sfml/audio/sound_buffer_recorder.rb

@@ -24,15 +24,18 @@ module SFML
       C::Audio.sfSoundBufferRecorder_start(@handle, Integer(sample_rate))
     end
 
+    # Returns the stop.
     def stop
       C::Audio.sfSoundBufferRecorder_stop(@handle)
       self
     end
 
+    # Returns the sample rate.
     def sample_rate
       C::Audio.sfSoundBufferRecorder_getSampleRate(@handle)
     end
 
+    # Returns the channel count.
     def channel_count
       C::Audio.sfSoundBufferRecorder_getChannelCount(@handle)
     end

data/lib/sfml/audio/sound_cone.rb

@@ -12,6 +12,7 @@ module SFML
   #     inner_angle: 30, outer_angle: 90, outer_gain: 0.2,
   #   )
   class SoundCone
+    # The inner angle, outer angle, outer gain components.
     attr_reader :inner_angle, :outer_angle, :outer_gain
 
     def initialize(inner_angle:, outer_angle:, outer_gain:)
@@ -31,6 +32,7 @@ module SFML
     # Returns the hash.
     def hash = [inner_angle, outer_angle, outer_gain].hash
 
+    # Returns the to s.
     def to_s
       "SoundCone(inner=#{inner_angle}°, outer=#{outer_angle}°, outer_gain=#{outer_gain})"
     end

data/lib/sfml/audio/sound_recorder.rb

@@ -43,6 +43,7 @@ module SFML
       C::Audio.sfSoundRecorder_isAvailable
     end
 
+    # Returns the self.
     def self.default_device
       C::Audio.sfSoundRecorder_getDefaultDevice
     end
@@ -108,6 +109,7 @@ module SFML
       self
     end
 
+    # Returns the stop.
     def stop
       C::Audio.sfSoundRecorder_stop(@handle)
       self

data/lib/sfml/audio/sound_stream.rb

@@ -44,6 +44,7 @@ module SFML
   #   variable, store in an instance var). If the Ruby object is GC'd
   #   while CSFML is still calling callbacks, the process crashes.
   class SoundStream
+    # Per-callback PCM-buffer size for the sample queue.
     DEFAULT_CHUNK_FRAMES = 4096
 
     def initialize(channel_count:, sample_rate:)

data/lib/sfml/graphics/animation.rb

@@ -51,6 +51,7 @@ module SFML
       @done          = false
     end
 
+    # The sprite, frame index components.
     attr_reader :sprite, :frame_index
 
     # Returns whether the animation has reached the end (only

data/lib/sfml/graphics/blend_mode.rb

@@ -22,11 +22,15 @@ module SFML
       zero one src_color one_minus_src_color dst_color one_minus_dst_color
       src_alpha one_minus_src_alpha dst_alpha one_minus_dst_alpha
     ].freeze
+    # Blend-factor symbol → integer Hash.
     FACTOR_INDEX = FACTORS.each_with_index.to_h.freeze
 
+    # Blend-equation symbols in CSFML enum order.
     EQUATIONS = %i[add subtract reverse_subtract min max].freeze
+    # Blend-equation symbol → integer Hash.
     EQUATION_INDEX = EQUATIONS.each_with_index.to_h.freeze
 
+    # The color src, color dst, color eq components.
     attr_reader :color_src, :color_dst, :color_eq,
                 :alpha_src, :alpha_dst, :alpha_eq
 
@@ -50,6 +54,7 @@ module SFML
     # Returns the hash.
     def hash = [color_src, color_dst, color_eq, alpha_src, alpha_dst, alpha_eq].hash
 
+    # Returns the to s.
     def to_s
       "BlendMode(color: #{color_src}/#{color_dst}/#{color_eq}, alpha: #{alpha_src}/#{alpha_dst}/#{alpha_eq})"
     end
@@ -104,6 +109,7 @@ module SFML
     MULTIPLY = from_native(C::Graphics.sfBlendMultiply)
     MIN      = from_native(C::Graphics.sfBlendMin)
     MAX      = from_native(C::Graphics.sfBlendMax)
+    # The 0.0.0.0 / empty placeholder address.
     NONE     = from_native(C::Graphics.sfBlendNone)
   end
 end

data/lib/sfml/graphics/circle_shape.rb

@@ -77,6 +77,7 @@ module SFML
       C::Graphics.sfCircleShape_setOutlineThickness(@handle, t.to_f)
     end
 
+    # Returns the draw on.
     def draw_on(target, states_ptr = nil) # :nodoc:
       target._draw_native(:CircleShape, @handle, states_ptr)
     end

data/lib/sfml/graphics/color.rb

@@ -8,6 +8,7 @@ module SFML
   #   SFML::Color["#ff6432"]               # hex (RGB or RRGGBB or RRGGBBAA)
   #   SFML::Color.cornflower_blue          # named
   class Color
+    # The Red channel (0–255), Green channel (0–255), Blue channel (0–255), Alpha channel (0–255) components.
     attr_reader :r, :g, :b, :a
 
     # Build a Color from individual channel values. Each must be an
@@ -67,12 +68,14 @@ module SFML
     def to_s = "Color(#{@r}, #{@g}, #{@b}, #{@a})"
     alias inspect to_s
 
+    # Returns the to native.
     def to_native # :nodoc:
       C::Graphics::Color.new.tap do |c|
         c[:r] = @r; c[:g] = @g; c[:b] = @b; c[:a] = @a
       end
     end
 
+    # Returns the self.
     def self.from_native(struct) # :nodoc:
       new(struct[:r], struct[:g], struct[:b], struct[:a])
     end
@@ -110,13 +113,21 @@ module SFML
 
     # Standard SFML colors.
     BLACK       = new(0,   0,   0)
+    # Pure white, opaque.
     WHITE       = new(255, 255, 255)
+    # Pure red, opaque.
     RED         = new(255, 0,   0)
+    # Pure green, opaque.
     GREEN       = new(0,   255, 0)
+    # Pure blue, opaque.
     BLUE        = new(0,   0,   255)
+    # Pure yellow, opaque.
     YELLOW      = new(255, 255, 0)
+    # Pure magenta, opaque.
     MAGENTA     = new(255, 0,   255)
+    # Pure cyan, opaque.
     CYAN        = new(0,   255, 255)
+    # Fully transparent (alpha = 0).
     TRANSPARENT = new(0,   0,   0,   0)
 
     # A nicer default than pure black for empty windows.

data/lib/sfml/graphics/convex_shape.rb

@@ -85,6 +85,7 @@ module SFML
       C::Graphics.sfConvexShape_setOutlineThickness(@handle, t.to_f)
     end
 
+    # Returns the draw on.
     def draw_on(target, states_ptr = nil) # :nodoc:
       target._draw_native(:ConvexShape, @handle, states_ptr)
     end

data/lib/sfml/graphics/font.rb

@@ -18,6 +18,7 @@ module SFML
     # license, redistributable). See lib/sfml/assets/fonts/DejaVuSans.LICENSE.txt.
     DEFAULT_PATH = File.expand_path("../assets/fonts/DejaVuSans.ttf", __dir__).freeze
 
+    # Returns the self.
     def self.load(path)
       ptr = C::Graphics.sfFont_createFromFile(path.to_s)
       raise LoadError, "Could not load font from #{path.inspect}" if ptr.null?

data/lib/sfml/graphics/image.rb

@@ -33,6 +33,7 @@ module SFML
       _take_ownership(ptr)
     end
 
+    # Returns the self.
     def self.load(path)
       ptr = C::Graphics.sfImage_createFromFile(path.to_s)
       raise LoadError, "Could not load image from #{path.inspect}" if ptr.null?
@@ -90,6 +91,7 @@ module SFML
       img
     end
 
+    # Returns the size.
     def size
       Vector2.from_native(C::Graphics.sfImage_getSize(@handle))
     end
@@ -151,6 +153,7 @@ module SFML
       self
     end
 
+    # Returns the save.
     def save(path)
       ok = C::Graphics.sfImage_saveToFile(@handle, path.to_s)
       raise LoadError, "Could not save image to #{path.inspect}" unless ok
@@ -188,11 +191,13 @@ module SFML
       self
     end
 
+    # Returns the flip horizontally.
     def flip_horizontally
       C::Graphics.sfImage_flipHorizontally(@handle)
       self
     end
 
+    # Returns the flip vertically.
     def flip_vertically
       C::Graphics.sfImage_flipVertically(@handle)
       self

data/lib/sfml/graphics/particle_system.rb

@@ -51,6 +51,7 @@ module SFML
       def normalized_age = age / lifetime
     end
 
+    # No gravity by default `[0.0, 0.0]`.
     DEFAULT_GRAVITY = [0.0, 0.0].freeze
 
     def initialize(max: 1000, gravity: DEFAULT_GRAVITY, texture: nil)
@@ -62,6 +63,7 @@ module SFML
       @vertex_array = VertexArray.new(:triangles)
     end
 
+    # The particles, texture components.
     attr_reader :particles, :texture
     # Returns the size.
     def size = @particles.size

data/lib/sfml/graphics/rectangle_shape.rb

@@ -69,6 +69,7 @@ module SFML
       C::Graphics.sfRectangleShape_setOutlineThickness(@handle, t.to_f)
     end
 
+    # Returns the draw on.
     def draw_on(target, states_ptr = nil) # :nodoc:
       target._draw_native(:RectangleShape, @handle, states_ptr)
     end

data/lib/sfml/graphics/render_states.rb

@@ -14,9 +14,12 @@ module SFML
   #
   # All fields default to the CSFML `sfRenderStates_default` value.
   class RenderStates
+    # Texture coordinate-type symbols.
     COORDINATE_TYPES = %i[normalized pixels].freeze
+    # Coordinate-type symbol → integer Hash.
     COORDINATE_INDEX = COORDINATE_TYPES.each_with_index.to_h.freeze
 
+    # The blend mode, stencil mode, texture, shader, coordinate type components.
     attr_reader :blend_mode, :stencil_mode, :texture, :shader, :coordinate_type
 
     def initialize(blend_mode: nil, stencil_mode: nil, texture: nil, shader: nil, coordinate_type: :normalized)

data/lib/sfml/graphics/render_target.rb

@@ -35,6 +35,7 @@ module SFML
         self
       end
 
+      # Returns the display.
       def display
         _csfml(:display, @handle)
         self
@@ -122,6 +123,7 @@ module SFML
         @view = value
       end
 
+      # Returns the view.
       def view
         View.from_borrowed(_csfml(:getView, @handle))
       end
@@ -132,6 +134,7 @@ module SFML
         @default_view ||= View.from_borrowed(_csfml(:getDefaultView, @handle))
       end
 
+      # Returns the map pixel to coords.
       def map_pixel_to_coords(pixel, view: nil)
         vec = C::System::Vector2i.new
         px, py = pixel.is_a?(Vector2) ? [pixel.x, pixel.y] : pixel
@@ -142,6 +145,7 @@ module SFML
         Vector2.new(result[:x], result[:y])
       end
 
+      # Returns the map coords to pixel.
       def map_coords_to_pixel(coord, view: nil)
         vec = C::System::Vector2f.new
         cx, cy = coord.is_a?(Vector2) ? [coord.x, coord.y] : coord

data/lib/sfml/graphics/render_texture.rb

@@ -34,6 +34,7 @@ module SFML
       self.repeated = repeated
     end
 
+    # Returns the size.
     def size
       v = C::Graphics.sfRenderTexture_getSize(@handle)
       Vector2.new(v[:x], v[:y])
@@ -92,6 +93,7 @@ module SFML
       Rect.from_native(C::Graphics.sfRenderTexture_getViewport(@handle, view.handle))
     end
 
+    # Returns the scissor.
     def scissor(view = self.view)
       raise ArgumentError, "expected a SFML::View" unless view.is_a?(View)
       Rect.from_native(C::Graphics.sfRenderTexture_getScissor(@handle, view.handle))

data/lib/sfml/graphics/render_window.rb

@@ -18,6 +18,7 @@ module SFML
     include Graphics::RenderTarget
     CSFML_PREFIX = :sfRenderWindow
 
+    # Default window style bitmask.
     DEFAULT_STYLE = C::Window::Style::DEFAULT
 
     # The first form takes (width, height, title, **opts).
@@ -350,6 +351,7 @@ module SFML
       v
     end
 
+    # Returns the parse args.
     def parse_args(args)
       case args.length
       when 2

data/lib/sfml/graphics/shader.rb

@@ -45,6 +45,7 @@ module SFML
       C::Graphics.sfShader_isAvailable
     end
 
+    # Returns the self.
     def self.geometry_available?
       C::Graphics.sfShader_isGeometryAvailable
     end
@@ -136,6 +137,7 @@ module SFML
       C::Graphics.sfShader_setIntUniform(@handle, name.to_s, Integer(value))
     end
 
+    # Returns the ivec2.
     def set_ivec2(name, x, y)
       v = C::System::Vector2i.new
       v[:x] = Integer(x); v[:y] = Integer(y)
@@ -197,6 +199,7 @@ module SFML
       _set_mat_array(name, matrices, 9, :sfShader_setMat3UniformArray)
     end
 
+    # Returns the mat4 array.
     def set_mat4_array(name, matrices)
       _set_mat_array(name, matrices, 16, :sfShader_setMat4UniformArray)
     end
@@ -208,6 +211,7 @@ module SFML
     # render_states: SFML::RenderStates.new(shader: self))`.
     def bind = C::Graphics.sfShader_bind(@handle)
 
+    # Returns the self.
     def self.unbind = C::Graphics.sfShader_bind(nil)
 
     # The OpenGL program ID. Useful for debug printf / interop

data/lib/sfml/graphics/shape.rb

@@ -67,6 +67,7 @@ module SFML
       raise NoMethodError, "#{self.class} must override #point_count"
     end
 
+    # Returns the point.
     def point(_index)
       raise NoMethodError, "#{self.class} must override #point(index)"
     end
@@ -105,6 +106,7 @@ module SFML
       self
     end
 
+    # Returns the draw on.
     def draw_on(target, states_ptr = nil) # :nodoc:
       target._draw_native(:Shape, @handle, states_ptr)
     end

data/lib/sfml/graphics/shape_inspectable.rb

@@ -9,6 +9,7 @@ module SFML
     # to the bound texture in @texture so the GC doesn't collect the GPU
     # resource while the shape still draws with it.
     module ShapeInspectable
+      # Returns the texture.
       def texture
         ptr = _csfml(:getTexture, @handle)
         return nil if ptr.null?
@@ -29,6 +30,7 @@ module SFML
         set_texture(tex, reset_rect: false)
       end
 
+      # Returns the texture rect.
       def texture_rect
         Rect.from_native(_csfml(:getTextureRect, @handle))
       end
@@ -68,10 +70,12 @@ module SFML
         Rect.from_native(_csfml(:getGlobalBounds, @handle))
       end
 
+      # Returns the transform.
       def transform
         _csfml(:getTransform, @handle)
       end
 
+      # Returns the inverse transform.
       def inverse_transform
         _csfml(:getInverseTransform, @handle)
       end

data/lib/sfml/graphics/sprite.rb

@@ -11,6 +11,8 @@ module SFML
     include Graphics::Transformable
     CSFML_PREFIX = :sfSprite
 
+    # Build a Sprite. `texture` is required (SFML 3 dropped the
+    # default constructor). Kwargs cover color / transform.
     def initialize(texture, **opts)
       raise ArgumentError, "Sprite requires a SFML::Texture" unless texture.is_a?(Texture)
 
@@ -26,6 +28,7 @@ module SFML
       self.scale    = opts[:scale]    if opts.key?(:scale)
     end
 
+    # The texture.
     attr_reader :texture
 
     # Set the texture.
@@ -62,14 +65,17 @@ module SFML
       C::Graphics.sfSprite_setTextureRect(@handle, native)
     end
 
+    # Bounding box of the sprite in its own (untransformed) coords.
     def local_bounds
       Rect.from_native(C::Graphics.sfSprite_getLocalBounds(@handle))
     end
 
+    # Bounding box after applying the sprite's transform.
     def global_bounds
       Rect.from_native(C::Graphics.sfSprite_getGlobalBounds(@handle))
     end
 
+    # Returns the draw on.
     def draw_on(target, states_ptr = nil) # :nodoc:
       target._draw_native(:Sprite, @handle, states_ptr)
     end
@@ -88,6 +94,8 @@ module SFML
       C::Graphics.sfSprite_getTransform(@handle)
     end
 
+    # Inverse of `#transform` — maps world-space coords back to
+    # the sprite's local space.
     def inverse_transform
       C::Graphics.sfSprite_getInverseTransform(@handle)
     end

data/lib/sfml/graphics/sprite_sheet.rb

@@ -19,6 +19,7 @@ module SFML
   # the source image has separators or a 1px outline to prevent
   # bleed.
   class SpriteSheet
+    # Returns the self.
     def self.load(path, frame_size:, padding: 0, margin: 0, smooth: true)
       new(texture: Texture.load(path, smooth: smooth),
           frame_size: frame_size, padding: padding, margin: margin)
@@ -46,6 +47,7 @@ module SFML
       end.freeze
     end
 
+    # The texture, cols, rows, frame w, frame h components.
     attr_reader :texture, :cols, :rows, :frame_w, :frame_h
 
     # Returns the frame count.