Legacy Documentation: Version 2018.1 (Go to current version)
  • C#
  • JS

Script language

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

Experimental: this API is experimental and might be changed or removed in the future.


class in UnityEngine.Experimental.Rendering


Inherits from:Object


Implemented in:UnityEngine.CoreModule

Suggest a change


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.


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.




A declaration of a single color or depth rendering surface to be attached into a RenderPass.

A RenderPassAttachment object identifies a single color or depth rendering surface that can be used with a RenderPass. Note that the RenderPassAttachment object derives from UnityEngine.Object so they do not get garbage collected like normal C# objects. Instead, they are only GC'd when unloading a scene or when Resources.UnloadUnusedAssets() is called. Therefore do not create these objects each frame: Instead, create these objects in the constructor of your rendering class, and reuse those objects each frame.


clearColorThe currently assigned clear color for this attachment. Default is black.
clearDepthCurrently assigned depth clear value for this attachment. Default value is 1.0.
clearStencilCurrently assigned stencil clear value for this attachment. Default is 0.
formatThe RenderTextureFormat of this attachment.
loadActionThe load action to be used on this attachment when the RenderPass starts.
storeActionThe store action to use with this attachment when the RenderPass ends. Only used when either BindSurface or BindResolveSurface has been called.


RenderPassAttachmentCreate a RenderPassAttachment to be used with RenderPass.

Public Methods

BindResolveSurfaceWhen the renderpass that uses this attachment ends, resolve the MSAA surface into the given target.
BindSurfaceBinds this RenderPassAttachment to the given target surface.
ClearWhen the RenderPass starts, clear this attachment into the color or depth/stencil values given (depending on the format of this attachment). Changes loadAction to RenderBufferLoadAction.Clear.

Inherited Members


hideFlagsShould the object be hidden, saved with the scene or modifiable by the user?
nameThe name of the object.

Public Methods

GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the GameObject.

Static Methods

DestroyRemoves a gameobject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadMakes the object target not be destroyed automatically when loading a new scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active loaded objects of Type type.
InstantiateClones the object original and returns the clone.


boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.

Did you find this page useful? Please give it a rating: