VideoMode.h File Reference

#include <SFML/Config.h>

Go to the source code of this file.


Data Structures

struct  sfVideoMode
 sfVideoMode defines a video mode (width, height, bpp, frequency) and provides functions for getting modes supported by the display device More...

Functions

CSFML_API sfVideoMode sfVideoMode_GetDesktopMode ()
 Get the current desktop video mode.
CSFML_API sfVideoMode sfVideoMode_GetMode (size_t Index)
 Get a valid video mode Index must be in range [0, GetModesCount()[ Modes are sorted from best to worst.
CSFML_API size_t sfVideoMode_GetModesCount ()
 Get valid video modes count.
CSFML_API sfBool sfVideoMode_IsValid (sfVideoMode Mode)
 Tell whether or not a video mode is supported.

Function Documentation

CSFML_API sfVideoMode sfVideoMode_GetDesktopMode (  ) 

Get the current desktop video mode.

Returns:
Current desktop video mode

CSFML_API sfVideoMode sfVideoMode_GetMode ( size_t  Index  ) 

Get a valid video mode Index must be in range [0, GetModesCount()[ Modes are sorted from best to worst.

Parameters:
Index : Index of video mode to get
Returns:
Corresponding video mode (invalid mode if index is out of range)

CSFML_API size_t sfVideoMode_GetModesCount (  ) 

Get valid video modes count.

Returns:
Number of valid video modes available

CSFML_API sfBool sfVideoMode_IsValid ( sfVideoMode  Mode  ) 

Tell whether or not a video mode is supported.

Parameters:
Mode : Video mode to check
Returns:
True if video mode is supported, false otherwise