ruby-sfml 3.0.0.6 → 3.0.0.7

data/lib/sfml/graphics/particle_system.rb

@@ -45,7 +45,9 @@ module SFML
       :r, :g, :b, :a,
       :size,
     ) do
+      # `true` if alive.
       def alive? = age < lifetime
+      # Returns the normalized age.
       def normalized_age = age / lifetime
     end
 
@@ -61,8 +63,11 @@ module SFML
     end
 
     attr_reader :particles, :texture
+    # Returns the size.
     def size = @particles.size
+    # `true` if empty.
     def empty? = @particles.empty?
+    # `true` if full.
     def full?  = @particles.size >= @max
 
     # Spawn a new particle. Silently dropped if the pool is full

data/lib/sfml/graphics/rectangle_shape.rb

@@ -12,6 +12,8 @@ module SFML
     include Graphics::ShapeInspectable
     CSFML_PREFIX = :sfRectangleShape
 
+    # Build a RectangleShape. Required: `size:` (Vector2 or `[w, h]`).
+    # All other styling/transform kwargs match CircleShape.
     def initialize(size:, **opts)
       ptr = C::Graphics.sfRectangleShape_create
       raise GraphicsError, "sfRectangleShape_create returned NULL" if ptr.null?
@@ -29,31 +31,40 @@ module SFML
       self.scale              = opts[:scale]              if opts.key?(:scale)
     end
 
+    # Always 4 — the four corners.
     def point_count = C::Graphics.sfRectangleShape_getPointCount(@handle)
 
+    # Current size as a Vector2.
     def size
       Vector2.from_native(C::Graphics.sfRectangleShape_getSize(@handle))
     end
 
+    # Set the size — accepts Vector2 or `[w, h]`.
     def size=(value)
       vec = value.is_a?(Vector2) ? value : Vector2.new(*value)
       C::Graphics.sfRectangleShape_setSize(@handle, vec.to_native_f)
     end
 
+    # Interior fill color.
     def fill_color = Color.from_native(C::Graphics.sfRectangleShape_getFillColor(@handle))
 
+    # Set the fill color.
     def fill_color=(c)
       C::Graphics.sfRectangleShape_setFillColor(@handle, c.to_native)
     end
 
+    # Outline color (only visible when `#outline_thickness > 0`).
     def outline_color = Color.from_native(C::Graphics.sfRectangleShape_getOutlineColor(@handle))
 
+    # Set the outline color.
     def outline_color=(c)
       C::Graphics.sfRectangleShape_setOutlineColor(@handle, c.to_native)
     end
 
+    # Outline thickness in pixels — negative draws inward.
     def outline_thickness = C::Graphics.sfRectangleShape_getOutlineThickness(@handle)
 
+    # Set the outline thickness.
     def outline_thickness=(t)
       C::Graphics.sfRectangleShape_setOutlineThickness(@handle, t.to_f)
     end

data/lib/sfml/graphics/render_target.rb

@@ -115,6 +115,7 @@ module SFML
         self
       end
 
+      # Set the view.
       def view=(value)
         raise ArgumentError, "#{self.class}#view= requires a SFML::View" unless value.is_a?(View)
         _csfml(:setView, @handle, value.handle)

data/lib/sfml/graphics/render_texture.rb

@@ -39,14 +39,18 @@ module SFML
       Vector2.new(v[:x], v[:y])
     end
 
+    # `true` if smooth.
     def smooth?  = C::Graphics.sfRenderTexture_isSmooth(@handle)
 
+    # Set the smooth.
     def smooth=(value)
       C::Graphics.sfRenderTexture_setSmooth(@handle, !!value)
     end
 
+    # `true` if repeated.
     def repeated? = C::Graphics.sfRenderTexture_isRepeated(@handle)
 
+    # Set the repeated.
     def repeated=(value)
       C::Graphics.sfRenderTexture_setRepeated(@handle, !!value)
     end
@@ -74,8 +78,11 @@ module SFML
     def active=(value)
       C::Graphics.sfRenderTexture_setActive(@handle, value ? true : false)
     end
+    # Returns the push gl states.
     def push_gl_states  = C::Graphics.sfRenderTexture_pushGLStates(@handle)
+    # Returns the pop gl states.
     def pop_gl_states   = C::Graphics.sfRenderTexture_popGLStates(@handle)
+    # Returns the reset gl states.
     def reset_gl_states = C::Graphics.sfRenderTexture_resetGLStates(@handle)
 
     # Pixel-space viewport / scissor for the given view (defaults

data/lib/sfml/graphics/render_window.rb

@@ -69,10 +69,14 @@ module SFML
     # What we asked for at creation time, if anything (otherwise nil).
     attr_reader :requested_context
 
+    # `true` while the window is still alive (hasn't been closed by
+    # `#close` or the user).
     def open?
       C::Graphics.sfRenderWindow_isOpen(@handle)
     end
 
+    # Close the window — the next iteration of the main loop will
+    # see `#open? == false`.
     def close
       C::Graphics.sfRenderWindow_close(@handle)
       self
@@ -94,6 +98,7 @@ module SFML
       self
     end
 
+    # Change the window's title bar text.
     def title=(value)
       C::Graphics.sfRenderWindow_setTitle(@handle, value.to_s)
     end
@@ -119,14 +124,18 @@ module SFML
       C::Graphics.sfRenderWindow_setMouseCursorGrabbed(@handle, grabbed ? true : false)
     end
 
+    # Cap the render loop to `value` frames per second. Set 0 to
+    # disable the cap.
     def framerate_limit=(value)
       C::Graphics.sfRenderWindow_setFramerateLimit(@handle, Integer(value))
     end
 
+    # Enable / disable vertical sync.
     def vsync=(enabled)
       C::Graphics.sfRenderWindow_setVerticalSyncEnabled(@handle, enabled ? true : false)
     end
 
+    # Current window size in pixels as a Vector2.
     def size
       v = C::Graphics.sfRenderWindow_getSize(@handle)
       Vector2.new(v[:x], v[:y])
@@ -176,6 +185,7 @@ module SFML
       C::Graphics.sfRenderWindow_setMinimumSize(@handle, _vec2u_or_nil(value))
     end
 
+    # Upper bound on user-driven resizes — see `#minimum_size=`.
     def maximum_size=(value)
       C::Graphics.sfRenderWindow_setMaximumSize(@handle, _vec2u_or_nil(value))
     end
@@ -187,7 +197,11 @@ module SFML
     end
 
     # ---- Focus ----
+
+    # `true` if this window currently has OS-level keyboard focus.
     def focused?       = C::Graphics.sfRenderWindow_hasFocus(@handle)
+    # Ask the OS to give this window focus. Cooperative — most
+    # window managers won't steal focus unconditionally.
     def request_focus  = C::Graphics.sfRenderWindow_requestFocus(@handle)
 
     # ---- OS-window state ----
@@ -195,10 +209,14 @@ module SFML
       C::Graphics.sfRenderWindow_setVisible(@handle, value ? true : false)
     end
 
+    # Toggle key repeat. With `true`, holding a key fires repeated
+    # `:key_pressed` events; with `false` only one fires per press.
     def key_repeat_enabled=(value)
       C::Graphics.sfRenderWindow_setKeyRepeatEnabled(@handle, value ? true : false)
     end
 
+    # 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::Graphics.sfRenderWindow_setJoystickThreshold(@handle, Float(value))
     end
@@ -208,6 +226,7 @@ module SFML
       Vector2.from_native(C::Graphics.sfRenderWindow_getPosition(@handle))
     end
 
+    # Move the window's top-left corner in desktop coordinates.
     def position=(value)
       vec = value.is_a?(Vector2) ? value : Vector2.new(*value)
       v = C::System::Vector2i.new
@@ -230,11 +249,18 @@ module SFML
     # current thread — the only way to use SFML rendering from a
     # non-main thread.
 
+    # Activate / deactivate the window's GL context on the current
+    # thread. Only one context can be active per thread at a time.
     def active=(value)
       C::Graphics.sfRenderWindow_setActive(@handle, value ? true : false)
     end
+    # Save SFML's GL state before raw GL calls.
     def push_gl_states  = C::Graphics.sfRenderWindow_pushGLStates(@handle)
+    # Restore SFML's GL state after raw GL calls (paired with
+    # `#push_gl_states`).
     def pop_gl_states   = C::Graphics.sfRenderWindow_popGLStates(@handle)
+    # Re-initialise SFML's GL state from scratch — heavier hammer
+    # than push/pop.
     def reset_gl_states = C::Graphics.sfRenderWindow_resetGLStates(@handle)
 
     # Block until an event arrives or `timeout` (a SFML::Time)

data/lib/sfml/graphics/shape.rb

@@ -75,18 +75,23 @@ module SFML
 
     def fill_color = Color.from_native(C::Graphics.sfShape_getFillColor(@handle))
 
+    # Set the fill color.
     def fill_color=(c)
       C::Graphics.sfShape_setFillColor(@handle, c.to_native)
     end
 
+    # Returns the outline color.
     def outline_color = Color.from_native(C::Graphics.sfShape_getOutlineColor(@handle))
 
+    # Set the outline color.
     def outline_color=(c)
       C::Graphics.sfShape_setOutlineColor(@handle, c.to_native)
     end
 
+    # Returns the outline thickness.
     def outline_thickness = C::Graphics.sfShape_getOutlineThickness(@handle)
 
+    # Set the outline thickness.
     def outline_thickness=(t)
       C::Graphics.sfShape_setOutlineThickness(@handle, t.to_f)
     end

data/lib/sfml/graphics/shape_inspectable.rb

@@ -24,6 +24,7 @@ module SFML
         self
       end
 
+      # Set the texture.
       def texture=(tex)
         set_texture(tex, reset_rect: false)
       end
@@ -32,6 +33,7 @@ module SFML
         Rect.from_native(_csfml(:getTextureRect, @handle))
       end
 
+      # Set the texture rect.
       def texture_rect=(rect)
         raise ArgumentError, "texture_rect= requires a SFML::Rect" unless rect.is_a?(Rect)
         native = C::Graphics::IntRect.new

data/lib/sfml/graphics/sprite.rb

@@ -28,14 +28,17 @@ module SFML
 
     attr_reader :texture
 
+    # Set the texture.
     def texture=(new_texture)
       raise ArgumentError, "Sprite#texture= requires a SFML::Texture" unless new_texture.is_a?(Texture)
       C::Graphics.sfSprite_setTexture(@handle, new_texture.handle, false)
       @texture = new_texture
     end
 
+    # Returns the color.
     def color = Color.from_native(C::Graphics.sfSprite_getColor(@handle))
 
+    # Set the color.
     def color=(c)
       C::Graphics.sfSprite_setColor(@handle, c.to_native)
     end
@@ -48,6 +51,7 @@ module SFML
       Rect.from_native(C::Graphics.sfSprite_getTextureRect(@handle))
     end
 
+    # Set the texture rect.
     def texture_rect=(rect)
       raise ArgumentError, "Sprite#texture_rect= requires a SFML::Rect" unless rect.is_a?(Rect)
       native = C::Graphics::IntRect.new

data/lib/sfml/graphics/sprite_sheet.rb

@@ -48,6 +48,7 @@ module SFML
 
     attr_reader :texture, :cols, :rows, :frame_w, :frame_h
 
+    # Returns the frame count.
     def frame_count = @regions.size
 
     # The pixel Rect for cell `index` (0 = top-left, increases
@@ -82,6 +83,7 @@ module SFML
       )
     end
 
+    # String representation for debugging.
     def to_s = "#<SpriteSheet #{@cols}×#{@rows} (#{@frame_w}×#{@frame_h}px cells)>"
     alias inspect to_s
 

data/lib/sfml/graphics/stencil_mode.rb

@@ -59,6 +59,7 @@ module SFML
         only_write_mask == other.only_write_mask
     end
     alias eql? ==
+    # Returns the hash.
     def hash = [comparison, update_operation, reference, mask, only_write_mask].hash
 
     def to_s

data/lib/sfml/graphics/text.rb

@@ -23,6 +23,10 @@ module SFML
       strike_through: 1 << 3,
     }.freeze
 
+    # Build a Text. `font` must be an `SFML::Font`; `string` defaults
+    # to empty. Optional kwargs: `:character_size`, `:fill_color`,
+    # `:outline_color`, `:outline_thickness`, `:style`, plus the
+    # standard transform options.
     def initialize(font, string = "", **opts)
       raise ArgumentError, "Text requires a SFML::Font" unless font.is_a?(Font)
 
@@ -45,6 +49,7 @@ module SFML
 
     attr_reader :font
 
+    # Replace the font used to render this Text.
     def font=(new_font)
       raise ArgumentError, "Text#font= requires a SFML::Font" unless new_font.is_a?(Font)
       C::Graphics.sfText_setFont(@handle, new_font.handle)
@@ -69,6 +74,8 @@ module SFML
       codepoints.pack("U*")
     end
 
+    # Replace the displayed string. Accepts any Ruby String — UTF-8
+    # codepoints are converted to UTF-32 for CSFML internally.
     def string=(value)
       str = value.to_s.encode("UTF-8")
       cps = str.unpack("U*")  # array of integer codepoints
@@ -77,26 +84,34 @@ module SFML
       C::Graphics.sfText_setUnicodeString(@handle, buf)
     end
 
+    # Font size in pixels (e.g. 14, 18, 24).
     def character_size = C::Graphics.sfText_getCharacterSize(@handle)
 
+    # Set the font size.
     def character_size=(value)
       C::Graphics.sfText_setCharacterSize(@handle, Integer(value))
     end
 
+    # Body fill color.
     def fill_color = Color.from_native(C::Graphics.sfText_getFillColor(@handle))
 
+    # Set the fill color.
     def fill_color=(c)
       C::Graphics.sfText_setFillColor(@handle, c.to_native)
     end
 
+    # Outline color (only visible when `#outline_thickness > 0`).
     def outline_color = Color.from_native(C::Graphics.sfText_getOutlineColor(@handle))
 
+    # Set the outline color.
     def outline_color=(c)
       C::Graphics.sfText_setOutlineColor(@handle, c.to_native)
     end
 
+    # Outline thickness in pixels.
     def outline_thickness = C::Graphics.sfText_getOutlineThickness(@handle)
 
+    # Set the outline thickness.
     def outline_thickness=(t)
       C::Graphics.sfText_setOutlineThickness(@handle, t.to_f)
     end
@@ -128,6 +143,7 @@ module SFML
     # default).
     def letter_spacing = C::Graphics.sfText_getLetterSpacing(@handle)
 
+    # Set the letter-spacing multiplier.
     def letter_spacing=(value)
       C::Graphics.sfText_setLetterSpacing(@handle, Float(value))
     end
@@ -135,6 +151,7 @@ module SFML
     # The line-spacing multiplier (1.0 = default).
     def line_spacing = C::Graphics.sfText_getLineSpacing(@handle)
 
+    # Set the line-spacing multiplier.
     def line_spacing=(value)
       C::Graphics.sfText_setLineSpacing(@handle, Float(value))
     end
@@ -153,6 +170,8 @@ module SFML
       C::Graphics.sfText_getTransform(@handle)
     end
 
+    # Inverse of `#transform` — maps world-space coords back to
+    # the Text's local space.
     def inverse_transform
       C::Graphics.sfText_getInverseTransform(@handle)
     end

data/lib/sfml/graphics/texture.rb

@@ -120,18 +120,23 @@ module SFML
       Vector2.from_native(C::Graphics.sfTexture_getSize(@handle))
     end
 
+    # `true` if smooth.
     def smooth?  = C::Graphics.sfTexture_isSmooth(@handle)
 
+    # Set the smooth.
     def smooth=(value)
       C::Graphics.sfTexture_setSmooth(@handle, !!value)
     end
 
+    # `true` if repeated.
     def repeated? = C::Graphics.sfTexture_isRepeated(@handle)
 
+    # Set the repeated.
     def repeated=(value)
       C::Graphics.sfTexture_setRepeated(@handle, !!value)
     end
 
+    # `true` if srgb.
     def srgb? = C::Graphics.sfTexture_isSrgb(@handle)
 
     # Generate mipmaps for this texture. Returns `true` if the

data/lib/sfml/graphics/texture_atlas.rb

@@ -48,6 +48,7 @@ module SFML
 
     attr_reader :texture, :source
 
+    # Returns the frame names.
     def frame_names = @regions.keys
 
     # @return [SFML::Rect] the pixel rect for frame `name`.
@@ -90,6 +91,7 @@ module SFML
     #   walk_frames = atlas.regions.select { |k, _| k.start_with?("walk-") }
     def regions = @regions
 
+    # String representation for debugging.
     def to_s = "#<TextureAtlas #{@regions.size} frames#{@source ? " from #{File.basename(@source)}" : ""}>"
     alias inspect to_s
 

data/lib/sfml/graphics/transform.rb

@@ -125,8 +125,10 @@ module SFML
       C::Graphics.sfTransform_equal(@struct.pointer, other.struct.pointer)
     end
     alias eql? ==
+    # Returns the hash.
     def hash = matrix.hash
 
+    # String representation for debugging.
     def to_s = "Transform(#{matrix.map { |v| v.round(3) }.inspect})"
     alias inspect to_s
 

data/lib/sfml/graphics/transformable.rb

@@ -11,48 +11,60 @@ module SFML
     # negligible against any GPU work, but the wins on maintainability are
     # large — adding a new shape becomes ~5 lines.
     module Transformable
+      # Current 2D position as a Vector2.
       def position
         Vector2.from_native(_csfml(:getPosition, @handle))
       end
 
+      # Move to absolute `[x, y]` — accepts Vector2 or `[x, y]` Array.
       def position=(value)
         _csfml(:setPosition, @handle, _coerce_vec2(value).to_native_f)
       end
 
+      # Current rotation in degrees (counter-clockwise positive).
       def rotation
         _csfml(:getRotation, @handle)
       end
 
+      # Set absolute rotation in degrees.
       def rotation=(degrees)
         _csfml(:setRotation, @handle, degrees.to_f)
       end
 
+      # Current scale factors as a Vector2 (`[1, 1]` means original size).
       def scale
         Vector2.from_native(_csfml(:getScale, @handle))
       end
 
+      # Set the scale — accepts Vector2 or `[sx, sy]` Array.
       def scale=(value)
         _csfml(:setScale, @handle, _coerce_vec2(value).to_native_f)
       end
 
+      # The local origin (pivot for rotation/scale). Default is `[0, 0]`
+      # — set it to the centre of the bounding box for "rotate in place".
       def origin
         Vector2.from_native(_csfml(:getOrigin, @handle))
       end
 
+      # Set the origin — accepts Vector2 or `[x, y]` Array.
       def origin=(value)
         _csfml(:setOrigin, @handle, _coerce_vec2(value).to_native_f)
       end
 
+      # Translate by `offset` (relative move). Chainable — returns self.
       def move(offset)
         _csfml(:move, @handle, _coerce_vec2(offset).to_native_f)
         self
       end
 
+      # Rotate by `degrees` (relative). Chainable.
       def rotate(degrees)
         _csfml(:rotate, @handle, degrees.to_f)
         self
       end
 
+      # Multiply current scale by `factors` (relative scale). Chainable.
       def scale_by(factors)
         _csfml(:scale, @handle, _coerce_vec2(factors).to_native_f)
         self

data/lib/sfml/graphics/vertex_array.rb

@@ -23,6 +23,9 @@ module SFML
     PRIMITIVE_TYPES = %i[points lines line_strip triangles triangle_strip triangle_fan].freeze
     PRIMITIVE_INDEX = PRIMITIVE_TYPES.each_with_index.to_h.freeze
 
+    # Build an empty VertexArray. `primitive_type` chooses how
+    # vertices form geometry (see class doc). `vertices` is an
+    # optional initial list — same as calling `#append` after.
     def initialize(primitive_type = :points, vertices = nil)
       ptr = C::Graphics.sfVertexArray_create
       raise GraphicsError, "sfVertexArray_create returned NULL" if ptr.null?
@@ -32,10 +35,13 @@ module SFML
       vertices&.each { |v| append(v) }
     end
 
+    # Current primitive type as a Symbol (one of `PRIMITIVE_TYPES`).
     def primitive_type
       PRIMITIVE_TYPES[C::Graphics.sfVertexArray_getPrimitiveType(@handle)] || :unknown
     end
 
+    # Change the primitive type. Raises `ArgumentError` for unknown
+    # symbols.
     def primitive_type=(type)
       code = PRIMITIVE_INDEX.fetch(type) do
         raise ArgumentError,
@@ -44,22 +50,29 @@ module SFML
       C::Graphics.sfVertexArray_setPrimitiveType(@handle, code)
     end
 
+    # Number of vertices currently in the array.
     def size = C::Graphics.sfVertexArray_getVertexCount(@handle)
     alias length size
     alias count  size
 
+    # `true` if there are no vertices.
     def empty? = size.zero?
 
+    # Remove all vertices. Chainable.
     def clear
       C::Graphics.sfVertexArray_clear(@handle)
       self
     end
 
+    # Resize to exactly `n` vertices, allocating defaults if growing.
+    # Useful when you want to index-assign into the array directly.
     def resize(n)
       C::Graphics.sfVertexArray_resize(@handle, Integer(n))
       self
     end
 
+    # Add a vertex at the end. Returns self so calls can chain
+    # (`va << v1 << v2`).
     def append(vertex)
       C::Graphics.sfVertexArray_append(@handle, vertex.to_native)
       self
@@ -76,6 +89,8 @@ module SFML
       Vertex.from_native(C::Graphics::Vertex.new(ptr))
     end
 
+    # In-place vertex replacement. Bounds-checked on the Ruby side
+    # because CSFML's getter aborts the process for out-of-range.
     def []=(index, vertex)
       i = Integer(index)
       # CSFML's sfVertexArray_getVertex aborts the process on out-of-range
@@ -95,12 +110,15 @@ module SFML
       vertex
     end
 
+    # Yield every vertex in order. Returns an Enumerator without a
+    # block — makes `va.map`, `va.select`, etc. work via Enumerable.
     def each
       return enum_for(:each) unless block_given?
       size.times { |i| yield self[i] }
       self
     end
 
+    # Axis-aligned bounding box of all current vertices, as a Rect.
     def bounds
       Rect.from_native(C::Graphics.sfVertexArray_getBounds(@handle))
     end

data/lib/sfml/graphics/vertex_buffer.rb

@@ -56,6 +56,7 @@ module SFML
       update(vertices) if vertices && !vertices.empty?
     end
 
+    # Returns the count.
     def count = C::Graphics.sfVertexBuffer_getVertexCount(@handle)
     alias size  count
     alias length count
@@ -64,6 +65,7 @@ module SFML
       PRIMITIVE_TYPES[C::Graphics.sfVertexBuffer_getPrimitiveType(@handle)] || :unknown
     end
 
+    # Set the primitive type.
     def primitive_type=(type)
       idx = PRIMITIVE_INDEX.fetch(type) do
         raise ArgumentError, "Unknown primitive type: #{type.inspect}"
@@ -75,6 +77,7 @@ module SFML
       USAGES[C::Graphics.sfVertexBuffer_getUsage(@handle)] || :unknown
     end
 
+    # Set the usage.
     def usage=(value)
       idx = USAGE_INDEX.fetch(value) do
         raise ArgumentError, "Unknown VertexBuffer usage: #{value.inspect}"
@@ -106,6 +109,7 @@ module SFML
       self
     end
 
+    # Returns the native handle.
     def native_handle = C::Graphics.sfVertexBuffer_getNativeHandle(@handle)
 
     # Bind this VBO as the active vertex buffer for the GL pipeline.

data/lib/sfml/graphics/view.rb

@@ -59,6 +59,7 @@ module SFML
       Vector2.from_native(C::Graphics.sfView_getCenter(@handle))
     end
 
+    # Set the center.
     def center=(value)
       C::Graphics.sfView_setCenter(@handle, _vec2(value).to_native_f)
     end
@@ -67,6 +68,7 @@ module SFML
       Vector2.from_native(C::Graphics.sfView_getSize(@handle))
     end
 
+    # Set the size.
     def size=(value)
       C::Graphics.sfView_setSize(@handle, _vec2(value).to_native_f)
     end
@@ -75,6 +77,7 @@ module SFML
       C::Graphics.sfView_getRotation(@handle)
     end
 
+    # Set the rotation.
     def rotation=(degrees)
       C::Graphics.sfView_setRotation(@handle, degrees.to_f)
     end
@@ -86,6 +89,7 @@ module SFML
       Rect.from_native(C::Graphics.sfView_getViewport(@handle))
     end
 
+    # Set the viewport.
     def viewport=(rect)
       raise ArgumentError, "View#viewport= needs a SFML::Rect" unless rect.is_a?(Rect)
       C::Graphics.sfView_setViewport(@handle, _to_floatrect(rect))
@@ -99,6 +103,7 @@ module SFML
       Rect.from_native(C::Graphics.sfView_getScissor(@handle))
     end
 
+    # Set the scissor.
     def scissor=(rect)
       raise ArgumentError, "View#scissor= needs a SFML::Rect" unless rect.is_a?(Rect)
       C::Graphics.sfView_setScissor(@handle, _to_floatrect(rect))