Wiki Page Content

Differences between revisions 8 and 9
Revision 8 as of 2016-05-14 22:08:52
Size: 856
Comment: Added Version section.
Revision 9 as of 2016-05-14 22:10:02
Size: 855
Comment: Changed wording of description.
Deletions are marked like this. Additions are marked like this.
Line 5: Line 5:
Use this function to return whether the screensaver is currently enabled. Use this function to check whether the screensaver is currently enabled.

SDL_IsScreenSaverEnabled

Use this function to check whether the screensaver is currently enabled.

Syntax

SDL_bool SDL_IsScreenSaverEnabled(void)

Return Value

Returns SDL_TRUE if the screensaver is enabled, SDL_FALSE if it is disabled.

Code Examples

You can add your code example here

Remarks

The screensaver is disabled by default since SDL 2.0.2. Before SDL 2.0.2 the screensaver was enabled by default.

The default can also be changed using SDL_HINT_VIDEO_ALLOW_SCREENSAVER.

Version

This function is available since SDL 2.0.0.


CategoryAPI, CategoryVideo

None: SDL_IsScreenSaverEnabled (last edited 2016-05-14 22:10:02 by PhilippWiesemann)

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit