RenderWithShader(Shader, string)
Render the camera with shader replacement.
Read time 2 minutesLast updated 6 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
public void RenderWithShader(Shader shader, string replacementTag)
Parameters
Remarks
See Rendering with Replaced Shaders page for details.
This will render the camera. It will use the camera's clear flags, target texture and all other settings.
If the replacementTag argument is not in use, pass an empty string as the value.
The camera will not send MonoBehaviour.OnPreCull(), MonoBehaviour.OnPreRender() or MonoBehaviour.OnPostRender() to attached scripts. Image filters will not be rendered either.
This is used for special effects, e.g. rendering screen space normal buffer of the whole Scene, heat vision and so on. To make use of this feature, usually you create a camera and disable it. Then call RenderWithShader on it.
You are not able to call the Render function from a camera that is currently rendering. If you wish to do this create a copy of the camera, and make it match the original one using Camera.CopyFrom.
The following example shows how to render the current camera with a replacement shader and store the result in a render texture.
Examples
using UnityEngine;using UnityEngine;public class ReplaceShader : MonoBehaviour{ public Shader overrideShader; public RenderTexture output; void Update() { // Check if there is a current camera rendering if (Camera.current != null) { // Assign the output render texture to the current camera Camera.current.targetTexture = output; // // Render the scene by replacing all the "RenderType" shaders with the overrideShader Camera.current.RenderWithShader(overrideShader, "RenderType"); // // Set the output render texture back to null to avoid side effects. Camera.current.targetTexture = null; } else { Debug.LogWarning("No current camera available for rendering."); } }}