package bogue

  1. Overview
  2. Docs
GUI library for ocaml, with animations, based on SDL2

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (15)

Authors

  1. V
    Vu Ngoc San <san.vu-ngoc@laposte.net>

Maintainers

  1. V
    Vu Ngoc San <san.vu-ngoc@laposte.net>

Sources

20250815.tar.gz
md5=991bc2e85df38feb23bddf84addd758d
sha512=8b777f7b479946528626c4112bf45600bee9aed0d94742e3eed0659f9a0517e41d0eaf398299920fd5b9f86065bd0e24035662d2df36f24f6a044c78e61dee01

doc/bogue/Bogue/Utils/index.html

Module Bogue.UtilsSource

Utilities.

This module contains several utilities, in particular for debug logs.

Dependency graph

Debugging

Sourceval printd : int -> ('a, unit, string, unit) format4 -> 'a

For instance printd debug_warning "The value x=%u is too big" x will print a message in the console only if the debug variable contains the debug_warning flag.

Sourceval debug : bool ref
Sourceval debug_code : int ref

Logical ored of !debug with debug flags (below) controls the amount of debuging.

Binary masks (=flags) for debugging messages.

Sourceval debug_thread : int
Sourceval debug_warning : int
Sourceval debug_graphics : int
Sourceval debug_error : int
Sourceval debug_io : int
Sourceval debug_memory : int
Sourceval debug_board : int
Sourceval debug_event : int
Sourceval debug_custom : int

Maths

Sourceval pi : float
Sourceval round : float -> int

Round float to nearest integer.

Sourceval imax : int -> int -> int

imax a b returns max(a, b). (Same as Int.max).

Sourceval imin : int -> int -> int

imin a b returns min(a, b). (Same as Int.min).

Tsdl Result

Sourceval go : 'a Tsdl.Sdl.result -> 'a

Transform a result into a standard value, or fail with an error. Used for SDL functions only.

Options

Monadic style operations on optional variables.

Sourceval map_option : 'a option -> ('a -> 'b) -> 'b option

map_option o f is the same as Option.map f o.

Sourceval do_option : 'a option -> ('a -> unit) -> unit

do_option o f is the same as Option.iter f o.

Sourceval default : 'a option -> 'a -> 'a

default o v is the same as Option.value o ~default:v. Warning: v is evaluated even if it is not used.

Sourceexception None_option
Sourceval remove_option : 'a option -> 'a

Like Option.get. Warning: remove_option None will raise the None_option exception.

Others

Sourceval (let@) : ('a -> 'b) -> 'a -> 'b
Sourceval run : (unit -> 'a) -> 'a

run f is equivalent to f ().