r.Mobile.AllowDistanceFieldShadows
r.Mobile.AllowDistanceFieldShadows
#Overview
name: r.Mobile.AllowDistanceFieldShadows
The value of this variable can be defined or overridden in .ini config files. 1 .ini config file referencing this setting variable.
This variable is created as a Console Variable (cvar).
- type:
Var - help:
0: Do not generate shader permutations to render distance field shadows from stationary directional lights.\n1: Generate shader permutations to render distance field shadows from stationary directional lights. (default)
It is referenced in 10 C++ source files.
#Summary
#Usage in the C++ source code
The purpose of r.Mobile.AllowDistanceFieldShadows is to control the generation of shader permutations for rendering distance field shadows from stationary directional lights on mobile platforms.
This setting variable is primarily used in the rendering system, specifically for mobile platforms. It affects the following Unreal Engine subsystems and modules:
- Material Editor
- Renderer
- RenderCore
The value of this variable is set in the ConsoleManager.cpp file with a default value of 1 (enabled). It can be modified at runtime through the console or configuration files.
The associated variable CVarMobileAllowDistanceFieldShadows interacts directly with r.Mobile.AllowDistanceFieldShadows, sharing the same value and purpose.
Developers must be aware of the following when using this variable:
- It affects shader compilation and permutations, which can impact performance and memory usage on mobile devices.
- Enabling this feature (value = 1) allows for more advanced lighting effects but may increase shader complexity.
- Disabling this feature (value = 0) can reduce shader permutations and potentially improve performance at the cost of visual quality.
Best practices when using this variable include:
- Consider the target mobile hardware capabilities when deciding whether to enable or disable this feature.
- Test the performance impact on various mobile devices before finalizing the setting.
- Use in conjunction with other mobile rendering settings to achieve the best balance between visual quality and performance.
Regarding the associated variable CVarMobileAllowDistanceFieldShadows:
This variable is used internally to cache and access the value of r.Mobile.AllowDistanceFieldShadows throughout the engine. It serves the same purpose and is used in the same contexts as r.Mobile.AllowDistanceFieldShadows. Developers should be aware that modifying r.Mobile.AllowDistanceFieldShadows will affect the behavior of code that uses CVarMobileAllowDistanceFieldShadows, and vice versa.
#Setting Variables
#References In INI files
Location: <Workspace>/Projects/Lyra/Config/DefaultEngine.ini:132, section: [/Script/Engine.RendererSettings]
- INI Section:
/Script/Engine.RendererSettings - Raw value:
False - Is Array:
False
#References in C++ code
#Callsites
This variable is referenced in the following C++ source code:
#Loc: <Workspace>/Engine/Source/Runtime/Core/Private/HAL/ConsoleManager.cpp:3515
Scope: file
Source code excerpt:
static TAutoConsoleVariable<int32> CVarMobileAllowDistanceFieldShadows(
TEXT("r.Mobile.AllowDistanceFieldShadows"),
1,
TEXT("0: Do not generate shader permutations to render distance field shadows from stationary directional lights.\n"
"1: Generate shader permutations to render distance field shadows from stationary directional lights. (default)"),
ECVF_RenderThreadSafe | ECVF_ReadOnly);
static TAutoConsoleVariable<int32> CVarMobileAllowMovableDirectionalLights(
#Loc: <Workspace>/Engine/Source/Editor/MaterialEditor/Private/MaterialStatsCommon.cpp:403
Scope (from outer to inner):
file
function void FMaterialStatsUtils::GetRepresentativeShaderTypesAndDescriptions
Source code excerpt:
if (IsStaticLightingAllowed() && TargetMaterial->IsUsedWithStaticLighting())
{
static auto* CVarAllowDistanceFieldShadows = IConsoleManager::Get().FindTConsoleVariableDataInt(TEXT("r.Mobile.AllowDistanceFieldShadows"));
const bool bAllowDistanceFieldShadows = CVarAllowDistanceFieldShadows->GetValueOnAnyThread() != 0;
if (bAllowDistanceFieldShadows)// distance field shadows
{
// distance field shadows only shaders
{
#Loc: <Workspace>/Engine/Source/Runtime/RenderCore/Private/ReadOnlyCVARCache.cpp:74
Scope (from outer to inner):
file
function void FReadOnlyCVARCache::Initialize
Source code excerpt:
const auto CVarMobileEnableStaticAndCSMShadowReceivers = IConsoleManager::Get().FindTConsoleVariableDataInt(TEXT("r.Mobile.EnableStaticAndCSMShadowReceivers"));
const auto CVarMobileEnableMovableLightCSMShaderCulling = IConsoleManager::Get().FindTConsoleVariableDataInt(TEXT("r.Mobile.EnableMovableLightCSMShaderCulling"));
const auto CVarMobileAllowDistanceFieldShadows = IConsoleManager::Get().FindTConsoleVariableDataInt(TEXT("r.Mobile.AllowDistanceFieldShadows"));
const auto CVarMobileSkyLightPermutation = IConsoleManager::Get().FindTConsoleVariableDataInt(TEXT("r.Mobile.SkyLightPermutation"));
const auto CVarMobileEnableNoPrecomputedLightingCSMShader = IConsoleManager::Get().FindTConsoleVariableDataInt(TEXT("r.Mobile.EnableNoPrecomputedLightingCSMShader"));
const auto CVarMobileSupportGPUScene = IConsoleManager::Get().FindTConsoleVariableDataInt(TEXT("r.Mobile.SupportGPUScene"));
const bool bForceAllPermutations = CVarSupportAllShaderPermutations && CVarSupportAllShaderPermutations->GetValueOnAnyThread() != 0;
#Loc: <Workspace>/Engine/Source/Runtime/Renderer/Private/LightMapRendering.cpp:175
Scope (from outer to inner):
file
function bool FMobileDistanceFieldShadowsAndLQLightMapPolicy::ShouldCompilePermutation
Source code excerpt:
bool FMobileDistanceFieldShadowsAndLQLightMapPolicy::ShouldCompilePermutation(const FMeshMaterialShaderPermutationParameters& Parameters)
{
static auto* CVarMobileAllowDistanceFieldShadows = IConsoleManager::Get().FindTConsoleVariableDataInt(TEXT("r.Mobile.AllowDistanceFieldShadows"));
const bool bMobileAllowDistanceFieldShadows = CVarMobileAllowDistanceFieldShadows->GetValueOnAnyThread() == 1;
return bMobileAllowDistanceFieldShadows && Super::ShouldCompilePermutation(Parameters);
}
void FMobileDistanceFieldShadowsAndLQLightMapPolicy::ModifyCompilationEnvironment(const FMaterialShaderPermutationParameters& Parameters, FShaderCompilerEnvironment& OutEnvironment)
{
#Loc: <Workspace>/Engine/Source/Runtime/Renderer/Private/ShadowSetupMobile.cpp:87
Scope (from outer to inner):
file
function static bool CouldStaticMeshEverReceiveCSMFromStationaryLight
Source code excerpt:
{
// test if static shadows are allowed in the first place:
static auto* CVarMobileAllowDistanceFieldShadows = IConsoleManager::Get().FindTConsoleVariableDataInt(TEXT("r.Mobile.AllowDistanceFieldShadows"));
const bool bMobileAllowDistanceFieldShadows = CVarMobileAllowDistanceFieldShadows->GetValueOnRenderThread() == 1;
bool bHasCSMApplicableLightInteraction = bMobileAllowDistanceFieldShadows && StaticMesh.LCI && StaticMesh.LCI->GetLightMapInteraction(FeatureLevel).GetType() == LMIT_Texture;
bool bHasCSMApplicableShadowInteraction = bHasCSMApplicableLightInteraction && StaticMesh.LCI && StaticMesh.LCI->GetShadowMapInteraction(FeatureLevel).GetType() == SMIT_Texture;
return (bHasCSMApplicableLightInteraction && bHasCSMApplicableShadowInteraction) ||
#Associated Variable and Callsites
This variable is associated with another variable named CVarMobileAllowDistanceFieldShadows. They share the same value. See the following C++ source code.
#Loc: <Workspace>/Engine/Source/Runtime/Core/Private/HAL/ConsoleManager.cpp:3514
Scope: file
Source code excerpt:
ECVF_RenderThreadSafe | ECVF_ReadOnly);
static TAutoConsoleVariable<int32> CVarMobileAllowDistanceFieldShadows(
TEXT("r.Mobile.AllowDistanceFieldShadows"),
1,
TEXT("0: Do not generate shader permutations to render distance field shadows from stationary directional lights.\n"
"1: Generate shader permutations to render distance field shadows from stationary directional lights. (default)"),
ECVF_RenderThreadSafe | ECVF_ReadOnly);
#Loc: <Workspace>/Engine/Source/Runtime/RenderCore/Private/ReadOnlyCVARCache.cpp:74
Scope (from outer to inner):
file
function void FReadOnlyCVARCache::Initialize
Source code excerpt:
const auto CVarMobileEnableStaticAndCSMShadowReceivers = IConsoleManager::Get().FindTConsoleVariableDataInt(TEXT("r.Mobile.EnableStaticAndCSMShadowReceivers"));
const auto CVarMobileEnableMovableLightCSMShaderCulling = IConsoleManager::Get().FindTConsoleVariableDataInt(TEXT("r.Mobile.EnableMovableLightCSMShaderCulling"));
const auto CVarMobileAllowDistanceFieldShadows = IConsoleManager::Get().FindTConsoleVariableDataInt(TEXT("r.Mobile.AllowDistanceFieldShadows"));
const auto CVarMobileSkyLightPermutation = IConsoleManager::Get().FindTConsoleVariableDataInt(TEXT("r.Mobile.SkyLightPermutation"));
const auto CVarMobileEnableNoPrecomputedLightingCSMShader = IConsoleManager::Get().FindTConsoleVariableDataInt(TEXT("r.Mobile.EnableNoPrecomputedLightingCSMShader"));
const auto CVarMobileSupportGPUScene = IConsoleManager::Get().FindTConsoleVariableDataInt(TEXT("r.Mobile.SupportGPUScene"));
const bool bForceAllPermutations = CVarSupportAllShaderPermutations && CVarSupportAllShaderPermutations->GetValueOnAnyThread() != 0;
#Loc: <Workspace>/Engine/Source/Runtime/RenderCore/Private/ReadOnlyCVARCache.cpp:90
Scope (from outer to inner):
file
function void FReadOnlyCVARCache::Initialize
Source code excerpt:
bMobileHDR = CVarMobileHDR->GetValueOnAnyThread() == 1;
bMobileAllowMovableDirectionalLights = CVarMobileAllowMovableDirectionalLights->GetValueOnAnyThread() != 0;
bMobileAllowDistanceFieldShadows = CVarMobileAllowDistanceFieldShadows->GetValueOnAnyThread() != 0;
bMobileEnableStaticAndCSMShadowReceivers = CVarMobileEnableStaticAndCSMShadowReceivers->GetValueOnAnyThread() != 0;
bMobileEnableMovableLightCSMShaderCulling = CVarMobileEnableMovableLightCSMShaderCulling->GetValueOnAnyThread() != 0;
MobileSkyLightPermutationValue = CVarMobileSkyLightPermutation->GetValueOnAnyThread();
bMobileEnableNoPrecomputedLightingCSMShader = CVarMobileEnableNoPrecomputedLightingCSMShader->GetValueOnAnyThread() != 0;
MobileEarlyZPassValue = MobileEarlyZPassIniValue(GMaxRHIShaderPlatform);
MobileForwardLocalLightsValue = MobileForwardLocalLightsIniValue(GMaxRHIShaderPlatform);
#Loc: <Workspace>/Engine/Source/Runtime/Renderer/Private/LightMapRendering.cpp:175
Scope (from outer to inner):
file
function bool FMobileDistanceFieldShadowsAndLQLightMapPolicy::ShouldCompilePermutation
Source code excerpt:
bool FMobileDistanceFieldShadowsAndLQLightMapPolicy::ShouldCompilePermutation(const FMeshMaterialShaderPermutationParameters& Parameters)
{
static auto* CVarMobileAllowDistanceFieldShadows = IConsoleManager::Get().FindTConsoleVariableDataInt(TEXT("r.Mobile.AllowDistanceFieldShadows"));
const bool bMobileAllowDistanceFieldShadows = CVarMobileAllowDistanceFieldShadows->GetValueOnAnyThread() == 1;
return bMobileAllowDistanceFieldShadows && Super::ShouldCompilePermutation(Parameters);
}
void FMobileDistanceFieldShadowsAndLQLightMapPolicy::ModifyCompilationEnvironment(const FMaterialShaderPermutationParameters& Parameters, FShaderCompilerEnvironment& OutEnvironment)
{
Super::ModifyCompilationEnvironment(Parameters, OutEnvironment);
#Loc: <Workspace>/Engine/Source/Runtime/Renderer/Private/ShadowSetupMobile.cpp:87
Scope (from outer to inner):
file
function static bool CouldStaticMeshEverReceiveCSMFromStationaryLight
Source code excerpt:
{
// test if static shadows are allowed in the first place:
static auto* CVarMobileAllowDistanceFieldShadows = IConsoleManager::Get().FindTConsoleVariableDataInt(TEXT("r.Mobile.AllowDistanceFieldShadows"));
const bool bMobileAllowDistanceFieldShadows = CVarMobileAllowDistanceFieldShadows->GetValueOnRenderThread() == 1;
bool bHasCSMApplicableLightInteraction = bMobileAllowDistanceFieldShadows && StaticMesh.LCI && StaticMesh.LCI->GetLightMapInteraction(FeatureLevel).GetType() == LMIT_Texture;
bool bHasCSMApplicableShadowInteraction = bHasCSMApplicableLightInteraction && StaticMesh.LCI && StaticMesh.LCI->GetShadowMapInteraction(FeatureLevel).GetType() == SMIT_Texture;
return (bHasCSMApplicableLightInteraction && bHasCSMApplicableShadowInteraction) ||
(!bHasCSMApplicableLightInteraction && PrimitiveSceneInfo->Proxy->IsMovable());