Locale Info

SDL locale services. More...

Typedefs
using	SDL::Locale = SDL_Locale
	A struct to provide locale data.

Functions
OwnArray< Locale * >	SDL::GetPreferredLocales ()
	Report the user's preferred locale.

Detailed Description

This provides a way to get a list of preferred locales (language plus country) for the user. There is exactly one function: GetPreferredLocales(), which handles all the heavy lifting, and offers documentation on all the strange ways humans might have configured their language settings.

Typedef Documentation

Locale

using SDL::Locale = typedef SDL_Locale

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 nullptr, will be an ISO-3166 country code (so Canada would be "CA").

Since

This function is available since SDL 3.2.0.

See also

GetPreferredLocales

Function Documentation

GetPreferredLocales()

OwnArray< Locale * > SDL::GetPreferredLocales ( )

inline

Returned language strings are in the format xx, where 'xx' is an ISO-639 language specifier (such as "en" for English, "de" for German, etc). Country strings are in the format YY, where "YY" is an ISO-3166 country code (such as "US" for the United States, "CA" for Canada, etc). Country might be nullptr if there's no specific guidance on them (so you might get { "en", "US" } for American English, but { "en", nullptr } means "English language, generically"). Language strings are never nullptr, except to terminate the array.

Please note that not all of these strings are 2 characters; some are three or more.

The returned list of locales are in the order of the user's preference. For example, a German citizen that is fluent in US English and knows enough Japanese to navigate around Tokyo might have a list like: { "de", "en_US", "jp", nullptr }. Someone from England might prefer British English (where "color" is spelled "colour", etc), but will settle for anything like it: { "en_GB", "en", nullptr }.

This function returns nullptr on error, including when the platform does not supply this information at all.

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, this list can change, usually because the user has changed a system preference outside of your program; SDL will send an EVENT_LOCALE_CHANGED event in this case, if possible, and you can call this function again to get an updated copy of preferred locales.

Returns

a nullptr terminated array of locale pointers on success.

Exceptions

Error

on failure.

Since

This function is available since SDL 3.2.0.