include/SDL_power.h
author Gabriel Jacobo <gabomdq@gmail.com>
Fri, 16 Nov 2012 09:23:18 -0300
changeset 6674 45a21e50ba5e
parent 6138 4c64952a58fb
child 6885 700f1b25f77f
permissions -rw-r--r--
Adds CMake build system by Marcus Von Appen (bug #1597)
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2012 Sam Lantinga <slouken@libsdl.org>
     4 
     5   This software is provided 'as-is', without any express or implied
     6   warranty.  In no event will the authors be held liable for any damages
     7   arising from the use of this software.
     8 
     9   Permission is granted to anyone to use this software for any purpose,
    10   including commercial applications, and to alter it and redistribute it
    11   freely, subject to the following restrictions:
    12 
    13   1. The origin of this software must not be misrepresented; you must not
    14      claim that you wrote the original software. If you use this software
    15      in a product, an acknowledgment in the product documentation would be
    16      appreciated but is not required.
    17   2. Altered source versions must be plainly marked as such, and must not be
    18      misrepresented as being the original software.
    19   3. This notice may not be removed or altered from any source distribution.
    20 */
    21 
    22 #ifndef _SDL_power_h
    23 #define _SDL_power_h
    24 
    25 /**
    26  *  \file SDL_power.h
    27  *  
    28  *  Header for the SDL power management routines.
    29  */
    30 
    31 #include "SDL_stdinc.h"
    32 
    33 #include "begin_code.h"
    34 /* Set up for C function definitions, even when using C++ */
    35 #ifdef __cplusplus
    36 /* *INDENT-OFF* */
    37 extern "C" {
    38 /* *INDENT-ON* */
    39 #endif
    40 
    41 /**
    42  *  \brief The basic state for the system's power supply.
    43  */
    44 typedef enum
    45 {
    46     SDL_POWERSTATE_UNKNOWN,      /**< cannot determine power status */
    47     SDL_POWERSTATE_ON_BATTERY,   /**< Not plugged in, running on the battery */
    48     SDL_POWERSTATE_NO_BATTERY,   /**< Plugged in, no battery available */
    49     SDL_POWERSTATE_CHARGING,     /**< Plugged in, charging battery */
    50     SDL_POWERSTATE_CHARGED       /**< Plugged in, battery charged */
    51 } SDL_PowerState;
    52 
    53 
    54 /**
    55  *  \brief Get the current power supply details.
    56  *  
    57  *  \param secs Seconds of battery life left. You can pass a NULL here if
    58  *              you don't care. Will return -1 if we can't determine a
    59  *              value, or we're not running on a battery.
    60  *  
    61  *  \param pct Percentage of battery life left, between 0 and 100. You can
    62  *             pass a NULL here if you don't care. Will return -1 if we
    63  *             can't determine a value, or we're not running on a battery.
    64  *  
    65  *  \return The state of the battery (if any).
    66  */
    67 extern DECLSPEC SDL_PowerState SDLCALL SDL_GetPowerInfo(int *secs, int *pct);
    68 
    69 /* Ends C function definitions when using C++ */
    70 #ifdef __cplusplus
    71 /* *INDENT-OFF* */
    72 }
    73 /* *INDENT-ON* */
    74 #endif
    75 #include "close_code.h"
    76 
    77 #endif /* _SDL_power_h */
    78 
    79 /* vi: set ts=4 sw=4 expandtab: */