Flax/FlaxEngine
3
0
Fork 0
Code Issues Pull Requests Releases Activity

Add DefaultProbeCubemapFormat to Graphics Settings with option to compress env probe textures

Browse Source
This commit is contained in:
Wojciech Figat
2026-05-07 18:20:34 +02:00
parent c17a9f653e
commit 4489f43777
7 changed files with 112 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Flax.flaxproj
+1 -1
View File
@@ -4,7 +4,7 @@
"Major": 1,
"Minor": 13,
"Revision": 0,
"Build": 7001
"Build": 7002
},
"Company": "Flax",
"Copyright": "Copyright (c) 2012-2026 Wojciech Figat. All rights reserved.",
Flax.sln.DotSettings
+1
View File
@@ -257,6 +257,7 @@
<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EMigrateBlankLinesAroundFieldToBlankLinesAroundProperty/@EntryIndexedValue">True</s:Boolean>
<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EMigrateThisQualifierSettings/@EntryIndexedValue">True</s:Boolean>
<s:Boolean x:Key="/Default/GrammarAndSpelling/GrammarChecking/Exceptions/=Try_0020to_0020scripting/@EntryIndexedValue">True</s:Boolean>
<s:Boolean x:Key="/Default/GrammarAndSpelling/GrammarChecking/Exceptions/=will_0020fallback/@EntryIndexedValue">True</s:Boolean>
<s:String x:Key="/Default/GrammarAndSpelling/GrammarChecking/RulesStates/=LanguageTool_002EEN_002EE_005FG/@EntryIndexedValue">DisabledByUser</s:String>
<s:Boolean x:Key="/Default/PatternsAndTemplates/Todo/TodoPatterns/=EEA05B0ED8200E4BA9D2D3F1052EBFFD/@KeyIndexDefined">True</s:Boolean>
<s:String x:Key="/Default/PatternsAndTemplates/Todo/TodoPatterns/=EEA05B0ED8200E4BA9D2D3F1052EBFFD/Color/@EntryValue">Blue</s:String>
Source/Engine/Core/Config/GameSettings.cpp
+21 -1
View File
@@ -44,12 +44,32 @@ public:
IMPLEMENT_ENGINE_SETTINGS_GETTER(BuildSettings, GameCooking);
#include "Engine/Content/Deprecated.h"
PRAGMA_DISABLE_DEPRECATION_WARNINGS;
bool GraphicsSettings::GetUeeHDRProbes() const
{
return UseHDRProbes;
}
void GraphicsSettings::SetUeeHDRProbes(bool value)
{
MARK_CONTENT_DEPRECATED();
UseHDRProbes = value;
DefaultProbeCubemapFormat = value ? ProbeCubemapFormats::R11G11B10 : ProbeCubemapFormats::R8G8B8A8;
}
bool GraphicsSettings::GetUseHDRProbes() const
{
return UseHDRProbes;
}
void GraphicsSettings::SetUseHDRProbes(bool value)
{
DefaultProbeCubemapFormat = value ? ProbeCubemapFormats::R11G11B10 : ProbeCubemapFormats::R8G8B8A8;
}
PRAGMA_ENABLE_DEPRECATION_WARNINGS;
void GraphicsSettings::OnDeserializing(const CallbackContext& context)
{
#if 0 // TODO: move to Linear color space as default once it's ready for production
Source/Engine/Core/Config/GraphicsSettings.h
+28 -3
View File
@@ -31,6 +31,22 @@ public:
R16G16B16A16,
};
/// <summary>
/// The environment probes cubemap texture storage formats.
/// </summary>
API_ENUM(Attributes = "EnumDisplay(EnumDisplayAttribute.FormatMode.None)")
enum class ProbeCubemapFormats
{
// LDR uncompressed format (32-bit per pixel).
R8G8B8A8,
// HDR uncompressed format (32-bit per pixel, no alpha).
R11G11B10,
// HDR compressed format (8-bit per pixel, no alpha). Converted into ASTC/Basis for mobile/web. Realtime probes will fallback to R11G11B10.
BC6,
// HDR compressed format (8-bit per pixel). Converted into ASTC/Basis for mobile/web. Realtime probes will fallback to R11G11B10.
BC7,
};
public:
/// <summary>
/// Enables rendering synchronization with the refresh rate of the display device to avoid "tearing" artifacts.
@@ -87,9 +103,16 @@ public:
ProbeCubemapResolution DefaultProbeResolution = ProbeCubemapResolution::_128;
/// <summary>
/// If checked, Environment Probes will use HDR texture format. Improves quality in very bright scenes at cost of higher memory usage.
/// Environment Probes texture storage format. Controls the quality fo reflections and memory usage of probes data.
/// </summary>
API_FIELD(Attributes="EditorOrder(1502), EditorDisplay(\"Quality\")")
ProbeCubemapFormats DefaultProbeCubemapFormat = ProbeCubemapFormats::BC6;
/// <summary>
/// If checked, Environment Probes will use HDR texture format. Improves quality in very bright scenes at cost of higher memory usage.
/// [Deprecated in v1.13]
/// </summary>
DEPRECATED("Use DefaultProbeCubemapFormat instead.")
bool UseHDRProbes = false;
/// <summary>
@@ -175,8 +198,10 @@ private:
/// Renamed UeeHDRProbes into UseHDRProbes
/// [Deprecated on 12.10.2022, expires on 12.10.2024]
/// </summary>
API_PROPERTY(Attributes="Serialize, Obsolete, NoUndo") DEPRECATED("Use UseHDRProbes instead.") bool GetUeeHDRProbes() const { return UseHDRProbes; }
API_PROPERTY(Attributes="Serialize, Obsolete, NoUndo") DEPRECATED("Use UseHDRProbes instead.") void SetUeeHDRProbes(bool value);
API_PROPERTY(Attributes="Serialize, Obsolete, NoUndo") DEPRECATED("Use DefaultProbeCubemapFormat instead.") bool GetUeeHDRProbes() const;
API_PROPERTY(Attributes="Serialize, Obsolete, NoUndo") DEPRECATED("Use DefaultProbeCubemapFormat instead.") void SetUeeHDRProbes(bool value);
API_PROPERTY(Attributes="Serialize, Obsolete, NoUndo") DEPRECATED("Use DefaultProbeCubemapFormat instead.") bool GetUseHDRProbes() const;
API_PROPERTY(Attributes="Serialize, Obsolete, NoUndo") DEPRECATED("Use DefaultProbeCubemapFormat instead.") void SetUseHDRProbes(bool value);
API_FUNCTION(Attributes="OnDeserializing", Hidden) void OnDeserializing(const CallbackContext& context);
public:
Source/Engine/Platform/SettingsBase.cs
+11
View File
@@ -25,6 +25,17 @@ namespace FlaxEditor.Content.Settings
set => UseHDRProbes = value;
}
/// <summary>
/// Use DefaultProbeCubemapFormat instead
/// [Deprecated in v1.13]
/// </summary>
[Serialize, Obsolete, NoUndo]
private bool UseHDRProbes
{
get => UseHDRProbes;
set => DefaultProbeCubemapFormat = value ? ProbeCubemapFormats.R11G11B10 : ProbeCubemapFormats.R8G8B8A8;
}
/// <summary>
/// Initializes a new instance of the <see cref="GraphicsSettings"/>.
/// </summary>
Source/Engine/Renderer/ProbesRenderer.cpp
+46 -3
View File
@@ -25,6 +25,7 @@
#include "Engine/Graphics/Textures/TextureData.h"
#include "Engine/Graphics/RenderTask.h"
#include "Engine/Scripting/ScriptingObjectReference.h"
#include "Engine/Tools/TextureTool/TextureTool.h"
#include "Engine/Threading/ThreadPoolTask.h"
// Amount of frames to wait for data from probe update job
@@ -46,6 +47,7 @@ struct ProbeEntry
bool UseTextureData() const;
int32 GetResolution() const;
PixelFormat GetFormat() const;
PixelFormat GetStorageFormat() const;
};
// Custom task called after downloading probe texture data to save it.
@@ -70,16 +72,29 @@ public:
bool Run() override
{
// Compress texture data if needed
TextureData* data = &_data;
#if COMPILE_WITH_TEXTURE_TOOL
TextureData tmpData;
PixelFormat storageFormat = _entry.GetStorageFormat();
if (storageFormat != _data.Format)
{
if (TextureTool::Convert(tmpData, _data, storageFormat))
return true;
data = &tmpData;
}
#endif
Actor* actor = _entry.Actor.Get();
if (_entry.Type == ProbeEntry::Types::EnvProbe)
{
if (actor)
((EnvironmentProbe*)actor)->SetProbeData(_data);
((EnvironmentProbe*)actor)->SetProbeData(*data);
}
else if (_entry.Type == ProbeEntry::Types::SkyLight)
{
if (actor)
((SkyLight*)actor)->SetProbeData(_data);
((SkyLight*)actor)->SetProbeData(*data);
}
else
{
@@ -202,7 +217,35 @@ int32 ProbeEntry::GetResolution() const
PixelFormat ProbeEntry::GetFormat() const
{
return GraphicsSettings::Get()->UseHDRProbes ? PixelFormat::R11G11B10_Float : PixelFormat::R8G8B8A8_UNorm;
// Return render format (storage can be compressed during importing, realtime probes use uncompressed)
switch (GraphicsSettings::Get()->DefaultProbeCubemapFormat)
{
case GraphicsSettings::ProbeCubemapFormats::R8G8B8A8:
return PixelFormat::R8G8B8A8_UNorm;
case GraphicsSettings::ProbeCubemapFormats::R11G11B10:
case GraphicsSettings::ProbeCubemapFormats::BC6:
case GraphicsSettings::ProbeCubemapFormats::BC7:
return PixelFormat::R11G11B10_Float;
default:
return PixelFormat::Unknown;
}
}
PixelFormat ProbeEntry::GetStorageFormat() const
{
switch (GraphicsSettings::Get()->DefaultProbeCubemapFormat)
{
case GraphicsSettings::ProbeCubemapFormats::R8G8B8A8:
return PixelFormat::R8G8B8A8_UNorm;
case GraphicsSettings::ProbeCubemapFormats::R11G11B10:
return PixelFormat::R11G11B10_Float;
case GraphicsSettings::ProbeCubemapFormats::BC6:
return PixelFormat::BC6H_Uf16;
case GraphicsSettings::ProbeCubemapFormats::BC7:
return PixelFormat::BC7_UNorm;
default:
return PixelFormat::Unknown;
}
}
bool ProbesRendererService::LazyInit()
Source/Engine/Renderer/Renderer.Build.cs
+4
View File
@@ -15,5 +15,9 @@ public class Renderer : EngineModule
options.PrivateDependencies.Add("Graphics");
options.PrivateDependencies.Add("Content");
if (options.Target.IsEditor)
{
options.PrivateDependencies.Add("TextureTool");
}
}
}