Version: 5.5 (switch to 5.6b)
LanguageEnglish
  • C#
  • JS

Script language

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

RenderTexture.DiscardContents

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
public function DiscardContents(): void;
public void DiscardContents();
public function DiscardContents(discardColor: bool, discardDepth: bool): void;
public void DiscardContents(bool discardColor, bool discardDepth);

Parameters

discardColor Should the colour buffer be discarded?
discardDepth Should the depth buffer be discarded?

Description

Discards the contents of the RenderTexture.

On some platforms, it can be good for performance if you indicate when the current contents of a RenderTexture aren't needed any more. This can save copying it from one kind of memory to another when the texture is reused. Xbox 360 and many mobile GPUs benefit from this.

Both the colour buffer and depth buffer are discarded by default but either can be selected individually using the optional boolean parameters.

Copyright © 2016 Unity Technologies. Publication 5.5-001B
Tutorials Community Answers Knowledge Base Forums Asset Store