Mercurial > sdl-ios-xcode

comparison include/SDL_power.h @ 3407:d3baf5ac4e37

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Partial fix for bug #859 Header file update from Ken for improved doxygen output
author Sam Lantinga <slouken@libsdl.org>
date Mon, 19 Oct 2009 13:31:58 +0000
parents b7a48f533966
children 78475292e059
comparison
equal deleted inserted replaced
3406:8ae607392409 3407:d3baf5ac4e37
22 22
23 #ifndef _SDL_power_h 23 #ifndef _SDL_power_h
24 #define _SDL_power_h 24 #define _SDL_power_h
25 25
26 /** 26 /**
27 * \file SDL_power.h 27 * \file SDL_power.h
28 * 28 *
29 * Header for the SDL power management routines 29 * Header for the SDL power management routines.
30 */ 30 */
31 31
32 #include "SDL_stdinc.h" 32 #include "SDL_stdinc.h"
33 33
34 #include "begin_code.h" 34 #include "begin_code.h"
38 extern "C" { 38 extern "C" {
39 /* *INDENT-ON* */ 39 /* *INDENT-ON* */
40 #endif 40 #endif
41 41
42 /** 42 /**
43 * \enum SDL_PowerState 43 * \brief The basic state for the system's power supply.
44 *
45 * \brief The basic state for the system's power supply.
46 */ 44 */
47 typedef enum 45 typedef enum
48 { 46 {
49 SDL_POWERSTATE_UNKNOWN, /**< cannot determine power status */ 47 SDL_POWERSTATE_UNKNOWN, /**< cannot determine power status */
50 SDL_POWERSTATE_ON_BATTERY, /**< Not plugged in, running on the battery */ 48 SDL_POWERSTATE_ON_BATTERY, /**< Not plugged in, running on the battery */
53 SDL_POWERSTATE_CHARGED, /**< Plugged in, battery charged */ 51 SDL_POWERSTATE_CHARGED, /**< Plugged in, battery charged */
54 } SDL_PowerState; 52 } SDL_PowerState;
55 53
56 54
57 /** 55 /**
58 * \fn int SDL_GetPowerInfo(void) 56 * \brief Get the current power supply details.
59 * 57 *
60 * \brief Get the current power supply details. 58 * \param secs Seconds of battery life left. You can pass a NULL here if
61 * 59 * you don't care. Will return -1 if we can't determine a
62 * \param secs Seconds of battery life left. You can pass a NULL here if 60 * value, or we're not running on a battery.
63 * you don't care. Will return -1 if we can't determine a 61 *
64 * value, or we're not running on a battery. 62 * \param pct Percentage of battery life left, between 0 and 100. You can
65 * 63 * pass a NULL here if you don't care. Will return -1 if we
66 * \param pct Percentage of battery life left, between 0 and 100. You can 64 * can't determine a value, or we're not running on a battery.
67 * pass a NULL here if you don't care. Will return -1 if we 65 *
68 * can't determine a value, or we're not running on a battery. 66 * \return The state of the battery (if any).
69 *
70 * \return The state of the battery (if any).
71 */ 67 */
72 extern DECLSPEC SDL_PowerState SDLCALL SDL_GetPowerInfo(int *secs, int *pct); 68 extern DECLSPEC SDL_PowerState SDLCALL SDL_GetPowerInfo(int *secs, int *pct);
73 69
74 /* Ends C function definitions when using C++ */ 70 /* Ends C function definitions when using C++ */
75 #ifdef __cplusplus 71 #ifdef __cplusplus