ruby-sfml 3.0.0.7 → 3.0.0.8

data/lib/sfml/graphics/stencil_mode.rb

@@ -27,12 +27,15 @@ module SFML
   class StencilMode
     # Order matches sfStencilComparison in CSFML 3.
     COMPARISONS = %i[never less less_equal greater greater_equal equal not_equal always].freeze
+    # Comparison symbol → integer Hash.
     COMPARISON_INDEX = COMPARISONS.each_with_index.to_h.freeze
 
     # Order matches sfStencilUpdateOperation in CSFML 3.
     OPERATIONS = %i[keep zero replace increment decrement invert].freeze
+    # Update-op symbol → integer Hash.
     OPERATION_INDEX = OPERATIONS.each_with_index.to_h.freeze
 
+    # The comparison, update operation, reference, mask, only write mask components.
     attr_reader :comparison, :update_operation, :reference, :mask, :only_write_mask
 
     def initialize(comparison: :always, update_operation: :keep,
@@ -62,6 +65,7 @@ module SFML
     # Returns the hash.
     def hash = [comparison, update_operation, reference, mask, only_write_mask].hash
 
+    # Returns the to s.
     def to_s
       "StencilMode(#{comparison}, #{update_operation}, ref=#{reference}, " \
         "mask=#{format('0x%08X', mask)}, only_write=#{only_write_mask})"

data/lib/sfml/graphics/text.rb

@@ -15,6 +15,7 @@ module SFML
     include Graphics::Transformable
     CSFML_PREFIX = :sfText
 
+    # Bitmask values for each style symbol.
     STYLES = {
       regular:        0,
       bold:           1 << 0,
@@ -47,6 +48,7 @@ module SFML
       self.scale              = opts[:scale]             if opts.key?(:scale)
     end
 
+    # The font.
     attr_reader :font
 
     # Replace the font used to render this Text.
@@ -201,6 +203,7 @@ module SFML
       Rect.from_native(C::Graphics.sfText_getGlobalBounds(@handle))
     end
 
+    # Returns the draw on.
     def draw_on(target, states_ptr = nil) # :nodoc:
       target._draw_native(:Text, @handle, states_ptr)
     end

data/lib/sfml/graphics/texture.rb

@@ -116,6 +116,7 @@ module SFML
       img
     end
 
+    # Returns the size.
     def size
       Vector2.from_native(C::Graphics.sfTexture_getSize(@handle))
     end
@@ -151,11 +152,13 @@ module SFML
     #   `SFML::Texture.unbind`.
     COORDINATE_TYPES = {normalized: 0, pixels: 1}.freeze
 
+    # Returns the bind.
     def bind(coord: :normalized)
       raise ArgumentError, "coord must be :normalized or :pixels" unless COORDINATE_TYPES.key?(coord)
       C::Graphics.sfTexture_bind(@handle, COORDINATE_TYPES[coord])
     end
 
+    # Returns the self.
     def self.unbind
       C::Graphics.sfTexture_bind(nil, 0)
     end

data/lib/sfml/graphics/texture_atlas.rb

@@ -20,6 +20,7 @@ module SFML
   # Frame lookups are tolerant of the `.png` extension — Aseprite
   # exports `walk-0.png`, but you can write `atlas.region("walk-0")`.
   class TextureAtlas
+    # File-extension regex for atlas image files.
     IMAGE_EXTS = /\.(?:png|jpg|jpeg|bmp|tga|gif)\z/i
 
     # @param json_path [String] path to the atlas JSON
@@ -46,6 +47,7 @@ module SFML
       @source    = source
     end
 
+    # The texture, source components.
     attr_reader :texture, :source
 
     # Returns the frame names.

data/lib/sfml/graphics/transform.rb

@@ -20,6 +20,8 @@ module SFML
   # work with a fresh copy use `t.dup`. The CSFML constant for the
   # identity is exposed via `Transform.identity`.
   class Transform
+    # Build a fresh identity Transform. Compose with `#translate` /
+    # `#rotate` / `#scale`.
     def initialize
       @struct = C::Graphics::Transform.new
       # Start as identity by copying CSFML's sfTransform_Identity.
@@ -27,6 +29,7 @@ module SFML
       @struct.pointer.write_bytes(identity_bytes)
     end
 
+    # Alias for `Transform.new` — reads better at call site.
     def self.identity
       new
     end
@@ -42,6 +45,8 @@ module SFML
       t
     end
 
+    # Deep-copy hook — `t.dup` clones the underlying matrix, not just
+    # the pointer.
     def initialize_dup(other)
       super
       @struct = C::Graphics::Transform.new
@@ -137,6 +142,7 @@ module SFML
 
     private
 
+    # Returns the allocate new with.
     def allocate_new_with(native_struct)
       t = self.class.allocate
       new_buf = C::Graphics::Transform.new

data/lib/sfml/graphics/transformable_object.rb

@@ -25,14 +25,17 @@ module SFML
       self.scale    = opts[:scale]    if opts.key?(:scale)
     end
 
+    # Returns the transform.
     def transform
       C::Graphics.sfTransformable_getTransform(@handle)
     end
 
+    # Returns the inverse transform.
     def inverse_transform
       C::Graphics.sfTransformable_getInverseTransform(@handle)
     end
 
+    # Returns the dup.
     def dup
       ptr = C::Graphics.sfTransformable_copy(@handle)
       raise GraphicsError, "sfTransformable_copy returned NULL" if ptr.null?

data/lib/sfml/graphics/vertex.rb

@@ -7,6 +7,7 @@ module SFML
   #   SFML::Vertex.new([10, 20], color: SFML::Color.red)
   #   SFML::Vertex.new([10, 20], color: SFML::Color.red, tex_coords: [0, 0])
   class Vertex
+    # The position, color, tex coords components.
     attr_accessor :position, :color, :tex_coords
 
     def initialize(position = Vector2.zero, color: Color::WHITE, tex_coords: Vector2.zero)
@@ -15,6 +16,7 @@ module SFML
       @tex_coords = _coerce_vec2(tex_coords)
     end
 
+    # Returns the to s.
     def to_s
       "Vertex(#{@position.x}, #{@position.y})"
     end

data/lib/sfml/graphics/vertex_array.rb

@@ -21,6 +21,7 @@ module SFML
 
     # Order matches sfPrimitiveType in CSFML/Graphics/PrimitiveType.h.
     PRIMITIVE_TYPES = %i[points lines line_strip triangles triangle_strip triangle_fan].freeze
+    # Primitive symbol → integer index Hash.
     PRIMITIVE_INDEX = PRIMITIVE_TYPES.each_with_index.to_h.freeze
 
     # Build an empty VertexArray. `primitive_type` chooses how
@@ -123,6 +124,7 @@ module SFML
       Rect.from_native(C::Graphics.sfVertexArray_getBounds(@handle))
     end
 
+    # Returns the draw on.
     def draw_on(target, states_ptr = nil) # :nodoc:
       target._draw_native(:VertexArray, @handle, states_ptr)
     end

data/lib/sfml/graphics/vertex_buffer.rb

@@ -21,12 +21,17 @@ module SFML
   # `SFML::VertexBuffer.available?` returns false and you should
   # fall back to `VertexArray`.
   class VertexBuffer
+    # VBO usage hints in CSFML enum order.
     USAGES       = C::Graphics::VERTEX_BUFFER_USAGES
+    # Usage symbol → integer Hash.
     USAGE_INDEX  = USAGES.each_with_index.to_h.freeze
 
+    # Primitive type symbols in `sfPrimitiveType` order.
     PRIMITIVE_TYPES = VertexArray::PRIMITIVE_TYPES
+    # Primitive symbol → integer index Hash.
     PRIMITIVE_INDEX = VertexArray::PRIMITIVE_INDEX
 
+    # Returns the self.
     def self.available?
       C::Graphics.sfVertexBuffer_isAvailable
     end
@@ -61,6 +66,7 @@ module SFML
     alias size  count
     alias length count
 
+    # Returns the primitive type.
     def primitive_type
       PRIMITIVE_TYPES[C::Graphics.sfVertexBuffer_getPrimitiveType(@handle)] || :unknown
     end
@@ -73,6 +79,7 @@ module SFML
       C::Graphics.sfVertexBuffer_setPrimitiveType(@handle, idx)
     end
 
+    # Returns the usage.
     def usage
       USAGES[C::Graphics.sfVertexBuffer_getUsage(@handle)] || :unknown
     end
@@ -120,10 +127,12 @@ module SFML
       self
     end
 
+    # Returns the self.
     def self.unbind
       C::Graphics.sfVertexBuffer_bind(nil)
     end
 
+    # Returns the draw on.
     def draw_on(target, states_ptr = nil) # :nodoc:
       target._draw_native(:VertexBuffer, @handle, states_ptr)
     end

data/lib/sfml/graphics/view.rb

@@ -19,6 +19,8 @@ module SFML
   #
   # All coordinate inputs accept either a SFML::Vector2 or a [x, y] array.
   class View
+    # Build a View. All four kwargs may be passed up-front or set
+    # later. `_handle:` is for internal wrapping of CSFML pointers.
     def initialize(center: nil, size: nil, rotation: nil, viewport: nil, _handle: nil)
       ptr = _handle || C::Graphics.sfView_create
       raise GraphicsError, "sfView_create returned NULL" if ptr.null?
@@ -55,6 +57,7 @@ module SFML
       new(_handle: copy)
     end
 
+    # Centre point of the view in world coordinates.
     def center
       Vector2.from_native(C::Graphics.sfView_getCenter(@handle))
     end
@@ -64,6 +67,7 @@ module SFML
       C::Graphics.sfView_setCenter(@handle, _vec2(value).to_native_f)
     end
 
+    # Visible area in world units (NOT pixels). Halving this zooms in.
     def size
       Vector2.from_native(C::Graphics.sfView_getSize(@handle))
     end
@@ -73,6 +77,7 @@ module SFML
       C::Graphics.sfView_setSize(@handle, _vec2(value).to_native_f)
     end
 
+    # Rotation in degrees (counter-clockwise).
     def rotation
       C::Graphics.sfView_getRotation(@handle)
     end

data/lib/sfml/keybindings.rb

@@ -10,6 +10,7 @@ module SFML
   # so `class Sub < Parent; on_key :x, :foo; end` keeps the parent's
   # other bindings while overriding (or adding) `:x`.
   module Keybindings
+    # Returns the on key.
     def on_key(code, target = nil, &block)
       @key_handlers ||= {}
       handler = block || target

data/lib/sfml/network/ftp.rb

@@ -16,7 +16,9 @@ module SFML
     # for commands that return a path or a list). All responses expose
     # `#ok?`, `#status` (Integer), `#status_symbol`, `#message`.
     class Ftp
+      # Standard port for the protocol.
       DEFAULT_PORT    = 21
+      # Default per-call timeout.
       DEFAULT_TIMEOUT = SFML::Time.zero
 
       # FTP status codes mapped to symbols. The transport-error ones

data/lib/sfml/network/http.rb

@@ -20,9 +20,12 @@ module SFML
     #   http_version: [major, minor] (default [1, 0])
     #   timeout:      SFML::Time or seconds (default 0 = no timeout)
     class Http
+      # Default per-call timeout.
       DEFAULT_TIMEOUT = SFML::Time.zero
       DEFAULT_VERSION = [1, 0].freeze
 
+      # Build an HTTP client pinned to `host` (URL prefix). Pass
+      # `port: 0` to let CSFML pick the protocol's default port.
       def initialize(host, port: 0)
         ptr = C::Network.sfHttp_create
         raise NetworkError, "sfHttp_create returned NULL" if ptr.null?
@@ -31,6 +34,8 @@ module SFML
         C::Network.sfHttp_setHost(@handle, host.to_s, Integer(port))
       end
 
+      # Send a request and wait for the response. See the class doc
+      # for all the kwargs.
       def send_request(method: :get, uri: "/", fields: nil, body: nil,
                        http_version: DEFAULT_VERSION, timeout: DEFAULT_TIMEOUT)
         request_ptr = C::Network.sfHttpRequest_create
@@ -78,10 +83,13 @@ module SFML
           1000 => :invalid_response, 1001 => :connection_failed,
         }.freeze
 
+        # Responses are created via `Http#send_request`, not directly.
         def initialize
           raise NoMethodError, "use SFML::Network::Http#send_request to create a Response"
         end
 
+        # Numeric HTTP status code (200, 404, ...). Combine with
+        # `STATUS_NAMES` or use `#status_symbol`.
         def status
           C::Network.sfHttpResponse_getStatus(@handle)
         end
@@ -92,10 +100,12 @@ module SFML
           STATUS_NAMES[status] || status
         end
 
-        # Returns the body.
+        # Response body as a Ruby String.
         def body  = C::Network.sfHttpResponse_getBody(@handle).to_s
+        # Look up a response header by name (case-insensitive in HTTP).
         def field(name) = C::Network.sfHttpResponse_getField(@handle, name.to_s)
 
+        # HTTP version the server replied with, as `[major, minor]`.
         def http_version
           [
             C::Network.sfHttpResponse_getMajorVersion(@handle),

data/lib/sfml/network/ip_address.rb

@@ -10,14 +10,17 @@ module SFML
     #   SFML::Network::IpAddress::BROADCAST   # 255.255.255.255
     #   SFML::Network::IpAddress.local        # local network IP
     class IpAddress
+      # Parse from a dotted-decimal string like `"192.168.1.42"`.
       def self.from_string(s)
         wrap(C::Network.sfIpAddress_fromString(s.to_s))
       end
 
+      # Build from four octets: `from_bytes(192, 168, 1, 42)`.
       def self.from_bytes(a, b, c, d)
         wrap(C::Network.sfIpAddress_fromBytes(Integer(a), Integer(b), Integer(c), Integer(d)))
       end
 
+      # Build from a 32-bit packed integer.
       def self.from_integer(n)
         wrap(C::Network.sfIpAddress_fromInteger(Integer(n)))
       end
@@ -40,15 +43,18 @@ module SFML
         ip.freeze
       end
 
+      # Dotted-decimal string ("192.168.1.42").
       def to_s
         @struct[:address].to_ptr.read_string_to_null
       end
       alias inspect to_s
 
+      # Packed 32-bit Integer view of the address.
       def to_i
         C::Network.sfIpAddress_toInteger(@struct)
       end
 
+      # Value equality — same dotted-decimal string.
       def ==(other)
         other.is_a?(IpAddress) && to_s == other.to_s
       end
@@ -59,9 +65,13 @@ module SFML
       # @!visibility private
       attr_reader :struct
 
+      # The 0.0.0.0 / empty placeholder address.
       NONE      = wrap(C::Network.sfIpAddress_None)
+      # 0.0.0.0 — match any local interface.
       ANY       = wrap(C::Network.sfIpAddress_Any)
+      # 127.0.0.1 — local-only.
       LOCALHOST = wrap(C::Network.sfIpAddress_LocalHost)
+      # 255.255.255.255 — broadcast on the local subnet.
       BROADCAST = wrap(C::Network.sfIpAddress_Broadcast)
     end
   end

data/lib/sfml/network/packet.rb

@@ -27,6 +27,7 @@ module SFML
         @handle = FFI::AutoPointer.new(ptr, C::Network.method(:sfPacket_destroy))
       end
 
+      # Returns the clear.
       def clear
         C::Network.sfPacket_clear(@handle)
         self
@@ -134,6 +135,7 @@ module SFML
         buf.read_string.force_encoding(Encoding::UTF_8)
       end
 
+      # Returns the dup.
       def dup
         ptr = C::Network.sfPacket_copy(@handle)
         raise NetworkError, "sfPacket_copy returned NULL" if ptr.null?

data/lib/sfml/network/socket_selector.rb

@@ -24,6 +24,7 @@ module SFML
     # objects; this binding exists for game code that's already using
     # `SFML::Network::Tcp{Socket,Listener}` / `UdpSocket`.
     class SocketSelector
+      # Create an empty selector. Use `#add` to register sockets.
       def initialize
         ptr = C::Network.sfSocketSelector_create
         raise NetworkError, "sfSocketSelector_create returned NULL" if ptr.null?
@@ -31,6 +32,8 @@ module SFML
         @handle = FFI::AutoPointer.new(ptr, C::Network.method(:sfSocketSelector_destroy))
       end
 
+      # Register a `TcpListener`, `TcpSocket`, or `UdpSocket` for
+      # monitoring. Chainable.
       def add(socket)
         case socket
         when TcpListener then C::Network.sfSocketSelector_addTcpListener(@handle, socket.handle)
@@ -43,6 +46,7 @@ module SFML
         self
       end
 
+      # Stop monitoring a previously-added socket. Chainable.
       def remove(socket)
         case socket
         when TcpListener then C::Network.sfSocketSelector_removeTcpListener(@handle, socket.handle)
@@ -55,6 +59,7 @@ module SFML
         self
       end
 
+      # Unregister all sockets.
       def clear
         C::Network.sfSocketSelector_clear(@handle)
         self

data/lib/sfml/network/tcp_listener.rb

@@ -26,6 +26,7 @@ module SFML
         C::Network::STATUSES[code]
       end
 
+      # Returns the close.
       def close
         C::Network.sfTcpListener_close(@handle)
         self

data/lib/sfml/network/tcp_socket.rb

@@ -29,11 +29,13 @@ module SFML
         C::Network::STATUSES[code]
       end
 
+      # Returns the disconnect.
       def disconnect
         C::Network.sfTcpSocket_disconnect(@handle)
         self
       end
 
+      # Returns the send.
       def send(data)
         bytes = data.to_s
         buf   = FFI::MemoryPointer.new(:uint8, bytes.bytesize)
@@ -87,6 +89,7 @@ module SFML
       # Returns the remote port.
       def remote_port = C::Network.sfTcpSocket_getRemotePort(@handle)
 
+      # Returns the remote address.
       def remote_address
         IpAddress.wrap(C::Network.sfTcpSocket_getRemoteAddress(@handle))
       end

data/lib/sfml/network/udp_socket.rb

@@ -9,6 +9,7 @@ module SFML
     #   sock.send("hello", to: SFML::Network::IpAddress::LOCALHOST, port: 9000)
     #   status, bytes, addr, port = sock.receive(max: 1024)
     class UdpSocket
+      # Max UDP payload CSFML will send in one call.
       MAX_DATAGRAM_SIZE = C::Network.sfUdpSocket_maxDatagramSize
 
       def initialize
@@ -17,17 +18,20 @@ module SFML
         @handle = FFI::AutoPointer.new(ptr, C::Network.method(:sfUdpSocket_destroy))
       end
 
+      # Returns the bind.
       def bind(port:, address: IpAddress::ANY)
         addr = address.is_a?(IpAddress) ? address : IpAddress.from_string(address)
         code = C::Network.sfUdpSocket_bind(@handle, Integer(port), addr.struct)
         C::Network::STATUSES[code]
       end
 
+      # Returns the unbind.
       def unbind
         C::Network.sfUdpSocket_unbind(@handle)
         self
       end
 
+      # Returns the send.
       def send(data, to:, port:)
         bytes = data.to_s
         addr  = to.is_a?(IpAddress) ? to : IpAddress.from_string(to)

data/lib/sfml/scene.rb

@@ -39,6 +39,7 @@ module SFML
 
     include InputQueries
 
+    # The Host SFML::App.
     attr_reader :app
     alias host app
 

data/lib/sfml/system/clock.rb

@@ -6,36 +6,45 @@ module SFML
   #   puts clock.elapsed_time.as_seconds
   #   clock.restart  # returns the elapsed time and resets to zero
   class Clock
+    # Create a fresh clock — starts running at zero.
     def initialize
       ptr = C::System.sfClock_create
       raise Error, "sfClock_create returned NULL" if ptr.null?
       @handle = FFI::AutoPointer.new(ptr, C::System.method(:sfClock_destroy))
     end
 
+    # Time elapsed since the clock was last started / restarted, as a
+    # `SFML::Time`. Aliased as `#elapsed`.
     def elapsed_time
       Time.from_native(C::System.sfClock_getElapsedTime(@handle))
     end
     alias elapsed elapsed_time
 
-    # `true` if running.
+    # `true` if the clock is currently ticking (not paused via `#stop`).
     def running?
       C::System.sfClock_isRunning(@handle)
     end
 
+    # Resume after `#stop`. No-op if already running.
     def start
       C::System.sfClock_start(@handle)
       self
     end
 
+    # Pause the clock — `#elapsed_time` freezes until `#start`.
     def stop
       C::System.sfClock_stop(@handle)
       self
     end
 
+    # Atomic "read elapsed + reset to zero". Standard pattern for
+    # per-frame dt: `dt = clock.restart`.
     def restart
       Time.from_native(C::System.sfClock_restart(@handle))
     end
 
+    # Reset to zero without affecting the running state. Returns the
+    # elapsed time before the reset.
     def reset
       Time.from_native(C::System.sfClock_reset(@handle))
     end

data/lib/sfml/system/rect.rb

@@ -11,6 +11,7 @@ module SFML
   #
   # Used by Text#local_bounds, Text#global_bounds, Sprite#texture_rect, etc.
   class Rect
+    # The position, size components.
     attr_reader :position, :size
 
     # `position` and `size` may each be a `Vector2` OR a `[x, y]` Array.
@@ -76,6 +77,7 @@ module SFML
     def to_s = "Rect(x=#{x}, y=#{y}, w=#{width}, h=#{height})"
     alias inspect to_s
 
+    # Returns the self.
     def self.from_native(struct) # :nodoc:
       new(
         Vector2.new(struct[:position][:x], struct[:position][:y]),

data/lib/sfml/system/time.rb

@@ -13,6 +13,7 @@ module SFML
   class Time
     include Comparable
 
+    # The microseconds.
     attr_reader :microseconds
 
     # Build a Time from a Float of seconds.
@@ -57,10 +58,12 @@ module SFML
     def to_s = "#<SFML::Time #{as_seconds}s>"
     alias inspect to_s
 
+    # Returns the self.
     def self.from_native(struct) # :nodoc:
       new(struct[:microseconds])
     end
 
+    # Returns the to native.
     def to_native # :nodoc:
       C::System::Time.new.tap { |t| t[:microseconds] = @microseconds }
     end

data/lib/sfml/system/vector2.rb

@@ -7,6 +7,7 @@ module SFML
   #   v * 2             #=> Vector2(6, 8)
   #   x, y = v          # destructures via to_a
   class Vector2
+    # The X coordinate, Y coordinate components.
     attr_reader :x, :y
 
     # Compact constructor: `Vector2[3, 4]` reads naturally as a literal.
@@ -161,10 +162,12 @@ module SFML
     def to_s = "Vector2(#{@x}, #{@y})"
     alias inspect to_s
 
+    # Returns the self.
     def self.from_native(struct) # :nodoc:
       new(struct[:x], struct[:y])
     end
 
+    # Returns the to native f.
     def to_native_f # :nodoc:
       C::System::Vector2f.new.tap { |v| v[:x] = @x; v[:y] = @y }
     end

data/lib/sfml/system/vector3.rb

@@ -4,6 +4,7 @@ module SFML
   # support. Used by the 3D-audio API (`Sound#position`, `Listener`,
   # …) and as a back-end for `Image` size hints.
   class Vector3
+    # The X coordinate, Y coordinate, Z coordinate components.
     attr_reader :x, :y, :z
 
     # Compact constructor: `Vector3[1, 2, 3]`.
@@ -148,10 +149,12 @@ module SFML
     def to_s = "Vector3(#{@x}, #{@y}, #{@z})"
     alias inspect to_s
 
+    # Returns the self.
     def self.from_native(struct) # :nodoc:
       new(struct[:x], struct[:y], struct[:z])
     end
 
+    # Returns the to native f.
     def to_native_f # :nodoc:
       C::System::Vector3f.new.tap { |v| v[:x] = @x; v[:y] = @y; v[:z] = @z }
     end

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.7"
+  VERSION = "3.0.0.8"
 end

data/lib/sfml/window/clipboard.rb

@@ -11,6 +11,7 @@ module SFML
   module Clipboard
     module_function
 
+    # Returns the text.
     def text
       ptr = C::Window.sfClipboard_getUnicodeString
       return "" if ptr.null?

data/lib/sfml/window/context_settings.rb

@@ -28,6 +28,7 @@ module SFML
       debug:   C::Window::ContextAttribute::DEBUG,
     }.freeze
 
+    # The depth bits, stencil bits, antialiasing components.
     attr_reader :depth_bits, :stencil_bits, :antialiasing,
                 :major_version, :minor_version, :attribute_flags,
                 :srgb_capable
@@ -64,6 +65,7 @@ module SFML
       s
     end
 
+    # Returns the self.
     def self.from_native(struct)
       attrs = ATTRIBUTE_FLAGS.find { |_, v| v == struct[:attribute_flags] }&.first || :default
       new(
@@ -94,6 +96,7 @@ module SFML
                 @major_version, @minor_version, @attribute_flags,
                 @srgb_capable].hash
 
+    # Returns the to s.
     def to_s
       "ContextSettings(aa=#{@antialiasing}, depth=#{@depth_bits}, " \
         "stencil=#{@stencil_bits}, gl=#{@major_version}.#{@minor_version})"

data/lib/sfml/window/cursor.rb

@@ -19,6 +19,7 @@ module SFML
       size_top_left size_bottom_right size_bottom_left size_top_right
       size_all cross help not_allowed
     ].freeze
+    # Type symbol → integer index Hash.
     TYPE_INDEX = TYPES.each_with_index.to_h.freeze
 
     # Build a cursor matching one of the OS-supplied shapes. Some types