| UObjectBase
|
Module |
|
Header |
/Engine/Source/Runtime/Engine/Classes/GameFramework/GameUserSettings.h |
Include |
#include "GameFramework/GameUserSettings.h" |
class UGameUserSettings : public UObject
Stores user settings for a game (for example graphics and sound settings), with the ability to save and load to and from a file.
Name | Description | ||
---|---|---|---|
|
AudioQualityLevel |
||
|
bUseDesiredScreenHeight |
If true, the desired screen height will be used to scale the render resolution automatically. |
|
|
bUseDynamicResolution |
Whether to use dynamic resolution or not. (public to allow UI to connect to it) |
|
|
bUseHDRDisplayOutput |
HDR |
|
|
bUseVSync |
Whether to use VSync or not. (public to allow UI to connect to it) |
|
|
DesiredScreenHeight |
Desired screen height used to calculate the resolution scale when user changes display mode |
|
|
DesiredScreenWidth |
Desired screen width used to calculate the resolution scale when user changes display mode |
|
|
float |
FrameRateLimit |
Frame rate cap |
|
FullscreenMode |
Game window fullscreen mode 0 = Fullscreen 1 = Windowed fullscreen 2 = Windowed |
|
|
HDRDisplayOutputNits |
HDR |
|
|
LastConfirmedAudioQualityLevel |
||
|
LastConfirmedFullscreenMode |
Last user confirmed fullscreen mode setting. |
|
|
float |
LastCPUBenchmarkResult |
Result of the last benchmark (CPU); -1 if there has not been a benchmark run |
|
TArray< float > |
LastCPUBenchmarkSteps |
Result of each individual sub-section of the last CPU benchmark; empty if there has not been a benchmark run |
|
float |
LastGPUBenchmarkMultiplier |
Multiplier used against the last GPU benchmark |
|
float |
LastGPUBenchmarkResult |
Result of the last benchmark (GPU); -1 if there has not been a benchmark run |
|
TArray< float > |
LastGPUBenchmarkSteps |
Result of each individual sub-section of the last GPU benchmark; empty if there has not been a benchmark run |
|
float |
LastRecommendedScreenHeight |
Result of the last benchmark; calculated resolution to use. |
|
float |
LastRecommendedScreenWidth |
Result of the last benchmark; calculated resolution to use. |
|
LastUserConfirmedDesiredScreenHeight |
Desired screen height used to calculate the resolution scale when user changes display mode |
|
|
LastUserConfirmedDesiredScreenWidth |
Desired screen width used to calculate the resolution scale when user changes display mode |
|
|
LastUserConfirmedResolutionSizeX |
Game screen resolution width, in pixels. |
|
|
LastUserConfirmedResolutionSizeY |
Game screen resolution height, in pixels. |
|
|
float |
MinResolutionScale |
Min resolution scale we allow in current display mode |
|
PreferredFullscreenMode |
Fullscreen mode to use when toggling between windowed and fullscreen. |
|
|
ResolutionSizeX |
Game screen resolution width, in pixels. |
|
|
ResolutionSizeY |
Game screen resolution height, in pixels. |
|
|
ScalabilityQuality |
Cached for the UI, current state if stored in console variables |
|
|
Version |
All settings will be wiped and set to default if the serialized version differs from UE_GAMEUSERSETTINGS_VERSION. |
|
|
WindowPosX |
Window PosX |
|
|
WindowPosY |
Window PosY |
Name | Description | |
---|---|---|
|
UGameUserSettings ( |
Name | Description | ||
---|---|---|---|
|
ApplyHardwareBenchmarkResults() |
Applies the settings stored in ScalabilityQuality and saves settings |
|
|
ApplyNonResolutionSettings() |
||
|
ApplyResolutionSettings ( |
||
|
ApplySettings ( |
Applies all current user settings to the game and saves to permanent storage (e.g. file), optionally checking for command line overrides. |
|
|
ConfirmVideoMode() |
Mark current video mode settings (fullscreenmode/resolution) as being confirmed by the user |
|
|
EnableHDRDisplayOutput |
Enables or disables HDR display output. Can be called again to change the desired nit level |
|
|
float |
FindResolutionQualityForScreenSize ( |
Picks the best resolution quality for a given screen size |
|
GetAntiAliasingQuality() |
Returns the anti-aliasing quality (0..4, higher is better) |
|
|
GetAudioQualityLevel() |
Returns the user's audio quality level setting |
|
|
GetConfigDir() |
||
|
GetCurrentHDRDisplayNits() |
Returns 0 if HDR isn't supported or is turned off |
|
|
GetDefaultResolution() |
Returns the default resolution when no resolution is set |
|
|
float |
GetDefaultResolutionScale() |
Gets the desired resolution quality based on DesiredScreenWidth/Height and the current screen resolution |
|
EWindowMode:... |
GetDefaultWindowMode() |
Returns the default window mode when no mode is set |
|
GetDefaultWindowPosition() |
Returns the default window position when no position is set |
|
|
GetDesktopResolution() |
Returns user's desktop resolution, in pixels. |
|
|
float |
GetEffectiveFrameRateLimit() |
Returns the effective frame rate limit (by default it returns the FrameRateLimit member) |
|
GetFoliageQuality() |
Returns the foliage quality (0..4, higher is better) |
|
|
GetFramePace() |
Gets the current frame pacing frame rate in fps, or 0 if none |
|
|
float |
GetFrameRateLimit() |
Gets the user's frame rate limit (0 indiciates the frame rate limit is disabled) |
|
EWindowMode:... |
GetFullscreenMode() |
Returns the user setting for game window fullscreen mode. |
|
UGameUserSet... |
GetGameUserSettings() |
Returns the game local machine settings (resolution, windowing mode, scalability settings, etc...) |
|
EWindowMode:... |
GetLastConfirmedFullscreenMode() |
Returns the last confirmed user setting for game window fullscreen mode. |
|
GetLastConfirmedScreenResolution() |
Returns the last confirmed user setting for game screen resolution, in pixels. |
|
|
float |
GetLastCPUBenchmarkResult() |
Returns the last CPU benchmark result (set by RunHardwareBenchmark) |
|
TArray< floa... |
GetLastCPUBenchmarkSteps() |
Returns each individual step of the last CPU benchmark result (set by RunHardwareBenchmark) |
|
float |
GetLastGPUBenchmarkResult() |
Returns the last GPU benchmark result (set by RunHardwareBenchmark) |
|
TArray< floa... |
GetLastGPUBenchmarkSteps() |
Returns each individual step of the last GPU benchmark result (set by RunHardwareBenchmark) |
|
GetOverallScalabilityLevel() |
Returns the overall scalability level (can return -1 if the settings are custom) |
|
|
GetPostProcessingQuality() |
Returns the post-processing quality (0..4, higher is better) |
|
|
EWindowMode:... |
GetPreferredFullscreenMode() |
Returns the user setting for game window fullscreen mode. |
|
float |
GetRecommendedResolutionScale() |
Gets the recommended resolution quality based on LastRecommendedScreenWidth/Height and the current screen resolution |
|
GetResolutionScaleInformationEx ( |
Returns the current resolution scale and the range. |
|
|
float |
GetResolutionScaleNormalized() |
Gets the current resolution scale as a normalized 0..1 value between MinScaleValue and MaxScaleValue. |
|
GetScreenResolution() |
Returns the user setting for game screen resolution, in pixels. |
|
|
GetShadingQuality() |
Returns the shading quality (0..4, higher is better) |
|
|
GetShadowQuality() |
Returns the shadow quality (0..4, higher is better) |
|
|
GetTextureQuality() |
Returns the texture quality (0..4, higher is better) |
|
|
GetViewDistanceQuality() |
Returns the view distance quality (0..4, higher is better) |
|
|
GetVisualEffectQuality() |
Returns the visual effects quality (0..4, higher is better) |
|
|
GetWindowPosition() |
||
|
IsDirty() |
Checks if any user settings is different from current |
|
|
IsDynamicResolutionDirty() |
Checks if the dynamic resolution user setting is different from current system setting |
|
|
IsDynamicResolutionEnabled() |
Returns the user setting for dynamic resolution. |
|
|
IsFullscreenModeDirty() |
Checks if the FullscreenMode user setting is different from current |
|
|
IsHDREnabled() |
||
|
IsScreenResolutionDirty() |
Checks if the Screen Resolution user setting is different from current |
|
|
IsVersionValid() |
Check if the current version of the game user settings is valid. |
|
|
IsVSyncDirty() |
Checks if the vsync user setting is different from current system setting |
|
|
IsVSyncEnabled() |
Returns the user setting for vsync. |
|
|
LoadConfigIni ( |
Loads the user .ini settings into GConfig |
|
|
LoadSettings ( |
Loads the user settings from persistent storage |
|
|
PreloadResolutionSettings() |
Loads the resolution settings before is object is available |
|
|
RequestResolutionChange ( |
Request a change to the specified resolution and window mode. Optionally apply cmd line overrides. |
|
|
RequestUIUpdate() |
||
|
ResetToCurrentSettings() |
This function resets all settings to the current system settings |
|
|
RevertVideoMode() |
Revert video mode (fullscreenmode/resolution) back to the last user confirmed values |
|
|
RunHardwareBenchmark ( |
Runs the hardware benchmark and populates ScalabilityQuality as well as the last benchmark results config members, but does not apply the settings it determines. |
|
|
SaveSettings() |
Save the user settings to persistent storage (automatically happens as part of ApplySettings) |
|
|
SetAntiAliasingQuality ( |
Sets the anti-aliasing quality (0..4, higher is better) |
|
|
SetAudioQualityLevel ( |
Sets the user's audio quality level setting |
|
|
SetBenchmarkFallbackValues() |
Set scalability settings to sensible fallback values, for use when the benchmark fails or potentially causes a crash |
|
|
SetDynamicResolutionEnabled ( |
Sets the user setting for dynamic resolution. |
|
|
SetFoliageQuality ( |
Sets the foliage quality (0..4, higher is better) |
|
|
SetFrameRateLimit ( |
Sets the user's frame rate limit (0 will disable frame rate limiting) |
|
|
SetFrameRateLimitCVar ( |
Sets the frame rate limit CVar to the passed in value, 0.0 indicates no limit |
|
|
SetFullscreenMode ( |
Sets the user setting for the game window fullscreen mode. |
|
|
SetOverallScalabilityLevel ( |
Changes all scalability settings at once based on a single overall quality level |
|
|
SetPostProcessingQuality ( |
Sets the post-processing quality (0..4, higher is better) |
|
|
SetResolutionScaleNormalized ( |
Sets the current resolution scale as a normalized 0..1 value between MinScaleValue and MaxScaleValue. |
|
|
SetResolutionScaleValueEx ( |
Sets the current resolution scale. |
|
|
SetScreenResolution ( |
Sets the user setting for game screen resolution, in pixels. |
|
|
SetShadingQuality ( |
Sets the shading quality (0..4, higher is better) |
|
|
SetShadowQuality ( |
Sets the shadow quality (0..4, higher is better) |
|
|
SetSyncTypeCVar ( |
Sets the input latency mode 0 and 2 |
|
|
SetTextureQuality ( |
Sets the texture quality (0..4, higher is better) |
|
|
SetToDefaults() |
||
|
SetViewDistanceQuality ( |
Sets the view distance quality (0..4, higher is better) |
|
|
SetVisualEffectQuality ( |
Sets the visual effects quality (0..4, higher is better) |
|
|
SetVSyncEnabled ( |
Sets the user setting for vsync. |
|
|
SetWindowPosition |
||
|
SupportsHDRDisplayOutput() |
Whether the curently running system supports HDR display output |
|
|
UpdateResolutionQuality() |
||
|
UpdateVersion() |
Update the version of the game user settings to the current version |
|
|
ValidateSettings() |
Validates and resets bad user settings to default. Deletes stale user settings file if necessary. |
Name | Description | ||
---|---|---|---|
|
GetResolutionScaleInformation |
Please call GetResolutionScaleInformationEx |
|
|
GetSyncInterval() |
Please use GetFramePace to get the paced frame rate |
|
|
SetResolutionScaleValue ( |
Please call SetResolutionScaleValueEx |
|
|
SetSyncIntervalCVar ( |
Please use FPlatformRHIFramePacer::SetFramePace to set the desired frame rate |