BramReuling/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2026-06-27 08:18:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

locale: Added docs to SDL_Locale struct, to fix wiki docs.

Browse source
This commit is contained in:
Ryan C. Gordon 2026-06-22 22:09:23 -04:00
parent ca94cb5db0
commit 56846df9b0
No known key found for this signature in database
GPG key ID: FA148B892AB48044
1 changed files with 13 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

14
include/SDL_locale.h
View file

@ -39,13 +39,25 @@ extern "C" {
/* *INDENT-ON* */
#endif
/**
* A struct to provide locale data.
*
* Locale data is split into a spoken language, like English, and an optional
* country, like Canada. The language will be in ISO-639 format (so English
* would be "en"), and the country, if not NULL, will be an ISO-3166 country
* code (so Canada would be "CA").
*
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_GetPreferredLocales
*/
typedef struct SDL_Locale
{
const char *language; /**< A language name, like "en" for English. */
const char *country; /**< A country, like "US" for America. Can be NULL. */
} SDL_Locale;
/**
* Report the user's preferred locale.
*