The board is the whole universe of your GUI. It contains everything. Most of the time, though, you don't really care, because you will immediately run your board after creating it, like in run (of_layout my_layout).

However, nothing prevents you from creating several boards and finally choosing the one you want to run. What you should not do is to simultaneously run several boards in different threads, because SDL can manage events only from the main thread.

Shortcut maps can be passed to the board to associate an arbitrary action with specific keys (like quitting when ESC is pressed). See Creating global keyboard shortcuts.

Raising the Exit exception will tell the GUI loop to terminate.

Create a board from a list of layouts and connections. The list of connections can be empty, because connections can be added afterwards. Each Layout in the list will open as a new window.

• parameter shortcuts

  This optional argument is a shortcut map.

• parameter on_user_event

  This optional argument is a function to be executed (by the main thread) when a Trigger.user_event is emitted.

get_monitor_refresh_rate board returns the monitor refresh rate, for the monitor containing board. In case of several monitors with different refresh rates, return the greatest common divisor, or the minimum if the gcd is less than 30.

Synonym for create. (Since 20220418)

Similar to create. Each layout in the list will be displayed in a different window. (Since 20220418)

Similar to of_layout but with only one layout. (Since 20220418)

Similar to of_layouts.

• deprecated

  (since 20220418). Use of_layouts or create instead.

This is finally how you run your app! It creates the SDL windows associated with the Window.ts registered with the board, and launches the main loop. This function only returns when all windows are closed (in case at least one window was created), or when the Exit exception is raised. vsync defaults to true and enables synchronization to monitor refresh rate where possible, otherwise a 60 FPS Time.adaptive_fps is used.

Construct shortcuts from a list of (SDL keycode, SDL keymod, action).

The exit_on_escape shortcut will raise the Exit exception upon pressing the Escape key.

• see Example #6

  .

This is only useful if you have your own graphics loop, and do not use run. This function creates an SDL window for each top layout in the board. One can use predefined windows with the optional argument windows. They will be host the layouts in the order they appear in the list. If there are fewer windows than layouts, new windows are created. If there are more, the excess is disregarded.

Ask the GUI to refresh (ie. repaint) the custom windows (those that were not created by Bogue itself).

This is only useful if you have your own graphics loop, and do not use run. Calling one_step ~before_display anim (start_fps, fps) ~clear board is what is executed at each step of the Bogue mainloop. If anim=true this step is non blocking; this is what you want if either Bogue or your loop has an animation running. If anim=false then the function will wait until an event is received.

• returns

  true if the GUI currently handles an animation. In this case fps() was executed by one_step. If not, you should handle the frame rate yourself.

Number of displayed frames since startup.

Use this to close SDL windows and cleanup memory, after run has returned. This does not exit your program. Calling quit () is not necessary if your program exits after run.