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

Classes

class  FCompositeHDRForBlurPS
 
struct  FSlateCompositeHDRForBlurPassInputs
 
class  FSlatePostProcessDirectResamplePS
 
class  FSlatePostProcessResample2x2PS
 
struct  FSlatePostProcessDownsamplePassInputs
 
class  FSlatePostProcessUpsamplePS
 
struct  FSlatePostProcessUpsampleInputs
 
class  FSlatePostProcessOptimizedKawaseUpsamplePS
 
struct  FSlateKawaseBlurUpsampleParameters
 
struct  FSlateKawaseBlurInternalConfiguration
 
class  FSlatePostProcessBlurPS
 
class  FSlatePostProcessColorDeficiencyPS
 

Enumerations

enum class  ESlatePostProcessUpsampleOutputFormat { SDR = 0 , HDR_SCRGB , HDR_PQ10 , MAX }
 

Functions

 CSV_DECLARE_CATEGORY_MODULE_EXTERN (SLATECORE_API, Slate)
 
float GetSlateHDRUILevel ()
 
float GetSlateHDRUILuminance ()
 
int GetSlateHDRUICompositeEOTF ()
 
ETextureCreateFlags GetSlateTransientRenderTargetFlags ()
 
ETextureCreateFlags GetSlateTransientDepthStencilFlags ()
 
 IMPLEMENT_GLOBAL_SHADER (FCompositeHDRForBlurPS, "/Engine/Private/CompositeUIPixelShader.usf", "CompositeUIForBlur", SF_Pixel)
 
FScreenPassTexture AddSlateCompositeHDRForBlurPass (FRDGBuilder &GraphBuilder, const FSlateCompositeHDRForBlurPassInputs &Inputs)
 
 IMPLEMENT_GLOBAL_SHADER (FSlatePostProcessDirectResamplePS, "/Engine/Private/SlatePostProcessPixelShader.usf", "Resample1Main", SF_Pixel)
 
 IMPLEMENT_GLOBAL_SHADER (FSlatePostProcessResample2x2PS, "/Engine/Private/SlatePostProcessPixelShader.usf", "Resample2x2Main", SF_Pixel)
 
FScreenPassTexture AddSlatePostProcessDownsamplePass (FRDGBuilder &GraphBuilder, const FSlatePostProcessDownsamplePassInputs &Inputs)
 
 IMPLEMENT_GLOBAL_SHADER (FSlatePostProcessUpsamplePS, "/Engine/Private/SlatePostProcessPixelShader.usf", "UpsampleMain", SF_Pixel)
 
void AddSlatePostProcessUpsamplePass (FRDGBuilder &GraphBuilder, const FSlatePostProcessUpsampleInputs &Inputs)
 
 IMPLEMENT_GLOBAL_SHADER (FSlatePostProcessOptimizedKawaseUpsamplePS, "/Engine/Private/SlatePostProcessPixelShader.usf", "OptimizedKawaseUpsampleMain", SF_Pixel)
 
FSlateKawaseBlurUpsampleParameters GetSlateKawaseBlurUpsampleParameters (float Sigma)
 
FSlateKawaseBlurInternalConfiguration GetSlateKawaseBlurInternalConfiguration (float Sigma)
 
FScreenPassTexture AddSlateKawaseBlur (FRDGBuilder &GraphBuilder, const FScreenPassTexture &InputTexture, const FSlateKawaseBlurInternalConfiguration &Configuration)
 
 IMPLEMENT_GLOBAL_SHADER (FSlatePostProcessBlurPS, "/Engine/Private/SlatePostProcessPixelShader.usf", "GaussianBlurMain", SF_Pixel)
 
FScreenPassTexture AddSlatePostProcessOldGaussianBlur (FRDGBuilder &GraphBuilder, const FSlatePostProcessBlurPassInputs &Inputs)
 
void AddSlatePostProcessBlurPass (FRDGBuilder &GraphBuilder, const FSlatePostProcessBlurPassInputs &Inputs)
 
void AddSlatePostProcessCopy (FRDGBuilder &GraphBuilder, FScreenPassTexture Input, FScreenPassTexture Output)
 
void AddSlatePostProcessBlurPass (FRDGBuilder &GraphBuilder, const FSlatePostProcessSimpleBlurPassInputs &SimpleInputs)
 
 IMPLEMENT_GLOBAL_SHADER (FSlatePostProcessColorDeficiencyPS, "/Engine/Private/SlatePostProcessColorDeficiencyPixelShader.usf", "ColorDeficiencyMain", SF_Pixel)
 
void AddSlatePostProcessColorDeficiencyPass (FRDGBuilder &GraphBuilder, const FSlatePostProcessColorDeficiencyPassInputs &Inputs)
 

Variables

FAutoConsoleVariableRef CVarSlatePostBlurUseDualKawaseFilter (TEXT("UI.SlatePostBlurUseDualKawaseFilter"), SlatePostBlurDualKawaseFilterEnable, TEXT("Toggles between the old Gaussian blur implementation (0) and the new optimized Dual Kawase filter blur implementation (1)"))
 
FAutoConsoleVariableRef CVarSlatePostBlurStrengthOverride (TEXT("UI.SlatePostBlurStrengthOverride"), SlatePostBlurStrengthOverride, TEXT("Globally overrides the blur strength for all Slate post process blurs (0 = no override)"))
 

Enumeration Type Documentation

◆ ESlatePostProcessUpsampleOutputFormat

Enumerator
SDR 
HDR_SCRGB 
HDR_PQ10 
MAX 

Function Documentation

◆ AddSlateCompositeHDRForBlurPass()

FScreenPassTexture AddSlateCompositeHDRForBlurPass ( FRDGBuilder GraphBuilder,
const FSlateCompositeHDRForBlurPassInputs Inputs 
)

◆ AddSlateKawaseBlur()

FScreenPassTexture AddSlateKawaseBlur ( FRDGBuilder GraphBuilder,
const FScreenPassTexture InputTexture,
const FSlateKawaseBlurInternalConfiguration Configuration 
)

◆ AddSlatePostProcessBlurPass() [1/2]

void AddSlatePostProcessBlurPass ( FRDGBuilder GraphBuilder,
const FSlatePostProcessBlurPassInputs Inputs 
)

◆ AddSlatePostProcessBlurPass() [2/2]

void AddSlatePostProcessBlurPass ( FRDGBuilder GraphBuilder,
const FSlatePostProcessSimpleBlurPassInputs SimpleInputs 
)

◆ AddSlatePostProcessColorDeficiencyPass()

void AddSlatePostProcessColorDeficiencyPass ( FRDGBuilder GraphBuilder,
const FSlatePostProcessColorDeficiencyPassInputs Inputs 
)

◆ AddSlatePostProcessCopy()

void AddSlatePostProcessCopy ( FRDGBuilder GraphBuilder,
FScreenPassTexture  Input,
FScreenPassTexture  Output 
)

Directly copies or resamples Input into Output with bilinear interpolation if the extent is different.

◆ AddSlatePostProcessDownsamplePass()

FScreenPassTexture AddSlatePostProcessDownsamplePass ( FRDGBuilder GraphBuilder,
const FSlatePostProcessDownsamplePassInputs Inputs 
)

◆ AddSlatePostProcessOldGaussianBlur()

FScreenPassTexture AddSlatePostProcessOldGaussianBlur ( FRDGBuilder GraphBuilder,
const FSlatePostProcessBlurPassInputs Inputs 
)

◆ AddSlatePostProcessUpsamplePass()

void AddSlatePostProcessUpsamplePass ( FRDGBuilder GraphBuilder,
const FSlatePostProcessUpsampleInputs Inputs 
)

◆ CSV_DECLARE_CATEGORY_MODULE_EXTERN()

CSV_DECLARE_CATEGORY_MODULE_EXTERN ( SLATECORE_API  ,
Slate   
)

◆ GetSlateHDRUICompositeEOTF()

int GetSlateHDRUICompositeEOTF ( )

◆ GetSlateHDRUILevel()

float GetSlateHDRUILevel ( )

◆ GetSlateHDRUILuminance()

float GetSlateHDRUILuminance ( )

◆ GetSlateKawaseBlurInternalConfiguration()

FSlateKawaseBlurInternalConfiguration GetSlateKawaseBlurInternalConfiguration ( float  Sigma)

◆ GetSlateKawaseBlurUpsampleParameters()

FSlateKawaseBlurUpsampleParameters GetSlateKawaseBlurUpsampleParameters ( float  Sigma)

◆ GetSlateTransientDepthStencilFlags()

ETextureCreateFlags GetSlateTransientDepthStencilFlags ( )

◆ GetSlateTransientRenderTargetFlags()

ETextureCreateFlags GetSlateTransientRenderTargetFlags ( )

◆ IMPLEMENT_GLOBAL_SHADER() [1/7]

IMPLEMENT_GLOBAL_SHADER ( FCompositeHDRForBlurPS  ,
"/Engine/Private/CompositeUIPixelShader.usf"  ,
"CompositeUIForBlur"  ,
SF_Pixel   
)

◆ IMPLEMENT_GLOBAL_SHADER() [2/7]

IMPLEMENT_GLOBAL_SHADER ( FSlatePostProcessBlurPS  ,
"/Engine/Private/SlatePostProcessPixelShader.usf"  ,
"GaussianBlurMain"  ,
SF_Pixel   
)

◆ IMPLEMENT_GLOBAL_SHADER() [3/7]

IMPLEMENT_GLOBAL_SHADER ( FSlatePostProcessColorDeficiencyPS  ,
"/Engine/Private/SlatePostProcessColorDeficiencyPixelShader.usf"  ,
"ColorDeficiencyMain"  ,
SF_Pixel   
)

◆ IMPLEMENT_GLOBAL_SHADER() [4/7]

IMPLEMENT_GLOBAL_SHADER ( FSlatePostProcessDirectResamplePS  ,
"/Engine/Private/SlatePostProcessPixelShader.usf"  ,
"Resample1Main"  ,
SF_Pixel   
)

◆ IMPLEMENT_GLOBAL_SHADER() [5/7]

IMPLEMENT_GLOBAL_SHADER ( FSlatePostProcessOptimizedKawaseUpsamplePS  ,
"/Engine/Private/SlatePostProcessPixelShader.usf"  ,
"OptimizedKawaseUpsampleMain"  ,
SF_Pixel   
)

◆ IMPLEMENT_GLOBAL_SHADER() [6/7]

IMPLEMENT_GLOBAL_SHADER ( FSlatePostProcessResample2x2PS  ,
"/Engine/Private/SlatePostProcessPixelShader.usf"  ,
"Resample2x2Main"  ,
SF_Pixel   
)

◆ IMPLEMENT_GLOBAL_SHADER() [7/7]

IMPLEMENT_GLOBAL_SHADER ( FSlatePostProcessUpsamplePS  ,
"/Engine/Private/SlatePostProcessPixelShader.usf"  ,
"UpsampleMain"  ,
SF_Pixel   
)

Variable Documentation

◆ CVarSlatePostBlurStrengthOverride

FAutoConsoleVariableRef CVarSlatePostBlurStrengthOverride(TEXT("UI.SlatePostBlurStrengthOverride"), SlatePostBlurStrengthOverride, TEXT("Globally overrides the blur strength for all Slate post process blurs (0 = no override)")) ( TEXT("UI.SlatePostBlurStrengthOverride")  ,
SlatePostBlurStrengthOverride  ,
TEXT("Globally overrides the blur strength for all Slate post process blurs (0 = no override)")   
)

◆ CVarSlatePostBlurUseDualKawaseFilter

FAutoConsoleVariableRef CVarSlatePostBlurUseDualKawaseFilter(TEXT("UI.SlatePostBlurUseDualKawaseFilter"), SlatePostBlurDualKawaseFilterEnable, TEXT("Toggles between the old Gaussian blur implementation (0) and the new optimized Dual Kawase filter blur implementation (1)")) ( TEXT("UI.SlatePostBlurUseDualKawaseFilter")  ,
SlatePostBlurDualKawaseFilterEnable  ,
TEXT("Toggles between the old Gaussian blur implementation (0) and the new optimized Dual Kawase filter blur implementation (1)")   
)