Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

RenderTexture.DiscardContents

DiscardContents(): void;
void DiscardContents();
def DiscardContents() as void
DiscardContents(discardColor: bool, discardDepth: bool): void;
void DiscardContents(bool discardColor, bool discardDepth);
def DiscardContents(discardColor as bool, discardDepth as bool) as void

Parameters

discardColorShould the colour buffer be discarded?
discardDepthShould 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 anymore. 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.