![]() |
UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
|
#include "SceneRendering.h"#include "ProfilingDebugging/ProfilingHelpers.h"#include "ProfilingDebugging/CpuProfilerTrace.h"#include "StateStreamManagerImpl.h"#include "UObject/UObjectHash.h"#include "UObject/UObjectIterator.h"#include "EngineGlobals.h"#include "CanvasItem.h"#include "Components/ReflectionCaptureComponent.h"#include "Components/SceneCaptureComponent2D.h"#include "Components/SceneCaptureComponentCube.h"#include "SceneCapture/SceneCaptureInternal.h"#include "DeferredShadingRenderer.h"#include "DumpGPU.h"#include "DynamicPrimitiveDrawing.h"#include "RendererModule.h"#include "ScenePrivate.h"#include "SceneProxies/SkyAtmosphereSceneProxy.h"#include "SceneProxies/SkyLightSceneProxy.h"#include "PostProcess/DiaphragmDOF.h"#include "PostProcess/SceneFilterRendering.h"#include "PostProcess/PostProcessEyeAdaptation.h"#include "PostProcess/PostProcessSubsurface.h"#include "PostProcess/TemporalAA.h"#include "PostProcess/PostProcessUpscale.h"#include "PostProcess/PostProcessing.h"#include "PostProcess/PostProcessTonemap.h"#include "CompositionLighting/CompositionLighting.h"#include "LegacyScreenPercentageDriver.h"#include "SceneViewExtension.h"#include "ShadowRendering.h"#include "ComponentRecreateRenderStateContext.h"#include "PhysicsField/PhysicsFieldComponent.h"#include "HdrCustomResolveShaders.h"#include "WideCustomResolveShaders.h"#include "PipelineStateCache.h"#include "GPUSkinCache.h"#include "PrecomputedVolumetricLightmap.h"#include "RenderUtils.h"#include "SceneUtils.h"#include "ResolveShader.h"#include "DeviceProfiles/DeviceProfileManager.h"#include "DeviceProfiles/DeviceProfile.h"#include "VirtualTextureEnum.h"#include "VirtualTexturing.h"#include "VisualizeTexturePresent.h"#include "GPUScene.h"#include "TranslucentRendering.h"#include "VisualizeTexture.h"#include "MeshDrawCommands.h"#include "HAL/LowLevelMemTracker.h"#include "IXRTrackingSystem.h"#include "IXRCamera.h"#include "IHeadMountedDisplay.h"#include "SingleLayerWaterRendering.h"#include "HairStrands/HairStrandsVisibility.h"#include "SystemTextures.h"#include "VirtualShadowMaps/VirtualShadowMapClipmap.h"#include "VirtualShadowMaps/VirtualShadowMapCacheManager.h"#include "Misc/AutomationTest.h"#include "Engine/TextureCube.h"#include "GPUSkinCacheVisualizationData.h"#include "RayTracing/RayTracing.h"#include "RayTracing/RayTracingScene.h"#include "Rendering/RayTracingGeometryManager.h"#include "FXSystem.h"#include "Lumen/Lumen.h"#include "Nanite/Nanite.h"#include "Nanite/NaniteRayTracing.h"#include "DistanceFieldLightingShared.h"#include "RendererOnScreenNotification.h"#include "Rendering/NaniteCoarseMeshStreamingManager.h"#include "Rendering/NaniteStreamingManager.h"#include "RectLightTextureManager.h"#include "IESTextureManager.h"#include "DynamicResolutionState.h"#include "NaniteVisualizationData.h"#include "Shadows/ShadowSceneRenderer.h"#include "TextureResource.h"#include "RenderCounters.h"#include "RenderCore.h"#include "SkyAtmosphereRendering.h"#include "VolumetricCloudRendering.h"#include "VolumetricFog.h"#include "PrimitiveSceneShaderData.h"#include "Engine/SpecularProfile.h"#include "Engine/VolumeTexture.h"#include "GPUDebugCrashUtils.h"#include "MeshDrawCommandStats.h"#include "LocalFogVolumeRendering.h"#include "OIT/OIT.h"#include "TranslucentLighting.h"#include "Rendering/CustomRenderPass.h"#include "Stats/ThreadIdleStats.h"#include "CustomRenderPassSceneCapture.h"#include "LightFunctionAtlas.h"#include "EnvironmentComponentsFlags.h"#include "Math/RotationMatrix.h"#include "VolumetricCloudProxy.h"#include "VT/VirtualTextureFeedbackResource.h"#include "VT/VirtualTextureScalability.h"#include "VT/VirtualTextureSystem.h"#include "SceneRenderBuilder.h"#include <type_traits>#include "BlueNoise.h"#include "Renderer/ViewSnapshotCache.h"#include "ShaderCompiler.h"#include "Quantization.h"#include "MaterialCache/MaterialCacheTagProvider.h"#include "RenderViewportFeedback.h"Classes | |
| struct | FSceneUniformBufferBlackboardStruct |
| class | FScenePrimitiveRenderingContext |
| class | FConsoleVariableAutoCompleteVisitor |
| class | FDummySceneColorResolveBuffer |
Macros | |
| #define | FASTVRAM_CVAR(Name, DefaultValue) static TAutoConsoleVariable<int32> CVarFastVRam_##Name(TEXT("r.FastVRam."#Name), DefaultValue, TEXT("")) |
| #define | CANVAS_HEADER(txt) |
| #define | CANVAS_LINE(bHighlight, txt, ...) |
Variables | |
| int32 | GSceneCaptureDepthPrepassOptimization = 0 |
| FAutoConsoleVariableRef | CVarEnableSceneCaptureLogging (TEXT("r.SceneCapture.EnableLogging"), FSceneCaptureLogUtils::bEnableSceneCaptureLogging, TEXT("Enable logging of scene captures.")) |
| PRAGMA_ENABLE_DEPRECATION_WARNINGS int32 | GDumpInstancingStats = 0 |
| int32 | GDumpMeshDrawCommandMemoryStats = 0 |
| TAutoConsoleVariable< int32 > | CVarRHICmdMinDrawsPerParallelCmdList (TEXT("r.RHICmdMinDrawsPerParallelCmdList"), 64, TEXT("The minimum number of draws per cmdlist. If the total number of draws is less than this, then no parallel work will be done at all. This can't always be honored or done correctly.")) |
| FFastVramConfig | GFastVRamConfig |
| TSet< IPersistentViewUniformBufferExtension * > | PersistentViewUniformBufferExtensions |
| CORE_API bool | GRenderThreadPollingOn |
| TGlobalResource< FDummySceneColorResolveBuffer > | GResolveDummyVertexBuffer |
| #define CANVAS_LINE | ( | bHighlight, | |
| txt, | |||
| ... | |||
| ) |
| #define FASTVRAM_CVAR | ( | Name, | |
| DefaultValue | |||
| ) | static TAutoConsoleVariable<int32> CVarFastVRam_##Name(TEXT("r.FastVRam."#Name), DefaultValue, TEXT("")) |
| void AddResolveSceneColorPass | ( | FRDGBuilder & | GraphBuilder, |
| const FViewInfo & | View, | ||
| FRDGTextureMSAA | SceneColor | ||
| ) |
Resolves the view rect of scene color or depth using either a custom resolve or hardware resolve.
| void AddResolveSceneColorPass | ( | FRDGBuilder & | GraphBuilder, |
| TArrayView< const FViewInfo > | Views, | ||
| FRDGTextureMSAA | SceneColor | ||
| ) |
Resolves all views for scene color / depth.
| void AddResolveSceneDepthPass | ( | FRDGBuilder & | GraphBuilder, |
| const FViewInfo & | View, | ||
| FRDGTextureMSAA | SceneDepth | ||
| ) |
Chooses one of many ResolvePS variants
| void AddResolveSceneDepthPass | ( | FRDGBuilder & | GraphBuilder, |
| TArrayView< const FViewInfo > | Views, | ||
| FRDGTextureMSAA | SceneDepth | ||
| ) |
|
inline |
| void CleanupOcclusionSubmittedFence | ( | ) |
| FRDGTextureRef CreateHalfResolutionDepthCheckerboardMinMax | ( | FRDGBuilder & | GraphBuilder, |
| TArrayView< const FViewInfo > | Views, | ||
| FRDGTextureRef | SceneDepth | ||
| ) |
Creates a half resolution checkerboard min / max depth buffer from the input full resolution depth buffer.
| FRDGTextureRef CreateQuarterResolutionDepthMinAndMax | ( | FRDGBuilder & | GraphBuilder, |
| TArrayView< const FViewInfo > | Views, | ||
| FRDGTextureRef | DepthTexture | ||
| ) |
Creates a half resolution depth buffer storing the min and max depth for each 2x2 pixel quad of a half resolution buffer.
| void CreateQuarterResolutionDepthMinAndMaxFromDepthTexture | ( | FRDGBuilder & | GraphBuilder, |
| TArrayView< const FViewInfo > | Views, | ||
| FRDGTextureRef | DepthTexture, | ||
| FRDGTextureRef & | OutHalfResMinMax, | ||
| FRDGTextureRef & | OutQuarterResMinMax | ||
| ) |
Creates a quarter resolution depth buffer storing the min and max depth for each 4x4 pixel quad of the depth buffer.
| FAutoConsoleVariableRef CVarDumpInstancingStats | ( | TEXT("r.MeshDrawCommands.LogDynamicInstancingStats") | , |
| GDumpInstancingStats | , | ||
| TEXT("Whether to log dynamic instancing stats on the next frame") | , | ||
| ECVF_Scalability| | ECVF_RenderThreadSafe | ||
| ) |
| FAutoConsoleVariableRef CVarDumpMeshDrawCommandMemoryStats | ( | TEXT("r.MeshDrawCommands.LogMeshDrawCommandMemoryStats") | , |
| GDumpMeshDrawCommandMemoryStats | , | ||
| TEXT("Whether to log mesh draw command memory stats on the next frame") | , | ||
| ECVF_Scalability| | ECVF_RenderThreadSafe | ||
| ) |
| DECLARE_CYCLE_STAT | ( | TEXT("DeferredShadingSceneRenderer ViewExtensionPostRenderView") | , |
| STAT_FDeferredShadingSceneRenderer_ViewExtensionPostRenderView | , | ||
| STATGROUP_SceneRendering | |||
| ) |
| DECLARE_CYCLE_STAT | ( | TEXT("DeferredShadingSceneRenderer ViewExtensionPreRenderView") | , |
| STAT_FDeferredShadingSceneRenderer_ViewExtensionPreRenderView | , | ||
| STATGROUP_SceneRendering | |||
| ) |
| DEFINE_LOG_CATEGORY | ( | LogSceneCapture | ) |
| bool DoMaterialAndPrimitiveModifyMeshPosition | ( | const FMaterial & | Material, |
| const FPrimitiveSceneProxy * | PrimitiveSceneProxy | ||
| ) |
Checks whether the material and scene proxy combination will modify the mesh position. Useful for determining whether the material can be substituted with a default material for depth rendering etc.
| FASTVRAM_CVAR | ( | Bloom | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | BokehDOF | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | CircleDOF | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | CombineLUTs | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | CustomDepth | , |
| 0 | |||
| ) |
| FASTVRAM_CVAR | ( | DBufferA | , |
| 0 | |||
| ) |
| FASTVRAM_CVAR | ( | DBufferB | , |
| 0 | |||
| ) |
| FASTVRAM_CVAR | ( | DBufferC | , |
| 0 | |||
| ) |
| FASTVRAM_CVAR | ( | DBufferMask | , |
| 0 | |||
| ) |
| FASTVRAM_CVAR | ( | DistanceFieldAOBentNormal | , |
| 0 | |||
| ) |
| FASTVRAM_CVAR | ( | DistanceFieldAODownsampledBentNormal | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | DistanceFieldAOHistory | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | DistanceFieldAOScreenGridResources | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | DistanceFieldCulledObjectBuffers | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | DistanceFieldIrradiance | , |
| 0 | |||
| ) |
| FASTVRAM_CVAR | ( | DistanceFieldNormal | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | DistanceFieldShadows | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | DistanceFieldTileIntersectionResources | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | Distortion | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | DOFPostfilter | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | DOFReduce | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | DOFSetup | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | Downsample | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | EyeAdaptation | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | ForwardLightingCullingResources | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | GBufferA | , |
| 0 | |||
| ) |
| FASTVRAM_CVAR | ( | GBufferB | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | GBufferC | , |
| 0 | |||
| ) |
| FASTVRAM_CVAR | ( | GBufferD | , |
| 0 | |||
| ) |
| FASTVRAM_CVAR | ( | GBufferE | , |
| 0 | |||
| ) |
| FASTVRAM_CVAR | ( | GBufferF | , |
| 0 | |||
| ) |
| FASTVRAM_CVAR | ( | GBufferVelocity | , |
| 0 | |||
| ) |
| FASTVRAM_CVAR | ( | GlobalDistanceFieldCullGridBuffers | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | Histogram | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | HistogramReduce | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | HZB | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | MotionBlur | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | PostProcessMaterial | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | SceneColor | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | SceneDepth | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | ScreenSpaceAO | , |
| 0 | |||
| ) |
| FASTVRAM_CVAR | ( | ScreenSpaceShadowMask | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | SeparateTranslucency | , |
| 0 | |||
| ) |
| FASTVRAM_CVAR | ( | SeparateTranslucencyModulate | , |
| 0 | |||
| ) |
| FASTVRAM_CVAR | ( | ShadowCSM | , |
| 0 | |||
| ) |
| FASTVRAM_CVAR | ( | ShadowPerObject | , |
| 0 | |||
| ) |
| FASTVRAM_CVAR | ( | ShadowPointLight | , |
| 0 | |||
| ) |
| FASTVRAM_CVAR | ( | SSR | , |
| 0 | |||
| ) |
| FASTVRAM_CVAR | ( | Tonemap | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | Upscale | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | VelocityFlat | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | VelocityMax | , |
| 1 | |||
| ) |
| FASTVRAM_CVAR | ( | VolumetricFog | , |
| 1 | |||
| ) |
| PRAGMA_DISABLE_DEPRECATION_WARNINGS int32 GetMaxNumReflectionCaptures | ( | EShaderPlatform | ShaderPlatform | ) |
|
extern |
| TSharedRef< ISceneViewExtension, ESPMode::ThreadSafe > GetRendererViewExtension | ( | ) |
|
extern |
|
extern |
Function returning current translucency lighting volume dimensions.
| bool IsDynamicInstancingEnabled | ( | ERHIFeatureLevel::Type | FeatureLevel | ) |
| PRAGMA_ENABLE_DEPRECATION_WARNINGS bool IsHMDHiddenAreaMaskActive | ( | ) |
Checks whether primitive alpha holdout is active.
| bool IsPrimitiveAlphaHoldoutEnabledForAnyView | ( | TArrayView< const FViewInfo > | Views | ) |
Checks whether primitive alpha holdout is active for any view.
| void OnChangeCVarRequiringRecreateRenderState | ( | IConsoleVariable * | Var | ) |
| RDG_REGISTER_BLACKBOARD_STRUCT | ( | FSceneUniformBufferBlackboardStruct | ) |
| bool SceneCaptureRequiresAlphaChannel | ( | const FSceneView & | View | ) |
| void SetupPhysicsFieldUniformBufferParameters | ( | const FScene * | Scene, |
| FEngineShowFlags | EngineShowFlags, | ||
| FViewUniformShaderParameters & | ViewUniformShaderParameters | ||
| ) |
| void SetupPrecomputedVolumetricLightmapUniformBufferParameters | ( | const FScene * | Scene, |
| FEngineShowFlags | EngineShowFlags, | ||
| FViewUniformShaderParameters & | ViewUniformShaderParameters | ||
| ) |
| void UpdateNoiseTextureParameters | ( | FViewUniformShaderParameters & | ViewUniformShaderParameters | ) |
| bool UseCachedMeshDrawCommands | ( | ) |
| bool UseCachedMeshDrawCommands_AnyThread | ( | ) |
| void VirtualTextureFeedbackBegin | ( | FRDGBuilder & | GraphBuilder, |
| TArrayView< const FViewInfo > | Views, | ||
| FIntPoint | SceneTextureExtent | ||
| ) |
Prepares virtual textures for feedback updates.
| FAutoConsoleVariableRef CVarEnableSceneCaptureLogging(TEXT("r.SceneCapture.EnableLogging"), FSceneCaptureLogUtils::bEnableSceneCaptureLogging, TEXT("Enable logging of scene captures.")) | ( | TEXT("r.SceneCapture.EnableLogging") | , |
| FSceneCaptureLogUtils::bEnableSceneCaptureLogging | , | ||
| TEXT("Enable logging of scene captures.") | |||
| ) |
| TAutoConsoleVariable< int32 > CVarRHICmdMinDrawsPerParallelCmdList(TEXT("r.RHICmdMinDrawsPerParallelCmdList"), 64, TEXT("The minimum number of draws per cmdlist. If the total number of draws is less than this, then no parallel work will be done at all. This can't always be honored or done correctly.")) | ( | TEXT("r.RHICmdMinDrawsPerParallelCmdList") | , |
| 64 | , | ||
| TEXT("The minimum number of draws per cmdlist. If the total number of draws is less than this, then no parallel work will be done at all. This can't always be honored or done correctly.") | |||
| ) |
| PRAGMA_ENABLE_DEPRECATION_WARNINGS int32 GDumpInstancingStats = 0 |
| int32 GDumpMeshDrawCommandMemoryStats = 0 |
| FFastVramConfig GFastVRamConfig |
| TGlobalResource<FDummySceneColorResolveBuffer> GResolveDummyVertexBuffer |
| int32 GSceneCaptureDepthPrepassOptimization = 0 |
|
extern |