glfw3 0.1.1 → 0.2.0

data/lib/glfw3.rb

@@ -2,5 +2,11 @@ require 'glfw3/glfw3'
 require 'glfw3/callbacks'
 require 'glfw3/window'
 
+#
+# The core Glfw module, contains functions for setting error and monitor
+# callbacks, joystick input, constants, timing, event handling, and so on.
+#
+# See also Glfw::Window, Glfw::Monitor, and Glfw::VideoMode.
+#
 module Glfw
 end

data/lib/glfw3/callbacks.rb

@@ -4,26 +4,71 @@ module Glfw
   @@error_callback__ = nil
   @@monitor_callback__ = nil
 
+  #
+  # Gets the current error callback object.
+  #
+  # call-seq:
+  #     error_callback -> obj or nil
+  #
   def self.error_callback
     @@error_callback
   end
 
+  #
+  # Sets the current error callback object to the given value. Presumably a
+  # Proc or some other object, but one that implements a call(...) function.
+  #
+  # If set to nil, any GLFW error will raise a RuntimeError exception.
+  #
+  # The error callback is expected to take two arguments: the error code and a
+  # description of the error. For example:
+  #
+  #     Glfw.error_callback = lambda { |error_code, description|
+  #       raise RuntimeError, "GLFW Error #{error_code}: #{description}"
+  #     }
+  #
   def self.error_callback=(lambda)
     @@error_callback = lambda
   end
 
+  #
+  # Sets the current error callback to a Proc generated from the provided block.
+  #
   def self.set_error_callback(&block)
     self.error_callback = lambda(&block)
   end
 
+  #
+  # Gets the current monitor callback object.
+  #
+  # call-seq:
+  #     monitor_callback -> obj or nil
+  #
   def self.monitor_callback
     @@monitor_callback
   end
 
+  #
+  # Sets the current monitor callback object to the given object. Presumably a
+  # Proc or some other object, but one that implements a call(...) function.
+  #
+  # If set to nil, the callback is disabled.
+  #
+  # The monitor callback is expected to take two arguments: the monitor and an
+  # event (one of either Glfw::CONNECTED or Glfw::DISCONNECTED). For example:
+  #
+  #     Glfw.monitor_callback = lambda { |monitor, event|
+  #       # ...
+  #     }
+  #
   def self.monitor_callback=(lambda)
     @@monitor_callback = lambda
   end
 
+  #
+  # Sets the current monitor callback to a Proc generated from the provided
+  # block.
+  #
   def self.set_monitor_callback(&block)
     self.monitor_callback = lambda(&block)
   end

data/lib/glfw3/window.rb

@@ -2,26 +2,71 @@ require 'glfw3/glfw3'
 
 module Glfw; end
 
+#
+# A GLFW window. These contain a context, optionally one shared with other
+# windows and generate events. Each window maintains its own event callbacks.
+#
+# Wraps GLFWwindow and its associated functions, for the most part.
+#
+#
+# === Event Callbacks
+#
+# All window event callbacks' first argument is the window that generated the
+# event. These event callbacks all receive the same arguments as their GLFW C
+# counterparts, so refer to the
+# {GLFW 3 documentation}[http://www.glfw.org/docs/3.0/group__input.html]
+# for that.
+#
+#
+# === User Data
+#
+# If you need to associate a particular object or value with a window, you can
+# use its #user_data attribute to store and retreive an arbitrary object for
+# the window. If you need to store multiple values with the window, you might
+# set its user data object to a Hash.
+#
 class Glfw::Window
 
+  #
+  # User data attribute, can be set to any arbitrary object. Used to associate
+  # any object with the window for later retrieval.
+  #
   attr_accessor :user_data
 
+  #
+  # Returns an array of all allocated GLFW windows.
+  #
+  # call-seq:
+  #     windows -> [Glfw::Window, ...]
+  #
   def windows
     @__windows.values
   end
 
+  #
+  # Gets the X position of the window in screen space. See also #position.
+  #
   def x
     position[0]
   end
 
+  #
+  # Gets the Y position of the window in screen space. See also #position.
+  #
   def y
     position[1]
   end
 
+  #
+  # Gets the width of the window. See also #size.
+  #
   def width
     size[0]
   end
 
+  #
+  # Gets the width of the window. See also #size.
+  #
   def height
     size[1]
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glfw3
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Noel Raymond Cower
@@ -15,19 +15,29 @@ email: ncower@gmail.com
 executables: []
 extensions:
 - ext/glfw3/extconf.rb
-extra_rdoc_files: []
+extra_rdoc_files:
+- ext/glfw3/glfw3.c
+- README.md
+- COPYING
 files:
 - lib/glfw3/callbacks.rb
 - lib/glfw3/window.rb
 - lib/glfw3.rb
 - ext/glfw3/glfw3.c
 - ext/glfw3/extconf.rb
+- COPYING
+- README.md
 homepage: https://github.com/nilium/ruby-glfw3
 licenses:
 - Simplified BSD
 metadata: {}
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- --title
+- core-opengl -- OpenGL Core Profile Bindings
+- --main
+- README.md
+- --line-numbers
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement