Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


DiscardContents

Hint the GPU driver that the contents of the RenderTexture will not be used.
Read time 2 minutesLast updated 6 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule

DiscardContents(bool, bool)

Hint the GPU driver that the contents of the RenderTexture will not be used.
public void DiscardContents(bool discardColor, bool discardDepth)

Parameters

discardColor

Should the colour buffer be discarded?

discardDepth

Should the depth buffer be discarded?

Remarks

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, XBox One and many mobile GPUs benefit from this.
This call is typically only meaningful when the given RenderTexture is currently an active render target. After this call, the contents of the RenderTexture are undefined, so the user should not attempt to access its contents before either clearing the RenderTexture or drawing into each pixel of it.
Both the colour buffer and depth buffer are discarded by default but either can be selected individually using the optional boolean parameters.

DiscardContents()

Hint the GPU driver that the contents of the RenderTexture will not be used.
public void DiscardContents()

Remarks

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, XBox One and many mobile GPUs benefit from this.
This call is typically only meaningful when the given RenderTexture is currently an active render target. After this call, the contents of the RenderTexture are undefined, so the user should not attempt to access its contents before either clearing the RenderTexture or drawing into each pixel of it.
Both the colour buffer and depth buffer are discarded by default but either can be selected individually using the optional boolean parameters.