UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
SceneTextures.cpp File Reference

Classes

class  FSceneTextureExtentState
 

Functions

 RDG_REGISTER_BLACKBOARD_STRUCT (FSceneTextures)
 
void ResetSceneTextureExtentHistory ()
 
 ENUM_CLASS_FLAGS (FSceneTextureExtentState::ERenderTargetHistory)
 
void InitializeSceneTexturesConfig (FSceneTexturesConfig &Config, const FSceneViewFamily &ViewFamily, FIntPoint ExtentOverride)
 
const FSceneTextureExtractsGetSceneTextureExtracts ()
 
void QueueSceneTextureExtractions (FRDGBuilder &GraphBuilder, const FSceneTextures &SceneTextures)
 
FRDGTextureRef GetSceneTexture (const FSceneTextures &SceneTextures, ESceneTexture InSceneTexture)
 
void SetupSceneTextureUniformParameters (FRDGBuilder &GraphBuilder, const FSceneTextures *SceneTextures, ERHIFeatureLevel::Type FeatureLevel, ESceneTextureSetupMode SetupMode, FSceneTextureUniformParameters &SceneTextureParameters)
 
TRDGUniformBufferRef< FSceneTextureUniformParametersCreateSceneTextureUniformBuffer (FRDGBuilder &GraphBuilder, const FSceneTextures *SceneTextures, ERHIFeatureLevel::Type FeatureLevel, ESceneTextureSetupMode SetupMode)
 
TRDGUniformBufferRef< FSceneTextureUniformParametersCreateSceneTextureUniformBuffer (FRDGBuilder &GraphBuilder, const FSceneView &View, ESceneTextureSetupMode SetupMode)
 
EMobileSceneTextureSetupMode Translate (ESceneTextureSetupMode InSetupMode)
 
void SetupMobileSceneTextureUniformParameters (FRDGBuilder &GraphBuilder, const FSceneTextures *SceneTextures, EMobileSceneTextureSetupMode SetupMode, FMobileSceneTextureUniformParameters &SceneTextureParameters)
 
TRDGUniformBufferRef< FMobileSceneTextureUniformParametersCreateMobileSceneTextureUniformBuffer (FRDGBuilder &GraphBuilder, const FSceneTextures *SceneTextures, EMobileSceneTextureSetupMode SetupMode)
 
TRDGUniformBufferRef< FMobileSceneTextureUniformParametersCreateMobileSceneTextureUniformBuffer (FRDGBuilder &GraphBuilder, const FSceneView &View, EMobileSceneTextureSetupMode SetupMode)
 
FSceneTextureShaderParameters CreateSceneTextureShaderParameters (FRDGBuilder &GraphBuilder, const FSceneTextures *SceneTextures, ERHIFeatureLevel::Type FeatureLevel, ESceneTextureSetupMode SetupMode)
 
FSceneTextureShaderParameters CreateSceneTextureShaderParameters (FRDGBuilder &GraphBuilder, const FSceneView &View, ESceneTextureSetupMode SetupMode)
 
FSceneTextureShaderParameters GetSceneTextureShaderParameters (const FSceneView &View)
 
TRDGUniformBufferRef< FSceneTextureUniformParametersGetSceneTextureUnformBuffer (const FSceneView &View)
 
bool IsSceneTexturesValid ()
 
FIntPoint GetSceneTextureExtent ()
 
FIntPoint GetSceneTextureExtentFromView (const FViewInfo &View)
 
ERHIFeatureLevel::Type GetSceneTextureFeatureLevel ()
 
void CreateSystemTextures (FRDGBuilder &GraphBuilder)
 

Function Documentation

◆ CreateMobileSceneTextureUniformBuffer() [1/2]

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

Creates the RDG mobile scene texture uniform buffer.

◆ CreateMobileSceneTextureUniformBuffer() [2/2]

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

Creates the RDG mobile scene texture uniform buffer.

◆ CreateSceneTextureShaderParameters() [1/2]

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

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

◆ CreateSceneTextureShaderParameters() [2/2]

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

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

◆ CreateSceneTextureUniformBuffer() [1/2]

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

Returns RDG scene texture uniform buffer.

◆ CreateSceneTextureUniformBuffer() [2/2]

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

Returns RDG scene texture uniform buffer for a specified View.

◆ CreateSystemTextures()

void CreateSystemTextures ( FRDGBuilder GraphBuilder)

Registers system textures into RDG.

◆ ENUM_CLASS_FLAGS()

ENUM_CLASS_FLAGS ( FSceneTextureExtentState::ERenderTargetHistory  )

◆ GetSceneTexture()

FRDGTextureRef GetSceneTexture ( const FSceneTextures SceneTextures,
ESceneTexture  InSceneTexture 
)

◆ GetSceneTextureExtent()

FIntPoint GetSceneTextureExtent ( )

Returns the full-resolution scene texture extent.

◆ GetSceneTextureExtentFromView()

FIntPoint GetSceneTextureExtentFromView ( const FViewInfo View)

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

◆ GetSceneTextureExtracts()

const FSceneTextureExtracts & GetSceneTextureExtracts ( )

Returns the global scene texture extracts struct.

◆ GetSceneTextureFeatureLevel()

ERHIFeatureLevel::Type GetSceneTextureFeatureLevel ( )

Returns the feature level being used by the renderer.

◆ GetSceneTextureShaderParameters()

FSceneTextureShaderParameters GetSceneTextureShaderParameters ( const FSceneView View)

◆ GetSceneTextureUnformBuffer()

TRDGUniformBufferRef< FSceneTextureUniformParameters > GetSceneTextureUnformBuffer ( const FSceneView View)

◆ InitializeSceneTexturesConfig()

void InitializeSceneTexturesConfig ( FSceneTexturesConfig Config,
const FSceneViewFamily ViewFamily,
FIntPoint  ExtentOverride = FIntPoint(0, 0) 
)

Initializes a scene textures config instance from the view family.

◆ IsSceneTexturesValid()

bool IsSceneTexturesValid ( )

Returns whether scene textures have been initialized.

◆ QueueSceneTextureExtractions()

void QueueSceneTextureExtractions ( FRDGBuilder GraphBuilder,
const FSceneTextures SceneTextures 
)

Extracts scene textures into the global extraction instance.

◆ RDG_REGISTER_BLACKBOARD_STRUCT()

RDG_REGISTER_BLACKBOARD_STRUCT ( FSceneTextures  )

◆ ResetSceneTextureExtentHistory()

void ResetSceneTextureExtentHistory ( )

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()

void SetupMobileSceneTextureUniformParameters ( FRDGBuilder GraphBuilder,
const FSceneTextures SceneTextures,
EMobileSceneTextureSetupMode  SetupMode,
FMobileSceneTextureUniformParameters SceneTextureParameters 
)

Fills the scene texture uniform buffer struct.

◆ SetupSceneTextureUniformParameters()

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

Fills the shader parameter struct.

◆ Translate()