Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • 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.

RenderPassAttachment.BindSurface

Other Versions
Leave feedback
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

public method BindSurface(tgt: Rendering.RenderTargetIdentifier, loadExistingContents: bool, storeResults: bool): void;
public void BindSurface(Rendering.RenderTargetIdentifier tgt, bool loadExistingContents, bool storeResults);

Parameters

tgtThe surface to use as the backing storage for this RenderPassAttachment.
loadExistingContentsWhether to read in the existing contents of the surface when the RenderPass starts.
storeResultsWhether to store the rendering results of the attachment when the RenderPass ends.

Description

Binds this RenderPassAttachment to the given target surface.

This method sets the backing storage of this RenderPassAttachment to the given target surface.

If loadExistingContents is true, changes loadAction to RenderBufferStoreAction.Load unless the load action is already set to RenderBufferStoreAction.Clear, in which case this parameter is ignored.

If storeResults is true, changes storeAction to either RenderBufferStoreAction.Resolve or RenderBufferStoreAction.StoreAndResolve depending on whether BindResolveSurface has also been called.

The format of the target surface must match with the format given in the constructor, and the target surface dimensions and sample count must match the values given in the RenderPass contructor.

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

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2018 Unity Technologies. Publication: 2018.1-002N. Built: 2018-12-04.
TutorialsCommunity AnswersKnowledge BaseForumsAsset StoreLegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information