Version: 2017.1 (switch to 2017.2b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

MonoBehaviour.OnWillRenderObject()

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

Description

OnWillRenderObject is called for each camera if the object is visible.

The function is not called if the MonoBehaviour is disabled.

The function is called during the culling process just before rendering each culled object. For usage in a proper context, see the script Water.cs in Assets->Import Package->Effects

Note that Camera.current will be set to the camera that will render the object.

var rend: Renderer;

function Start() { rend = GetComponent.<Renderer>(); }

function OnWillRenderObject() { // Tint the object red for identification if it is // being shown on the overhead mini-map view. if (Camera.current.name == "MiniMapcam") { rend.material.color = Color.red; } else { rend.material.color = Color.white; } }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { public Renderer rend; void Start() { rend = GetComponent<Renderer>(); } void OnWillRenderObject() { if (Camera.current.name == "MiniMapcam") rend.material.color = Color.red; else rend.material.color = Color.white; } }

Also, this is called multiple times per frame.