Collaboration diagram for FIVSmokePostProcessPass:

Static Public Member Functions
template<typename TShaderClass >
static void	AddPixelShaderPass (FRDGBuilder &GraphBuilder, FGlobalShaderMap ShaderMap, TShaderMapRef< TShaderClass > PixelShader, typename TShaderClass::FParameters Parameters, const FScreenPassRenderTarget &Output)

template<typename TShaderClass >
static void	AddComputeShaderPass (FRDGBuilder &GraphBuilder, FGlobalShaderMap ShaderMap, TShaderMapRef< TShaderClass > ComputeShader, typename TShaderClass::FParameters Parameters, const FIntVector &TotalThreadSize)

static FRDGTextureRef	CreateOutputTexture (FRDGBuilder &GraphBuilder, FRDGTextureRef SourceTexture, const TCHAR *DebugName=, EPixelFormat OverrideFormat=PF_Unknown, FIntPoint OverrideExtent=FIntPoint::ZeroValue, ETextureCreateFlags Flags=ETextureCreateFlags::UAV)

Detailed Description

Core utility for dispatching PS/CS post process passes. Designed for reusability - bring your own shader and parameters.

Definition at line 18 of file IVSmokePostProcessPass.h.

Member Function Documentation

template<typename TShaderClass >

void FIVSmokePostProcessPass::AddComputeShaderPass	(	FRDGBuilder &	GraphBuilder,
		FGlobalShaderMap *	ShaderMap,
		TShaderMapRef< TShaderClass >	ComputeShader,
		typename TShaderClass::FParameters *	Parameters,
		const FIntVector &	TotalThreadSize
	)

static

Add a compute shader pass.

Parameters

GraphBuilder	RDG builder
ShaderMap	Global shader map
ComputeShader	Compute shader to use
Parameters	Shader parameters (must have UAV bound)
ViewportSize	Size of the viewport for thread dispatch
Config	Pass configuration

Warning: Confirmed Engine Bug (UE 5.6 - UE 5.7) Similar to the Pixel Shader pass, the scope name appears as "IVSmoke::ComputeShader: %s" in the Timing View due to the engine bug mentioned above.

Please refer to the Details Panel in Unreal Insights for the correct shader name

Definition at line 117 of file IVSmokePostProcessPass.h.

void FIVSmokePostProcessPass::AddPixelShaderPass	(	FRDGBuilder &	GraphBuilder,
		FGlobalShaderMap *	ShaderMap,
		TShaderMapRef< TShaderClass >	PixelShader,
		typename TShaderClass::FParameters *	Parameters,
		const FScreenPassRenderTarget &	Output
	)

static

Add a fullscreen pixel shader pass.

Parameters

GraphBuilder	RDG builder
ShaderMap	Global shader map
PixelShader	Pixel shader to use
Parameters	Shader parameters (must have RenderTargets bound)
Output	Render target
Config	Pass configuration

Warning: Confirmed Engine Bug (UE 5.6 - UE 5.7) The RDG Timeline View currently displays the raw format string (e.g., "IVSmoke::PixelShader: %s") instead of the resolved variable name in Unreal Insights.

Workaround:

Select the event bar in Unreal Insights (Timing View).
Check the Details Panel (Metadata) to view the correct shader name (e.g., MyShaderPS).

Definition at line 96 of file IVSmokePostProcessPass.h.

FRDGTextureRef FIVSmokePostProcessPass::CreateOutputTexture	(	FRDGBuilder &	GraphBuilder,
		FRDGTextureRef	SourceTexture,
		const TCHAR *	DebugName,
		EPixelFormat	OverrideFormat = `PF_Unknown`,
		FIntPoint	OverrideExtent = `FIntPoint::ZeroValue`,
		ETextureCreateFlags	Flags = `ETextureCreateFlags::UAV`
	)

static

Create an output texture suitable for UAV (compute shader).

Parameters

GraphBuilder	RDG builder
SourceTexture	Texture to base dimensions on
DebugName	Debug name for the new texture
OverrideFormat	Override pixel format (PF_Unknown = use source format)
OverrideExtent	Override texture extent (zero = use source extent)

Definition at line 6 of file IVSmokePostProcessPass.cpp.

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