mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2026-05-04 04:54:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

time: Use a function instead of properties to retrieve the system date and time locale info

Browse Source 
This allows applications to re-query the values if the system locale is changed during runtime, and better matches the other locale functions. A note is included in the documentation mentioning that this can be slow, as it has to call into OS functions.

Also allows for the removal of the init/quit time functions, as they are no longer needed.
This commit is contained in:
Frank Praznik
2024-05-08 13:32:37 -04:00
parent e909c0360f
commit 1f43c88220
14 changed files with 119 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
include/SDL3/SDL_time.h
View File

@@ -61,7 +61,7 @@ typedef struct SDL_DateTime
*
* \since This enum is available since SDL 3.0.0.
*
* \sa SDL_PROP_GLOBAL_SYSTEM_DATE_FORMAT_NUMBER
* \sa SDL_GetDateTimeLocalePreferences
*/
typedef enum SDL_DateFormat
{
@@ -75,7 +75,7 @@ typedef enum SDL_DateFormat
*
* \since This enum is available since SDL 3.0.0.
*
* \sa SDL_PROP_GLOBAL_SYSTEM_TIME_FORMAT_NUMBER
* \sa SDL_GetDateTimeLocalePreferences
*/
typedef enum SDL_TimeFormat
{
@@ -83,28 +83,20 @@ typedef enum SDL_TimeFormat
SDL_TIME_FORMAT_12HR = 1 /**< 12 hour time */
} SDL_TimeFormat;
/* Global date/time properties. */
/**
* The SDL_DateFormat to use as the preferred date display format for the
* current system locale.
* Gets the current preferred date and time format for the system locale.
*
* \since This macro is available since SDL 3.0.0.
* This might be a "slow" call that has to query the operating system. It's
* best to ask for this once and save the results. However, the preferred formats
* can change, usually because the user has changed a system preference outside of
* your program.
*
* \sa SDL_PROP_GLOBAL_SYSTEM_TIME_FORMAT_NUMBER
* \param dateFormat a pointer to the SDL_DateFormat to hold the returned date format, may be NULL
* \param timeFormat a pointer to the SDL_TimeFormat to hold the returned time format, may be NULL
*
* \since This function is available since SDL 3.0.0.
*/
#define SDL_PROP_GLOBAL_SYSTEM_DATE_FORMAT_NUMBER "SDL.time.date_format"
/**
* The SDL_TimeFormat to use as the preferred time display format for the
* current system locale.
*
* \since This macro is available since SDL 3.0.0.
*
* \sa SDL_PROP_GLOBAL_SYSTEM_DATE_FORMAT_NUMBER
*/
#define SDL_PROP_GLOBAL_SYSTEM_TIME_FORMAT_NUMBER "SDL.time.time_format"
extern DECLSPEC int SDLCALL SDL_GetDateTimeLocalePreferences(SDL_DateFormat *dateFormat, SDL_TimeFormat *timeFormat);
/**
* Gets the current value of the system realtime clock in nanoseconds since