To more efficiently read a frame that Unity rendered in a previous pass, use the SetInputAttachment
API to set the output of a render pass as the input of the next render pass.
Using SetInputAttachment
means the render pass can access the framebuffer from the on-chip memory of the GPU, instead of video memory. This speeds up rendering, because the GPU doesn’t need to copy the texture to and from its video memory. This process is sometimes called framebuffer fetch.
On mobile devices, rendering speed improves on mobile devices that use tile-based deferred rendering (TBDR). The GPU keeps the frame in its on-chip tile memory between render passes, using less memory bandwidth and processing time.
If you use the SetInputAttachment
API, URP merges the render passes that write to the framebuffer and read from it. You can check this in the Render Graph Viewer window.
You can also use SetInputAttachment
to read other render targets, for example a G-buffer.
The SetInputAttachment
API is supported if you use one of the following graphics APIs:
If you use SetInputAttachment
with an unsupported API, Unity copies the texture to and from video memory, so there’s no effect on rendering speed.
SetInputAttachment
APITo use the SetInputAttachment
API in a render pass, use the following:
SetInputAttachment
API to set the output of the previous render pass as the input of the new render pass.LOAD_FRAMEBUFFER_X_INPUT
macro in your fragment shaderA program that runs on the GPU. More infoSAMPLE_TEXTURE2D
.The following steps assume you already have one render pass that writes to a TextureHandle
called sourceTextureHandle
.
Create a custom shader, then create a material from the shader. For more information about creating a custom shader, refer to Writing custom shaders.
Inside the HLSLPROGRAM of your custom shader, make sure you import the Packages/com.unity.render-pipelines.core/Runtime/Utilities/Blit.hlsl
file:
HLSLPROGRAM ... #include "Packages/com.unity.render-pipelines.universal/ShaderLibrary/Core.hlsl" ... ENDHLSL
Inside the HLSLPROGRAM, use one of the following to declare the texture from the previous render pass. For example:
FRAMEBUFFER_INPUT_X_HALF
FRAMEBUFFER_INPUT_X_FLOAT
FRAMEBUFFER_INPUT_X_INT
FRAMEBUFFER_INPUT_X_UINT
For example:
FRAMEBUFFER_INPUT_X_HALF(0);
In the fragment function, use LOAD_FRAMEBUFFER_X_INPUT
to sample the texture from on-chip GPU memory. For example:
half4 frag() : SV_Target { half4 colorFromPreviousRenderPass = LOAD_FRAMEBUFFER_X_INPUT(0, input.positionCS.xy); return colorFromPreviousRenderPass; }
In a new render graph render pass, add the material you created to your PassData
. For example:
class PassData { public Material exampleMaterial; }
Use builder.SetInputAttachment
to set the output of the previous render pass as the input of the new render pass. For example:
builder.SetInputAttachment(sourceTextureHandle, 0, AccessFlags.Read);
In your SetRenderFunc
method, use a command such as BlitTexture
to render using the material. For example:
static void ExecutePass(PassData data, RasterGraphContext context) { Blitter.BlitTexture(context.cmd, new Vector4(1, 1, 0, 0), exampleMaterial, 1); }
For a full example, refer to the example called FrameBufferFetch in the render graph system URP package samples.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.