UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FSceneCapturePass Class Referencefinal
+ Inheritance diagram for FSceneCapturePass:

Public Member Functions

 IMPLEMENT_CUSTOM_RENDER_PASS (FSceneCapturePass)
 
 FSceneCapturePass (const FString &InDebugName, ERenderMode InRenderMode, ERenderOutput InRenderOutput, UTextureRenderTarget2D *InRenderTarget, USceneCaptureComponent2D *CaptureComponent, FIntPoint InRenderTargetSize)
 
virtual void OnPreRender (FRDGBuilder &GraphBuilder) override
 
virtual void OnEndPass (FRDGBuilder &GraphBuilder) override
 
- Public Member Functions inherited from FCustomRenderPassBase
 FCustomRenderPassBase ()=delete
 
ENGINE_API FCustomRenderPassBase (const FString &InDebugName, ERenderMode InRenderMode, ERenderOutput InRenderOutput, const FIntPoint &InRenderTargetSize)
 
virtual ~FCustomRenderPassBase ()
 
ENGINE_API void BeginPass (FRDGBuilder &GraphBuilder)
 
ENGINE_API void PreRender (FRDGBuilder &GraphBuilder)
 
ENGINE_API void PostRender (FRDGBuilder &GraphBuilder)
 
ENGINE_API void EndPass (FRDGBuilder &GraphBuilder)
 
ENGINE_API ESceneCaptureSource GetSceneCaptureSource () const
 
ENGINE_API void PerformRenderCapture (ERenderCaptureType InRenderCaptureType, const FString &InFileName=FString())
 
const FString & GetDebugName () const
 
ERenderMode GetRenderMode () const
 
ERenderOutput GetRenderOutput () const
 
FRDGTextureRef GetRenderTargetTexture () const
 
const FIntPointGetRenderTargetSize () const
 
bool IsTranslucentIncluded () const
 
ENGINE_API void SetUserData (TUniquePtr< ICustomRenderPassUserData > &&InUserData)
 
ENGINE_API ICustomRenderPassUserDataGetUserData (const FName &InTypeName) const
 
template<typename UserDataType >
TEnableIf< TPointerIsConvertibleFromTo< UserDataType, ICustomRenderPassUserData >::Value, UserDataType >::Type * GetUserDataTyped () const
 
- Public Member Functions inherited from ICustomRenderPass
virtual ~ICustomRenderPass ()
 

Public Attributes

FRenderTargetSceneCaptureRenderTarget = nullptr
 
bool bAutoGenerateMips = false
 
- Public Attributes inherited from ICustomRenderPass
virtual const FName &GetTypeName() const PURE_VIRTUAL(ICustomRenderPass return Name
 

Additional Inherited Members

- Public Types inherited from FCustomRenderPassBase
enum class  ERenderMode : uint8 { DepthPass , DepthAndBasePass }
 
enum class  ERenderOutput : uint8 {
  SceneDepth , DeviceDepth , SceneColorAndDepth , SceneColorAndAlpha ,
  SceneColorNoAlpha , BaseColor , Normal , MAX
}
 
enum class  ERenderCaptureType { NoCapture , Capture , BeginCapture , EndCapture }
 
- Protected Member Functions inherited from FCustomRenderPassBase
virtual void OnBeginPass (FRDGBuilder &GraphBuilder)
 
virtual void OnPostRender (FRDGBuilder &GraphBuilder)
 
void OverrideRenderOutput (ERenderOutput InRenderOutput)
 
- Protected Attributes inherited from FCustomRenderPassBase
FString DebugName
 
ERenderMode RenderMode = ERenderMode::DepthPass
 
ERenderOutput RenderOutput = ERenderOutput::SceneDepth
 
bool bSceneColorWithTranslucent = false
 
bool bSceneColorIsUserSceneTexture = false
 
FRDGTextureRef RenderTargetTexture = nullptr
 
FIntPoint RenderTargetSize = FIntPoint(ForceInit)
 
TArray< class FViewInfo * > Views
 
TMap< FName, TUniquePtr< ICustomRenderPassUserData > > UserDatas
 

Constructor & Destructor Documentation

◆ FSceneCapturePass()

FSceneCapturePass::FSceneCapturePass ( const FString &  InDebugName,
ERenderMode  InRenderMode,
ERenderOutput  InRenderOutput,
UTextureRenderTarget2D InRenderTarget,
USceneCaptureComponent2D CaptureComponent,
FIntPoint  InRenderTargetSize 
)
inline

Member Function Documentation

◆ IMPLEMENT_CUSTOM_RENDER_PASS()

FSceneCapturePass::IMPLEMENT_CUSTOM_RENDER_PASS ( FSceneCapturePass  )

◆ OnEndPass()

virtual void FSceneCapturePass::OnEndPass ( FRDGBuilder GraphBuilder)
inlineoverridevirtual

Reimplemented from FCustomRenderPassBase.

◆ OnPreRender()

virtual void FSceneCapturePass::OnPreRender ( FRDGBuilder GraphBuilder)
inlineoverridevirtual

Reimplemented from FCustomRenderPassBase.

Member Data Documentation

◆ bAutoGenerateMips

bool FSceneCapturePass::bAutoGenerateMips = false

◆ SceneCaptureRenderTarget

FRenderTarget* FSceneCapturePass::SceneCaptureRenderTarget = nullptr

The documentation for this class was generated from the following file: