Uderzo v0.4.0 Uderzo.GenRenderer View Source

Generic rendering code. This will start a process that will render a frame at a regular rate in a window of the indicated size. Rendering the frame is done by calling a callback with the current window size and height and the current mouse pointer position.

GenRenderer is using GenServer internally and is thus OTP compatible.

Usually, if you want to use Uderzo, this is the module you want to build around. See also the examples and demos in the repository.

Link to this section Summary

Functions

Returns a specification to start this module under a supervisor

Invoked when the server is started. start_link/3 or start/3 will block until it returns

Start a GenRenderer with the indicated window height, width and title and the indicated rendering function. The rendering function has arity 4 and will receive the window width, height, and current mouse pointer position as x, y

Link to this section Functions

Returns a specification to start this module under a supervisor.

See Supervisor.

Invoked when the server is started. start_link/3 or start/3 will block until it returns.

args is the argument term (second argument) passed to start_link/3.

Returning {:ok, state} will cause start_link/3 to return {:ok, pid} and the process to enter its loop.

Returning {:ok, state, timeout} is similar to {:ok, state} except handle_info(:timeout, state) will be called after timeout milliseconds if no messages are received within the timeout.

Returning {:ok, state, :hibernate} is similar to {:ok, state} except the process is hibernated before entering the loop. See c:handle_call/3 for more information on hibernation.

Returning :ignore will cause start_link/3 to return :ignore and the process will exit normally without entering the loop or calling c:terminate/2. If used when part of a supervision tree the parent supervisor will not fail to start nor immediately try to restart the GenServer. The remainder of the supervision tree will be (re)started and so the GenServer should not be required by other processes. It can be started later with Supervisor.restart_child/2 as the child specification is saved in the parent supervisor. The main use cases for this are:

  • The GenServer is disabled by configuration but might be enabled later.
  • An error occurred and it will be handled by a different mechanism than the Supervisor. Likely this approach involves calling Supervisor.restart_child/2 after a delay to attempt a restart.

Returning {:stop, reason} will cause start_link/3 to return {:error, reason} and the process to exit with reason reason without entering the loop or calling c:terminate/2.

Callback implementation for GenServer.init/1.

Link to this function start_link(title, window_width, window_height, target_fps, rendering_function, genserver_opts \\ []) View Source

Start a GenRenderer with the indicated window height, width and title and the indicated rendering function. The rendering function has arity 4 and will receive the window width, height, and current mouse pointer position as x, y.

The target_fps is a target, much rests on the speed of the rendering function for the real fps.

The final argument, genserver_opts, is just passed on to GenServer.start_link/3.

Returns GenServer.on_start.