View on GitHub

DSFML

dsfml.window.videomode

A module containing the VideoMode Struct

struct VideoMode;
VideoMode 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 class) 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 provides a static function for retrieving the list of all the video modes supported by the system: getFullscreenModes().

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

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

uint width;
Video mode width, in pixels.

uint height;
Video mode height, in pixels.

uint bitsPerPixel;
Video mode pixel depth, in bits per pixels.

this(uint Width, uint Height, uint bits = 32);
Construct the video mode with its attributes.

Params:
modeWidth Width in pixels.
modeHeight Height in pixels.
modeBitsPerPixel Pixel depths in bits per pixel.

static VideoMode getDesktopMode();
Get the current desktop video mode.

Returns:
Current desktop video mode.

static VideoMode[] getFullscreenModes();
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.

const bool isValid();
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.

string toString();
Returns a string representation of the video mode.

Returns:
The video mode as a string in terms of width, height, and bits per pixel.