include/SDL_power.h
author Sam Lantinga <slouken@libsdl.org>
Mon, 18 Jun 2018 13:14:04 -0700
changeset 12025 39a92b19f99e
parent 11811 5d94cb6b24d3
permissions -rw-r--r--
Use a blank cursor instead of PointerIcon.TYPE_NULL since that shows the default cursor on Samsung DeX
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2018 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 extern "C" {
    37 #endif
    38 
    39 /**
    40  *  \brief The basic state for the system's power supply.
    41  */
    42 typedef enum
    43 {
    44     SDL_POWERSTATE_UNKNOWN,      /**< cannot determine power status */
    45     SDL_POWERSTATE_ON_BATTERY,   /**< Not plugged in, running on the battery */
    46     SDL_POWERSTATE_NO_BATTERY,   /**< Plugged in, no battery available */
    47     SDL_POWERSTATE_CHARGING,     /**< Plugged in, charging battery */
    48     SDL_POWERSTATE_CHARGED       /**< Plugged in, battery charged */
    49 } SDL_PowerState;
    50 
    51 
    52 /**
    53  *  \brief Get the current power supply details.
    54  *
    55  *  \param secs Seconds of battery life left. You can pass a NULL here if
    56  *              you don't care. Will return -1 if we can't determine a
    57  *              value, or we're not running on a battery.
    58  *
    59  *  \param pct Percentage of battery life left, between 0 and 100. You can
    60  *             pass a NULL here if you don't care. Will return -1 if we
    61  *             can't determine a value, or we're not running on a battery.
    62  *
    63  *  \return The state of the battery (if any).
    64  */
    65 extern DECLSPEC SDL_PowerState SDLCALL SDL_GetPowerInfo(int *secs, int *pct);
    66 
    67 /* Ends C function definitions when using C++ */
    68 #ifdef __cplusplus
    69 }
    70 #endif
    71 #include "close_code.h"
    72 
    73 #endif /* SDL_power_h_ */
    74 
    75 /* vi: set ts=4 sw=4 expandtab: */