module CrystGLFW

Sets the error callback that is called when an error occurs in LibGLFW.

When an error occurs in LibGLFW, an error code is yielded to the block defined by this method. The error code identifies the type of error that occurred and can be validated by checking it against the constants defined in CrystGLFW:

CrystGLFW.on_error do |error_code|
  case error_code
  when CrystGLFW[:not_initialized]
    puts "CrystGLFW has not been initialized."
  when CrystGLFW[:invalid_enum]
    puts "An invalid enum was passed to CrystGLFW."
  else
    puts "An error occurred"
  end
end

NOTE This method may be called outside a #run block definition without triggering an error.

NOTE Defining custom behavior will bypass the Error module entirely. It is recommended that this method not be used.

Processes all events in the event queue and then returns immediately.

include CrystGLFW

CrystGLFW.run do
  window = Window.new
  until window.should_close?
    CrystGLFW.poll_events # Process all events, even if queue is empty.
    window.swap_buffers
  end
end

NOTE This method must be called inside a #run block definition.

NOTE This method must not be called from within a callback.

Posts an empty event to the event queue, forcing #wait_events to return.

CrystGLFW.post_empty_event

NOTE This method must be called inside a #run block definition.

Sets up GLFW to execute the block and terminates GLFW afterwards.

include CrystGLFW

CrystGLFW.run do
  window = Window.new(title: "My Window")
  until window.should_close?
    window.wait_events
    window.swap_buffers
  end
end

With few exceptions, all CrystGLFW methods must be called within the block passed to this method. This method initializes the underlying GLFW library for use and cleans up the library after the block has returned.

Sets the GLFW timer to a new time, in seconds.

This method accepts the following arguments:

• t, the new time.

CrystGLFW.set_time 1.0
CrystGLFW.time # => 1.0

NOTE This method must be called inside a #run block definition.

Returns the current value, in seconds, of the GLFW timer.

CrystGLFW.time # => 0.13899576

NOTE This method must be called inside a #run block definition.

Alternate syntax for #set_time.

This method accepts the following arguments:

• t, the new time.

CrystGLFW.time = 1.0
CrystGLFW.time # => 1.0

NOTE This method must be called from within a #run block definition.

Returns the frequency, in Hz, of the raw timer.

CrystGLFW.timer_frequency # => 1_000_000_000

NOTE This method must be called inside a #run block definition.

Returns the current value of the raw timer, measured in 1 / #timer_frequency seconds.

CrystGLFW.timer_value # => 754_104_002_009_408

NOTE This method must be called inside a #run block definition.

Returns the major, minor, and revision version numbers of GLFW.

CrystGLFW.version # => {major: 3, minor: 2, rev: 1}

NOTE This method may be called outside a #run block definition without triggering an error.

Returns the compile-time generated version string of GLFW.

CrystGLFW.version_string # => "3.2.1 Cocoa NSGL chdir menubar retina dynamic"

NOTE This method may be called outside a #run block definition without triggering an error.

Puts the calling thread to sleep until at least one event is queued or the specified timeout is reached.

include CrystGLFW

CrystGLFW.run do
  window = Window.new
  until window.should_close?
    CrystGLFW.wait_events(1.5)
    window.swap_buffers
  end
end

This method accepts the following arguments:
- *timeout*, the maximum amount of time, in seconds, to wait.


NOTE: This method must be called inside a `#run` block definition.

NOTE: This method must not be called from within a callback.

Puts the calling thread to sleep until at least one event is queued.

include CrystGLFW

CrystGLFW.run do
  window = Window.new
  until window.should_close?
    CrystGLFW.wait_events # Wait for events to queue, then process them.
    window.swap_buffers
  end
end


NOTE: This method must be called inside a `#run` block definition.

NOTE: This method must not be called from within a callback.