Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

Terrain.GetKeepUnusedCameraRenderingResources

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

Declaration

public bool GetKeepUnusedCameraRenderingResources(int cameraInstanceID);

Parameters

cameraInstanceID The InstanceID of the camera being queried. See Object.GetInstanceID.

Returns

bool Returns true if all rendering resources for the given camera are saved regardless of usage. Returns false if garbage collection is allowed to free unused resources.

Description

Each Camera has its own KeepUnusedRenderingResources setting, which is false by default. Unity uses this per-Camera setting in combination with the Terrain's overall KeepUnusedRenderingResources setting. If either setting is true, Unity preserves all rendering resources regardless of how long they've remained unused.

Additional resources: Terrain.SetKeepUnusedCameraRenderingResources, Terrain.keepUnusedRenderingResources.