Built-in shader helper functions

Unity has a number of built-in utility functions designed to make writing shadersA small script that contains the mathematical calculations and algorithms for calculating the Color of each pixel rendered, based on the lighting input and the Material configuration. More info
See in Glossary simpler and easier.

Functions declared in UnityCG.cginc

See Built-in shader include files for an overview of shader include files provided with Unity.

Vertex transformation functions in UnityCG.cginc

Function:	Description:
`float4 UnityObjectToClipPos(float3 pos)`	Transforms a point from object space to the cameraA component which creates an image of a particular viewpoint in your scene. The output is either drawn to the screen or captured as a texture. More info See in Glossary’s clip space in homogeneous coordinates. This is the equivalent of mul(UNITY_MATRIX_MVP, float4(pos, 1.0)), and should be used in its place.
`float3 UnityObjectToViewPos(float3 pos)`	Transforms a point from object space to view space. This is the equivalent of mul(UNITY_MATRIX_MV, float4(pos, 1.0)).xyz, and should be used in its place.

Generic helper functions in UnityCG.cginc

Function:	Description:
`float3 WorldSpaceViewDir (float4 v)`	Returns world space direction (not normalized) from given object space vertex position towards the camera.
`float3 ObjSpaceViewDir (float4 v)`	Returns object space direction (not normalized) from given object space vertex position towards the camera.
`float2 ParallaxOffset (half h, half height, half3 viewDir)`	calculates UV offset for parallax normal mapping.
`fixed Luminance (fixed3 c)`	Converts color to luminance (grayscale).
`fixed3 DecodeLightmap (fixed4 color)`	Decodes color from Unity lightmapA pre-rendered texture that contains the effects of light sources on static objects in the scene. Lightmaps are overlaid on top of scene geometry to create the effect of lighting. More info See in Glossary (RGBM or dLDR depending on platform).
`float4 EncodeFloatRGBA (float v)`	Encodes [0..1) range float into RGBA color, for storage in low precision render target.
`float DecodeFloatRGBA (float4 enc)`	Decodes RGBA color into a float.
`float2 EncodeFloatRG (float v)`	Encodes [0..1) range float into a float2.
`float DecodeFloatRG (float2 enc)`	Decodes a previously-encoded RG float.
`float2 EncodeViewNormalStereo (float3 n)`	Encodes view space normal into two numbers in 0..1 range.
`float3 DecodeViewNormalStereo (float4 enc4)`	Decodes view space normal from enc4.xy.

Forward rendering helper functions in UnityCG.cginc

These functions are only useful when using forward renderingA rendering path that renders each object in one or more passes, depending on lights that affect the object. Lights themselves are also treated differently by Forward Rendering, depending on their settings and intensity. More info
See in Glossary (ForwardBase or ForwardAdd pass types).

Function:	Description:
`float3 WorldSpaceLightDir (float4 v)`	Computes world space direction (not normalized) to light, given object space vertex position.
`float3 ObjSpaceLightDir (float4 v)`	Computes object space direction (not normalized) to light, given object space vertex position.
`float3 Shade4PointLights (...)`	Computes illumination from four point lights, with light data tightly packed into vectors. Forward renderingThe process of drawing graphics to the screen (or to a render texture). By default, the main camera in Unity renders its view to the screen. More info See in Glossary uses this to compute per-vertex lighting.

Screen-space helper functions in UnityCG.cginc

The following functions are helpers to compute coordinates used for sampling screen-space textures. They return float4 where the final coordinate to sample texture with can be computed via perspective division (for example xy/w).

The functions also take care of platform differences in render textureA special type of Texture that is created and updated at runtime. To use them, first create a new Render Texture and designate one of your Cameras to render into it. Then you can use the Render Texture in a Material just like a regular Texture. More info
See in Glossary coordinates.

Function:	Description:
`float4 ComputeScreenPos (float4 clipPos)`	Computes texture coordinate for doing a screenspace-mapped texture sample. Input is clip space position.
`float4 ComputeGrabScreenPos (float4 clipPos)`	Computes texture coordinate for sampling a GrabPass texure. Input is clip space position.

Vertex-lit helper functions in UnityCG.cginc

These functions are only useful when using per-vertex lit shaders (“Vertex” pass type).

Function:	Description:
`float3 ShadeVertexLights (float4 vertex, float3 normal)`	Computes illumination from four per-vertex lights and ambient, given object space position & normal.

Did you find this page useful? Please give it a rating:

Report a problem on this page

Predefined Shader preprocessor macros

Built-in shader variables