Notifications
Article
Adding your own HLSL code to Shader Graph: the Custom Function node
Published 6 months ago
3.4 K
10
Using Shader Graph 6.6's new functionality to expand the node library
Previously, I wrote a short article on how to get lighting information in Shader Graph, for the purpose of creating toon shaders (like my Zelda-inspired one) and the like. However, with Shader Graph getting out of Preview state (in the Unity 2019.1 lifecycle), the APIs I previously mentioned are no longer available.
Instead, Shader Graph now has a pre-made node called Custom Function, which wraps custom HLSL code and allows it to interact with the rest of the graph. This is a better solution than before since there is no need to create a custom C# class, leading to more reusable HLSL code.
It is found under Utility > Custom Function:
Warning: the Custom Function node is available only as of Shader Graph 6.6. If you are on a previous version, you will not see it in the menu. This post focuses on the Lightweight Render Pipeline, but the same process works for HDRP too.
Assets: To see an example of the setup shown below, you can download this mini reproduction project (provided as-is).

Setting up the node

The node will initially be useless, and have no input or output ports. Configuring it is very simple, and it's composed of two steps. By clicking on the cog in the corner of the node, you will see the dropdown menu that allows you to: 1) define the ports and 2) point the node to either a string, or an external file.
In the screenshot, you can see how I have defined a Vector3 input (ObjPos) and 3 outputs of different types (Direction, Color and ShadowAttenuation):
On the left of this list you can also rename both inputs and outputs, a very important step since the names have to match with the names of variables in the HLSL code.
The second step is to provide the code. You can choose it to be a String, and paste it directly in the text box, or a File, which will allow you to define Name and Source. Name is the name of the function in the HLSL code you will call, and Source is the path to the file itself.
The name of the function has to match the one in the code (see below), and the path starts from Assets and is absolute.

Writing the code

I have no tutorial here since what you write inside the HLSL is up to you, obviously. However, there are a few guidelines. Let's take this code as an example:
void LWRPLightingFunction_float (float3 ObjPos, out float3 Direction, out float3 Color, out float ShadowAttenuation) { #ifdef LIGHTWEIGHT_LIGHTING_INCLUDED //Actual light data from the pipeline Light light = GetMainLight(GetShadowCoord(GetVertexPositionInputs(ObjPos))); Direction = light.direction; Color = light.color; ShadowAttenuation = light.shadowAttenuation; #else //Hardcoded data, used for the preview shader inside the graph //where light functions are not available Direction = float3(-0.5, 0.5, -0.5); Color = float3(1, 1, 1); ShadowAttenuation = 0.4; #endif }
The purpose of this code is to tap into the lighting pipeline and return 3 values (Direction, Color and ShadowAttenuation) by calling some pipeline functions (GetMainLight, GetShadowCoord, etc.).
First, the name of the function and the input/output have to match what you defined in the node. The function name actually incorporates the exit type, so in my case is LWRPLightingFunction_float . The function itself is of type void.
Second, every output parameter has to use the out keyword. You want - at some point - to assign a value to each of your output parameters.

Tapping into the pipeline

And that's it, really. The only thing worth noticing here, is that if your custom HLSL node contains pipeline functions (like mine) it will generally work in the scene view, but it won't compile in the graph itself, leading to something like this:
This is because the preview shader used in the graph has no connection to the whole pipeline, and is not able to access all of its functions. You can see the compilation errors in the Console.
To fix this, you can create branches in the code using #ifdef directives, to provide code that is graph-safe. In my case, I check for a constant called LIGHTWEIGHT_LIGHTING_INCLUDED which is exactly the library I am using for my functions, and - if not present - I output from the node some fake, hardcoded data (see comments). That fixes the issue, and now the custom node works in both scenarios.

Conclusions

Using the Custom Function node is a very powerful tool in your inventory to do something special in your shaders, which in turn will allow your game to obtain the look you really want. It's also one of the easiest ways to start customising the rendering using the SRPs.
Ciro Continisio
Technical Evangelist - Educator
7
Comments
Ciro Continisio
Staff
2 months ago
Technical Evangelist
MlleBunHello @Ciro Continisio, thanks for porting this shader to the new ShaderGraph! One question, how to support additional lights (point and spotlights) ?
My colleague Alex Lindman wrote a great blog post on the subject! https://blogs.unity3d.com/2019/07/31/custom-lighting-in-shader-graph-expanding-your-graphs-in-2019/ Comes with assets and code.
0
MlleBun
4 months ago
Lead Motion Kit Animation
Hello @Ciro Continisio, thanks for porting this shader to the new ShaderGraph! One question, how to support additional lights (point and spotlights) ?
2
Ciro Continisio
Staff
4 months ago
Technical Evangelist
Dwight Potvin@Ciro Continisio Is there anything special needed to get the file to correctly be added into a build? I have to open the shader in Unity unless everything is black, but no matter what I have tried everything is black when doing a build. It is as if the file is not being included.
Not that I know… try Reimporting the LWRP and Shader Graph package and see if it helps?
0
Ciro Continisio
Staff
4 months ago
Technical Evangelist
Vincent Christiaens@Ciro Continisio Is there any way to having cast shadows using this shader?
It casts shadows already.
0
Ciro Continisio
Staff
4 months ago
Technical Evangelist
Not just with a surface shader… you can do brush strokes on the surface, but not outside of it. You would need a shader for a screen-space post effect!
1