mirrors
/
SDL
mirror of https://github.com/libsdl-org/SDL
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
SDL/include/SDL3/SDL_power.h

94 lines
3.4 KiB
C
Raw Permalink Normal View History

Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 18:33:46 +03:00
/*
Simple DirectMedia Layer
Updated copyright for 2024
2024-01-02 00:15:26 +03:00
Copyright (C) 1997-2024 Sam Lantinga <slouken@libsdl.org>
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 18:33:46 +03:00
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/
Renaming of guard header names to quiet -Wreserved-id-macro Patch contributed by Sylvain
2016-11-21 08:34:54 +03:00
#ifndef SDL_power_h_
#define SDL_power_h_
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 18:33:46 +03:00
/**
wikiheaders: bridge wiki Category docs to the headers! Did an initial cleanup on the headers and wrote a few pieces of documentation, but this needs more work to fill out the documentation.
2024-05-16 17:44:37 +03:00
* # CategoryPower
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 18:33:46 +03:00
*
wikiheaders: bridge wiki Category docs to the headers! Did an initial cleanup on the headers and wrote a few pieces of documentation, but this needs more work to fill out the documentation.
2024-05-16 17:44:37 +03:00
* SDL power management routines.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 18:33:46 +03:00
*/
Switch header convention from `#include "SDL.h"` to `#include <SDL3/SDLh>` I ran this script in the include directory: ```sh sed -i '' -e 's,#include "\(SDL.*\)",#include <SDL3/\1>,' *.h ``` I ran this script in the src directory: ```sh for i in ../include/SDL3/SDL*.h do hdr=$(basename $i) if [ x"$(echo $hdr | egrep 'SDL_main|SDL_name|SDL_test|SDL_syswm|SDL_opengl|SDL_egl|SDL_vulkan')" != x ]; then find . -type f -exec sed -i '' -e 's,#include "\('$hdr'\)",#include <SDL3/\1>,' {} \; else find . -type f -exec sed -i '' -e '/#include "'$hdr'"/d' {} \; fi done ``` Fixes https://github.com/libsdl-org/SDL/issues/6575
2022-11-27 07:43:38 +03:00
#include <SDL3/SDL_stdinc.h>
Including SD_error.h into headers with error-returning functions
2024-04-04 19:38:21 +03:00
#include <SDL3/SDL_error.h>
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 18:33:46 +03:00
include: Renamed begin_code.h and close_code.h to have SDL_ prefixes. Fixes #6864.
2022-12-22 19:38:59 +03:00
#include <SDL3/SDL_begin_code.h>
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 18:33:46 +03:00
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
extern "C" {
#endif
/**
include: A ton of little documentation tweaks, fixes, and improvements. This is just stuff I noticed while working on the wikiheaders updates. A thorough pass over all the docs would not be terrible, and maybe a simple script to check for consistency (does everything have a `\since` on it? etc) might be nice, too.
2024-04-09 05:36:57 +03:00
* The basic state for the system's power supply.
*
* These are results returned by SDL_GetPowerInfo().
*
fnsince: update `\since` policy for documentation. Everything in SDL3 up to the ABI lock is reported as available since 3.1.3. Everything else will be reported as since 3.2.0 (what will be the first official release). Also ran a Perl script over the headers to change everything to 3.1.3 that wasn't an API function, since fnsince.pl can't manage those. If there's a macro or datatype that has snuck in that needs to be 3.2.0 instead, we'll have to manually fix it up, but it shouldn't be a big deal in any case. Reference PR #11304.
2024-10-23 19:19:38 +03:00
* \since This enum is available since SDL 3.1.3
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 18:33:46 +03:00
*/
include: A ton of little documentation tweaks, fixes, and improvements. This is just stuff I noticed while working on the wikiheaders updates. A thorough pass over all the docs would not be terrible, and maybe a simple script to check for consistency (does everything have a `\since` on it? etc) might be nice, too.
2024-04-09 05:36:57 +03:00
typedef enum SDL_PowerState
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 18:33:46 +03:00
{
Separate joystick power state into battery status and percentage This allows you to see battery percentage while the controller is charging
2024-03-30 20:55:13 +03:00
SDL_POWERSTATE_ERROR = -1, /**< error determining power status */
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 18:33:46 +03:00
SDL_POWERSTATE_UNKNOWN, /**< cannot determine power status */
SDL_POWERSTATE_ON_BATTERY, /**< Not plugged in, running on the battery */
SDL_POWERSTATE_NO_BATTERY, /**< Plugged in, no battery available */
SDL_POWERSTATE_CHARGING, /**< Plugged in, charging battery */
SDL_POWERSTATE_CHARGED /**< Plugged in, battery charged */
} SDL_PowerState;
/**
First shot at merging the wiki documentation into the headers.
2021-03-21 21:18:39 +03:00
* Get the current power supply details.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 18:33:46 +03:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 21:18:39 +03:00
* You should never take a battery status as absolute truth. Batteries
* (especially failing batteries) are delicate hardware, and the values
* reported here are best estimates based on what that hardware reports. It's
* not uncommon for older batteries to lose stored power much faster than it
* reports, or completely drain when reporting it has 20 percent left, etc.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 18:33:46 +03:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 21:18:39 +03:00
* Battery status can change at any time; if you are concerned with power
* state, you should call this function frequently, and perhaps ignore changes
* until they seem to be stable for a few seconds.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 18:33:46 +03:00
*
First shot at merging the wiki documentation into the headers.
2021-03-21 21:18:39 +03:00
* It's possible a platform can only report battery percentage or time left
* but not both.
*
Sync SDL3 wiki -> header
2024-04-02 00:00:26 +03:00
* \param seconds a pointer filled in with the seconds of battery life left,
* or NULL to ignore. This will be filled in with -1 if we
* can't determine a value or there is no battery.
* \param percent a pointer filled in with the percentage of battery life
* left, between 0 and 100, or NULL to ignore. This will be
* filled in with -1 we can't determine a value or there is no
* battery.
* \returns the current battery state or `SDL_POWERSTATE_ERROR` on failure;
* call SDL_GetError() for more information.
Sync wiki -> header
2021-10-27 04:36:05 +03:00
*
fnsince: update `\since` policy for documentation. Everything in SDL3 up to the ABI lock is reported as available since 3.1.3. Everything else will be reported as since 3.2.0 (what will be the first official release). Also ran a Perl script over the headers to change everything to 3.1.3 that wasn't an API function, since fnsince.pl can't manage those. If there's a macro or datatype that has snuck in that needs to be 3.2.0 instead, we'll have to manually fix it up, but it shouldn't be a big deal in any case. Reference PR #11304.
2024-10-23 19:19:38 +03:00
* \since This function is available since SDL 3.1.3.
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 18:33:46 +03:00
*/
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-18 02:52:36 +03:00
extern SDL_DECLSPEC SDL_PowerState SDLCALL SDL_GetPowerInfo(int *seconds, int *percent);
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 18:33:46 +03:00
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
}
#endif
include: Renamed begin_code.h and close_code.h to have SDL_ prefixes. Fixes #6864.
2022-12-22 19:38:59 +03:00
#include <SDL3/SDL_close_code.h>
Fixed crash if initialization of EGL failed but was tried again later. The internal function SDL_EGL_LoadLibrary() did not delete and remove a mostly uninitialized data structure if loading the library first failed. A later try to use EGL then skipped initialization and assumed it was previously successful because the data structure now already existed. This led to at least one crash in the internal function SDL_EGL_ChooseConfig() because a NULL pointer was dereferenced to make a call to eglBindAPI().
2015-06-21 18:33:46 +03:00
Renaming of guard header names to quiet -Wreserved-id-macro Patch contributed by Sylvain
2016-11-21 08:34:54 +03:00
#endif /* SDL_power_h_ */