Settings Namespace Reference

Classes
struct	AccessibilitySettings
	Binary struct for storing accessibility settings. More...

Enumerations
enum class	ColorblindFilterType : uint8_t {   NONE = 0 , PROTANOPIA = 1 , DEUTERANOPIA = 2 , TRITANOPIA = 3 ,   MONOCHROMACY = 4 }
	Colorblind filter types (matches AccessibilityMenu::ColorblindFilter) More...

Functions
bool	SaveSettings (const AccessibilitySettings &settings, const char *filePath=SETTINGS_FILE_PATH)
	Save accessibility settings to file (C-style binary write)
bool	LoadSettings (AccessibilitySettings &settings, const char *filePath=SETTINGS_FILE_PATH)
	Load accessibility settings from file (C-style binary read)
bool	SettingsFileExists (const char *filePath=SETTINGS_FILE_PATH)
	Check if settings file exists.

Variables
constexpr uint32_t	SETTINGS_MAGIC = 0x52545950
	Magic number to identify valid settings files.
constexpr uint32_t	SETTINGS_VERSION = 1
	Current settings version for forward compatibility.
constexpr const char *	SETTINGS_FILE_PATH = ".rtype_settings"
	Default settings file path.

Enumeration Type Documentation

ColorblindFilterType

enum class Settings::ColorblindFilterType : uint8_t

strong

Colorblind filter types (matches AccessibilityMenu::ColorblindFilter)

Enumerator
NONE
PROTANOPIA
DEUTERANOPIA
TRITANOPIA
MONOCHROMACY

Definition at line 34 of file AccessibilitySettings.hpp.

Function Documentation

LoadSettings()

bool Settings::LoadSettings ( AccessibilitySettings &  settings, const char *  filePath = SETTINGS_FILE_PATH  )

inline

Load accessibility settings from file (C-style binary read)

Parameters

settings	The settings struct to load into
filePath	Path to the settings file (default: .rtype_settings)

Returns

true if load was successful and settings are valid

Definition at line 103 of file AccessibilitySettings.hpp.

References Settings::AccessibilitySettings::IsValid(), and Settings::AccessibilitySettings::SetDefaults().

Referenced by Rendering::LoadAccessibilitySettings().

Here is the call graph for this function:

SaveSettings()

bool Settings::SaveSettings ( const AccessibilitySettings &  settings, const char *  filePath = SETTINGS_FILE_PATH  )

inline

Save accessibility settings to file (C-style binary write)

Parameters

settings	The settings struct to save
filePath	Path to the settings file (default: .rtype_settings)

Returns

true if save was successful

Definition at line 84 of file AccessibilitySettings.hpp.

Referenced by Rendering::SaveAccessibilitySettings().

SettingsFileExists()

bool Settings::SettingsFileExists ( const char *  filePath = SETTINGS_FILE_PATH )

inline

Check if settings file exists.

Parameters

filePath

Path to the settings file (default: .rtype_settings)

Returns

true if file exists

Definition at line 128 of file AccessibilitySettings.hpp.

Variable Documentation

SETTINGS_FILE_PATH

constexpr const char* Settings::SETTINGS_FILE_PATH = ".rtype_settings"

constexpr

Default settings file path.

Definition at line 29 of file AccessibilitySettings.hpp.

Referenced by Rendering::LoadAccessibilitySettings(), and Rendering::SaveAccessibilitySettings().

SETTINGS_MAGIC

constexpr uint32_t Settings::SETTINGS_MAGIC = 0x52545950

constexpr

Magic number to identify valid settings files.

Definition at line 19 of file AccessibilitySettings.hpp.

Referenced by Settings::AccessibilitySettings::IsValid(), and Settings::AccessibilitySettings::SetDefaults().

SETTINGS_VERSION

constexpr uint32_t Settings::SETTINGS_VERSION = 1

constexpr

Current settings version for forward compatibility.

Definition at line 24 of file AccessibilitySettings.hpp.

Referenced by Settings::AccessibilitySettings::IsValid(), and Settings::AccessibilitySettings::SetDefaults().