UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Enumerations | Functions
SceneRenderTargetParameters.h File Reference
#include "RendererInterface.h"
#include "SceneTexturesConfig.h"

Go to the source code of this file.

Classes

class  FSceneTextureExtracts
 

Enumerations

enum class  ESceneTexture {
  Color , Depth , SmallDepth , Velocity ,
  GBufferA , GBufferB , GBufferC , GBufferD ,
  GBufferE , GBufferF , GBufferSGGX , SSAO ,
  CustomDepth
}
 
enum class  ESceneTextureSetupMode : uint32 {
  None = 0 , SceneColor = 1 << 0 , SceneDepth = 1 << 1 , SceneVelocity = 1 << 2 ,
  GBufferA = 1 << 3 , GBufferB = 1 << 4 , GBufferC = 1 << 5 , GBufferD = 1 << 6 ,
  GBufferE = 1 << 7 , GBufferF = 1 << 8 , SSAO = 1 << 9 , CustomDepth = 1 << 10 ,
  SGGX = 1 << 11 , GBuffers = GBufferA | GBufferB | GBufferC | GBufferD | GBufferE | GBufferF | SGGX , All = SceneColor | SceneDepth | SceneVelocity | GBuffers | SSAO | CustomDepth
}
 
enum class  EMobileSceneTextureSetupMode : uint32 {
  None = 0 , SceneColor = 1 << 0 , SceneDepth = 1 << 1 , CustomDepth = 1 << 2 ,
  GBufferA = 1 << 3 , GBufferB = 1 << 4 , GBufferC = 1 << 5 , GBufferD = 1 << 6 ,
  SceneDepthAux = 1 << 7 , SceneVelocity = 1 << 8 , GBuffers = GBufferA | GBufferB | GBufferC | GBufferD | SceneDepthAux , All = SceneColor | SceneDepth | CustomDepth | GBuffers | SceneVelocity
}
 

Functions

RENDERER_API FRDGTextureRef GetSceneTexture (const FSceneTextures &SceneTextures, ESceneTexture InSceneTexture)
 
 ENUM_CLASS_FLAGS (ESceneTextureSetupMode)
 
RENDERER_API void SetupSceneTextureUniformParameters (FRDGBuilder &GraphBuilder, const FSceneTextures *SceneTextures, ERHIFeatureLevel::Type FeatureLevel, ESceneTextureSetupMode SetupMode, FSceneTextureUniformParameters &OutParameters)
 
RENDERER_API TRDGUniformBufferRef< FSceneTextureUniformParameters > CreateSceneTextureUniformBuffer (FRDGBuilder &GraphBuilder, const FSceneTextures *SceneTextures, ERHIFeatureLevel::Type FeatureLevel, ESceneTextureSetupMode SetupMode=ESceneTextureSetupMode::All)
 
RENDERER_API TRDGUniformBufferRef< FSceneTextureUniformParameters > CreateSceneTextureUniformBuffer (FRDGBuilder &GraphBuilder, const FSceneView &View, ESceneTextureSetupMode SetupMode=ESceneTextureSetupMode::All)
 
 ENUM_CLASS_FLAGS (EMobileSceneTextureSetupMode)
 
RENDERER_API void SetupMobileSceneTextureUniformParameters (FRDGBuilder &GraphBuilder, const FSceneTextures *SceneTextures, EMobileSceneTextureSetupMode SetupMode, FMobileSceneTextureUniformParameters &SceneTextureParameters)
 
RENDERER_API TRDGUniformBufferRef< FMobileSceneTextureUniformParameters > CreateMobileSceneTextureUniformBuffer (FRDGBuilder &GraphBuilder, const FSceneTextures *SceneTextures, EMobileSceneTextureSetupMode SetupMode=EMobileSceneTextureSetupMode::All)
 
RENDERER_API TRDGUniformBufferRef< FMobileSceneTextureUniformParameters > CreateMobileSceneTextureUniformBuffer (FRDGBuilder &GraphBuilder, const FSceneView &View, EMobileSceneTextureSetupMode SetupMode=EMobileSceneTextureSetupMode::All)
 
RENDERER_API FSceneTextureShaderParameters CreateSceneTextureShaderParameters (FRDGBuilder &GraphBuilder, const FSceneTextures *SceneTextures, ERHIFeatureLevel::Type FeatureLevel, ESceneTextureSetupMode SetupMode=ESceneTextureSetupMode::All)
 
RENDERER_API FSceneTextureShaderParameters CreateSceneTextureShaderParameters (FRDGBuilder &GraphBuilder, const FSceneView &View, ESceneTextureSetupMode SetupMode=ESceneTextureSetupMode::All)
 
RENDERER_API FSceneTextureShaderParameters GetSceneTextureShaderParameters (const FSceneView &View)
 
const RENDERER_API FSceneTextureExtracts & GetSceneTextureExtracts ()
 
RENDERER_API FIntPoint GetSceneTextureExtentFromView (const FViewInfo &View)
 
RENDERER_API void ResetSceneTextureExtentHistory ()
 
RENDERER_API void CreateSystemTextures (FRDGBuilder &GraphBuilder)
 
RENDERER_API bool IsSceneTexturesValid ()
 
RENDERER_API FIntPoint GetSceneTextureExtent ()
 
RENDERER_API ERHIFeatureLevel::Type GetSceneTextureFeatureLevel ()
 

Enumeration Type Documentation

◆ EMobileSceneTextureSetupMode

enum class EMobileSceneTextureSetupMode : uint32
strong
Enumerator
None 
SceneColor 
SceneDepth 
CustomDepth 
GBufferA 
GBufferB 
GBufferC 
GBufferD 
SceneDepthAux 
SceneVelocity 
GBuffers 
All 

◆ ESceneTexture

enum class ESceneTexture
strong
Enumerator
Color 
Depth 
SmallDepth 
Velocity 
GBufferA 
GBufferB 
GBufferC 
GBufferD 
GBufferE 
GBufferF 
GBufferSGGX 
SSAO 
CustomDepth 

◆ ESceneTextureSetupMode

enum class ESceneTextureSetupMode : uint32
strong
Enumerator
None 
SceneColor 
SceneDepth 
SceneVelocity 
GBufferA 
GBufferB 
GBufferC 
GBufferD 
GBufferE 
GBufferF 
SSAO 
CustomDepth 
SGGX 
GBuffers 
All 

Function Documentation

◆ CreateMobileSceneTextureUniformBuffer() [1/2]

RENDERER_API TRDGUniformBufferRef< FMobileSceneTextureUniformParameters > CreateMobileSceneTextureUniformBuffer ( FRDGBuilder &  GraphBuilder,
const FSceneTextures *  SceneTextures,
EMobileSceneTextureSetupMode  SetupMode = EMobileSceneTextureSetupMode::All 
)
extern

Creates the RDG mobile scene texture uniform buffer.

◆ CreateMobileSceneTextureUniformBuffer() [2/2]

RENDERER_API TRDGUniformBufferRef< FMobileSceneTextureUniformParameters > CreateMobileSceneTextureUniformBuffer ( FRDGBuilder &  GraphBuilder,
const FSceneView &  View,
EMobileSceneTextureSetupMode  SetupMode = EMobileSceneTextureSetupMode::All 
)
extern

Creates the RDG mobile scene texture uniform buffer.

◆ CreateSceneTextureShaderParameters() [1/2]

RENDERER_API FSceneTextureShaderParameters CreateSceneTextureShaderParameters ( FRDGBuilder &  GraphBuilder,
const FSceneTextures *  SceneTextures,
ERHIFeatureLevel::Type  FeatureLevel,
ESceneTextureSetupMode  SetupMode = ESceneTextureSetupMode::All 
)
extern

Returns scene texture shader parameters containing the RDG uniform buffer for either mobile or deferred shading.

◆ CreateSceneTextureShaderParameters() [2/2]

RENDERER_API FSceneTextureShaderParameters CreateSceneTextureShaderParameters ( FRDGBuilder &  GraphBuilder,
const FSceneView &  View,
ESceneTextureSetupMode  SetupMode = ESceneTextureSetupMode::All 
)
extern

Returns scene texture shader parameters containing the RDG uniform buffer for either mobile or deferred shading.

◆ CreateSceneTextureUniformBuffer() [1/2]

RENDERER_API TRDGUniformBufferRef< FSceneTextureUniformParameters > CreateSceneTextureUniformBuffer ( FRDGBuilder &  GraphBuilder,
const FSceneTextures *  SceneTextures,
ERHIFeatureLevel::Type  FeatureLevel,
ESceneTextureSetupMode  SetupMode = ESceneTextureSetupMode::All 
)
extern

Returns RDG scene texture uniform buffer.

◆ CreateSceneTextureUniformBuffer() [2/2]

RENDERER_API TRDGUniformBufferRef< FSceneTextureUniformParameters > CreateSceneTextureUniformBuffer ( FRDGBuilder &  GraphBuilder,
const FSceneView &  View,
ESceneTextureSetupMode  SetupMode = ESceneTextureSetupMode::All 
)
extern

Returns RDG scene texture uniform buffer for a specified View.

◆ CreateSystemTextures()

RENDERER_API void CreateSystemTextures ( FRDGBuilder &  GraphBuilder)
extern

Registers system textures into RDG.

◆ ENUM_CLASS_FLAGS() [1/2]

ENUM_CLASS_FLAGS ( EMobileSceneTextureSetupMode  )

◆ ENUM_CLASS_FLAGS() [2/2]

ENUM_CLASS_FLAGS ( ESceneTextureSetupMode  )

◆ GetSceneTexture()

RENDERER_API FRDGTextureRef GetSceneTexture ( const FSceneTextures &  SceneTextures,
ESceneTexture  InSceneTexture 
)

◆ GetSceneTextureExtent()

RENDERER_API FIntPoint GetSceneTextureExtent ( )
extern

Returns the full-resolution scene texture extent.

◆ GetSceneTextureExtentFromView()

RENDERER_API FIntPoint GetSceneTextureExtentFromView ( const FViewInfo &  View)
extern

Pass through to View.GetSceneTexturesConfig().Extent, useful in headers where the FViewInfo structure isn't exposed.

◆ GetSceneTextureExtracts()

const RENDERER_API FSceneTextureExtracts & GetSceneTextureExtracts ( )

Returns the global scene texture extracts struct.

◆ GetSceneTextureFeatureLevel()

RENDERER_API ERHIFeatureLevel::Type GetSceneTextureFeatureLevel ( )
extern

Returns the feature level being used by the renderer.

◆ GetSceneTextureShaderParameters()

RENDERER_API FSceneTextureShaderParameters GetSceneTextureShaderParameters ( const FSceneView &  View)
extern

◆ IsSceneTexturesValid()

RENDERER_API bool IsSceneTexturesValid ( )
extern

Returns whether scene textures have been initialized.

◆ ResetSceneTextureExtentHistory()

RENDERER_API void ResetSceneTextureExtentHistory ( )
extern

Resets the scene texture extent history. Call this method after rendering with very large render targets. The next scene render will create them at the requested size.

◆ SetupMobileSceneTextureUniformParameters()

RENDERER_API void SetupMobileSceneTextureUniformParameters ( FRDGBuilder &  GraphBuilder,
const FSceneTextures *  SceneTextures,
EMobileSceneTextureSetupMode  SetupMode,
FMobileSceneTextureUniformParameters &  SceneTextureParameters 
)
extern

Fills the scene texture uniform buffer struct.

◆ SetupSceneTextureUniformParameters()

RENDERER_API void SetupSceneTextureUniformParameters ( FRDGBuilder &  GraphBuilder,
const FSceneTextures *  SceneTextures,
ERHIFeatureLevel::Type  FeatureLevel,
ESceneTextureSetupMode  SetupMode,
FSceneTextureUniformParameters &  OutParameters 
)
extern

Fills the shader parameter struct.