Module OcsfmlWindow.VideoMode

module VideoMode: sig .. end
VideoMode.t defines a video mode (width, height, bpp)

A video mode is defined by a width and a height (in pixels) and a depth (in bits per pixel).

Video modes are used to setup windows (window) at creation time.

The main usage of video modes is for fullscreen mode: indeed you must use one of the valid video modes allowed by the OS (which are defined by what the monitor and the graphics card support), otherwise your window creation will just fail.

VideoMode.t provides a static function for retrieving the list of all the video modes supported by the system: get_fullscreen_modes().

A custom video mode can also be checked directly for fullscreen compatibility with its is_valid() function.

Additionnally, the module VideoMode provides a function to get the mode currently used by the desktop: get_desktop_mode(). This allows to build windows with the same size or pixel depth as the current resolution.


type t = {
   width : int; (*Video mode width, in pixels.*)
   height : int; (*Video mode height, in pixels.*)
   bits_per_pixel : int; (*Video mode pixel depth, in bits per pixels.*)
}
val create : ?w:int -> ?h:int -> ?bpp:int -> unit -> t
val is_valid : t -> bool
Tell whether or not the video mode is valid.

The validity of video modes is only relevant when using fullscreen windows; otherwise any video mode can be used with no restriction.
Returns True if the video mode is valid for fullscreen mode

val get_full_screen_modes : unit -> t array
Retrieve all the video modes supported in fullscreen mode.

When creating a fullscreen window, the video mode is restricted to be compatible with what the graphics driver and monitor support. This function returns the complete list of all video modes that can be used in fullscreen mode. The returned array is sorted from best to worst, so that the first element will always give the best mode (higher width, height and bits-per-pixel).
Returns Array containing all the supported fullscreen modes

val get_desktop_mode : unit -> t
Get the current desktop video mode.
Returns Current desktop video mode