UE4 Guide: How to Add Global Shaders
Events
Subscribe:  iCal  |  Google Calendar
San Antonio US   18, Jan — 21, Jan
London GB   21, Jan — 23, Jan
Taipei TW   24, Jan — 29, Jan
Zürich CH   31, Jan — 4, Feb
Leamington Spa GB   31, Jan — 3, Feb
Latest comments

I love it !

by chaitanya krishnan
8 hours ago

Wow this is really extensive! Thanks for sharing, I just started with tiltbrush and Masterpiece Vr using a mixed reality kit

after reading this incredible article, im still left with the question..."but, HOW?!"

UE4 Guide: How to Add Global Shaders
13 September, 2017
News

In Unreal Engine 4, global shaders are shaders that can be used from the C++ side to render post-processing effects, dispatch compute shaders, clear the screen, etc.  Sometimes you need more advanced functionality to achieve a desired look, and a custom shader pass might help you. Epic Games has shared a step-by-step guide by Rolando Caloca Olivares to doing that. Let’s check it out. 

Art by Michael Gerard

Unreal Shader Files and How To Use Them

UE4 reads .usf files (Unreal Shader Files) from the Engine/Shaders folder. Any new shaders need their source files placed here. As of 4.17, shaders can also be read from a plugin (Plugin/Shaders). You should enable r.ShaderDevelopmentMode=1 in your ConsoleVariables.ini file for ease of development. Check out the documentation for more information.

Start by adding a new .usf file in your Engine/Shaders folder and calling it MyTest.usf. Then add a simple pass-through Vertex Shader and a Pixel Shader that returns a custom color:

// MyTest.usf 

// Simple pass-through vertex shader

void MainVS(
	in float4 InPosition : ATTRIBUTE0,
	out float4 Output : SV_POSITION
)
{
	Output = InPosition;
}

// Simple solid color pixel shader
float4 MyColor;
float4 MainPS() : SV_Target0
{
	return MyColor;
}

 

Now, in order to get UE4 to pick up the shader and start compiling it, you need to declare a C++ class. Start with the Vertex Shader:

// This can go on a header or cpp file
class FMyTestVS : public FGlobalShader
{
DECLARE_EXPORTED_SHADER_TYPE(FMyTestVS, Global, /*MYMODULE_API*/);
FMyTestVS()
{
}
FMyTestVS(const ShaderMetaType::CompiledShaderInitializerType& Initializer) : FGlobalShader(Initializer)
{
}
static bool ShouldCache(EShaderPlatform Platform)
{
return true;
}
};

Make sure to continue studying global shaders here

Source: Epic Games
Comments

Leave a Reply

2 Comments on "UE4 Guide: How to Add Global Shaders"

avatar
Admin
Admin

on it

Lee
Guest
Lee

Could you please… PLEASE reformat that c++ code:
// This can go on a header or cpp file
class FMyTestVS : public FGlobalShader
{
DECLARE_EXPORTED_SHADER_TYPE(FMyTestVS, Global, /*MYMODULE_API*/);
FMyTestVS()
{
}
FMyTestVS(const ShaderMetaType::CompiledShaderInitializerType& Initializer) : FGlobalShader(Initializer)
{
}
static bool ShouldCache(EShaderPlatform Platform)
{
return true;
}
};

wpDiscuz