LimenGraphicSettingsLibrary
Overview
LimenGraphicSettingsLibrary is a utility class providing Blueprint callable functions for managing graphical settings such as resolution, window mode, and quality levels. It interacts with Unreal Engine's GameUserSettings to retrieve and set these settings.
Properties
Type | Name | Access | Description |
|---|---|---|---|
FText | LevelTextRepresentation | BlueprintReadOnly | Represents the text representation of a quality level. |
TEnumAsByte | Level | AllowPrivateAccess, BlueprintReadOnly | Enum representing the quality level. |
Functions
Return Type | Signature | Description |
|---|---|---|
TArray | GetSupportedResolutions() | Returns an array of supported resolutions. |
FResolutionData | GetCurrentResolution() | Returns the current resolution. |
FResolutionData | GetDefaultResolution() | Returns the default resolution. |
void | SetResolution(const FString& InResolution) | Sets the screen resolution based on a string input. |
TArray | GetAllWindowModes() | Returns an array of all available window modes. |
const FWindowModeData& | GetFullscreenModeData() | Returns the data for fullscreen mode. |
const FWindowModeData& | GetWindowedModeData() | Returns the data for windowed mode. |
const FWindowModeData& | GetWindowedFullscreenModeData() | Returns the data for windowed fullscreen mode. |
FWindowModeData | GetCurrentWindowMode() | Returns the current window mode. |
void | SetWindowMode(const FString& InWindowMode) | Sets the window mode based on a string input. |
TArray | GetAllQualityLevels() | Returns an array of all available quality levels. |
FQualityLevelData | GetOverallQualityLevel() | Returns the current overall quality level. |
void | SetOverallQualityLevel(const FString& InQualityLevel) | Sets the overall quality level based on a string input. |
void | GetResolutionScale(float& CurrentScaleNormalized, float& CurrentScaleValue, float& MinScaleValue, float& MaxScaleValue) | Retrieves information about the current resolution scale. |
void | SetResolutionScale(const float InResolutionQuality) | Sets the resolution scale value based on a float input. |
FQualityLevelData | GetViewDistanceQuality() | Returns the current view distance quality level. |
void | SetViewDistanceQuality(const FQualityLevelData& InViewDistanceQuality) | Sets the view distance quality level based on a |
FQualityLevelData | GetAntiAliasingQuality() | Returns the current anti-aliasing quality level. |
void | SetAntiAliasingQuality(const FQualityLevelData& InAntiAliasingQuality) | Sets the anti-aliasing quality level based on a |
FQualityLevelData | GetShadowQuality() | Returns the current shadow quality level. |
void | SetShadowQuality(const FQualityLevelData& InQuality) | Sets the shadow quality level based on a |
FQualityLevelData | GetGlobalIlluminationQuality() | Returns the current global illumination quality level. |
void | SetGlobalIlluminationQuality(const FQualityLevelData& InQuality) | Sets the global illumination quality level based on a |
FQualityLevelData | GetReflectionQuality() | Returns the current reflection quality level. |
void | SetReflectionQuality(const FQualityLevelData& InQuality) | Sets the reflection quality level based on a |
FQualityLevelData | GetPostProcessQuality() | Returns the current post-processing quality level. |
void | SetPostProcessQuality(const FQualityLevelData& InQuality) | Sets the post-processing quality level based on a |
FQualityLevelData | GetTextureQuality() | Returns the current texture quality level. |
void | SetTextureQuality(const FQualityLevelData& InQuality) | Sets the texture quality level based on a |
FQualityLevelData | GetVisualEffectsQuality() | Returns the current visual effects quality level. |
void | SetVisualEffectsQuality(const FQualityLevelData& InQuality) | Sets the visual effects quality level based on a |
FQualityLevelData | GetFoliageQuality() | Returns the current foliage quality level. |
void | SetFoliageQuality(const FQualityLevelData& InQuality) | Sets the foliage quality level based on a |
FQualityLevelData | GetShadingQuality() | Returns the current shading quality level. |
void | SetShadingQuality(const FQualityLevelData& InQuality) | Sets the shading quality level based on a |
void | ApplyAllSettings() | Applies all settings to the game user settings. |
void | SaveAllSettings() | Saves all settings to the configuration file. |
void | EnableRayTracing(const bool bEnable) | Enables or disables ray tracing based on a boolean input. |
bool | IsRayTracingEnabled() | Returns whether ray tracing is currently enabled. |
bool | IsRaytracingSupported() | Checks if ray tracing is supported by the current hardware and driver. |
Usage & Implementation Notes
This library interacts with Unreal Engine's
GameUserSettingsto manage graphical settings.Functions are designed to be called from Blueprints for easy integration into game logic.
The implementation ensures thread safety and proper error handling through checks and assertions.