1. Epic GamesDeveloper
  3. FCustomRenderPassBase

FCustomRenderPassBase

Base class of the custom render pass.

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Rendering

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/Rendering/CustomRenderPass.h
Include #include "Rendering/CustomRenderPass.h"

Syntax

class FCustomRenderPassBase : public ICustomRenderPass

Remarks

Base class of the custom render pass. Create a derived class to provide custom behavior. Custom render pass is rendered as part of the main render loop.

Variables

  Type Name Description
Protected variable FString DebugName  
Protected variable ERenderMode RenderMode  
Protected variable ERenderOutput RenderOutput  
Protected variable FIntPoint RenderTargetSize  
Protected variable FRDGTextureRef RenderTargetTexture  
Protected variable TMap< FName, TUniquePtr< ICustomRenderPassUserData > > UserDatas Optional user data providing a hook into the engine to override settings for this render pass.
Protected variable TArray< class FViewInfo * > Views The views created for the custom render pass.

Constructors

  Type Name Description
Public function    
Public function  

FCustomRenderPassBase ( const FString& InDebugName,
ERenderMode InRenderMode,
ERenderOutput InRenderOutput,
const FIntPoint& InRenderTargetSize
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

BeginPass ( FRDGBuilder& GraphBuilder
)

 Called before PreRender on render thread (only really useful for properly scoping render capture names)
Public function void

EndPass ( FRDGBuilder& GraphBuilder
)

 Called after PostRender on render thread (only really useful for properly scoping render capture names)
Public function Const const FString &  
Public function Const ERenderMode  
Public function Const ERenderOutput  
Public function Const const FIntPoint &  
Public function Const FRDGTextureRef  
Public function Const ESceneCaptureSource Convert output type into corresponding scene capture source type.
Public function Const ICustomRenderPassUserData *

GetUserData ( const FName& InTypeName
)

  
Public function Const TEnableIf< TPointerIsConvertibleFromTo< UserDataType, ICustomRenderPassUserData >::Value, UserDataTy...  
Protected function Virtual void

OnBeginPass ( FRDGBuilder& GraphBuilder
)

  
Protected function Virtual void

OnEndPass ( FRDGBuilder& GraphBuilder
)

  
Protected function Virtual void

OnPostRender ( FRDGBuilder& GraphBuilder
)

  
Protected function Virtual void

OnPreRender ( FRDGBuilder& GraphBuilder
)

  
Protected function void

OverrideRenderOutput ( ERenderOutput InRenderOutput
)

 Used internally during scene render to generate multiple outputs from a single custom render pass
Public function void

PerformRenderCapture ( ERenderCaptureType InRenderCaptureType,
const FString& InFileName
)

 Perform a render capture when this pass runs if a render capture interface is registered
Public function void

PostRender ( FRDGBuilder& GraphBuilder
)

 Called after the pass is rendered on render thread, use it for post processing tasks such as applying additional shader effects to the render target.
Public function void

PreRender ( FRDGBuilder& GraphBuilder
)

 Called before the pass is rendered on render thread, use it for prep tasks such as allocating render target.
Public function void  

Enums

  Type Name Description
Public enum ERenderCaptureType    
Public enum ERenderMode Which render passes are needed for the custom render pass.  
Public enum ERenderOutput The output type into the render target. What type is valid depends on ERenderMode.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page