Version: 2020.3
LanguageEnglish
  • C#

How do you use documentation throughout your workflow? Share your experience with us by taking this survey.

MonoBehaviour.OnPreCull()

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual

Description

Event function that Unity calls before a Camera culls the scene.

In the Built-in Render Pipeline, Unity calls OnPreCull on MonoBehaviours that are attached to the same GameObject as an enabled Camera component, just before that Camera performs the culling operation that determines what it can see. Use OnPreCull to execute your own code at this point in the render loop; for example, you can change the Camera's settings before performing the culling operation, to affect what the Camera sees. OnPreCull can be a coroutine.

For similar functionality that does not require the script to be on the same GameObject as a Camera component, see Camera.onPreCull. For similar functionality in the Scriptable Render Pipeline, see RenderPipelineManager.

// Attach this to the same GameObject as a Camera component.
// This script inverts the view of the Camera, so that everything rendered by it is flipped

using UnityEngine; using System.Collections;

public class ExampleClass : MonoBehaviour { Camera cam;

void Start() { cam = GetComponent<Camera>(); }

void OnPreCull() { cam.ResetWorldToCameraMatrix(); cam.ResetProjectionMatrix(); cam.projectionMatrix = cam.projectionMatrix * Matrix4x4.Scale(new Vector3(1, -1, 1)); }

void OnPreRender() { GL.invertCulling = true; }

void OnPostRender() { GL.invertCulling = false; } }