When you create a texture in the render graph system in a render pass, the render graph system handles the creation and disposal of the texture. This process means the texture might not exist in the next frame, and other camerasA component which creates an image of a particular viewpoint in your scene. The output is either drawn to the screen or captured as a texture. More info
See in Glossary might not be able to use it.
To make sure a texture is available across frames and cameras, import it into the render graph system using the ImportTexture
API.
You can import a texture if you use a texture created outside the render graph system. For example, you can create a render textureA special type of Texture that is created and updated at runtime. To use them, first create a new Render Texture and designate one of your Cameras to render into it. Then you can use the Render Texture in a Material just like a regular Texture. More info
See in Glossary that points to a texture in your project, such as a texture asset, and use it as the input to a render pass.
The render graph system doesn’t manage the lifetime of imported textures. As a result, the following applies:
For more information about the RTHandle
API, refer to Using the RTHandle system.
To import a texture, in the RecordRenderGraph
method of your ScriptableRenderPass
class, follow these steps:
Create a render texture handle using the RTHandle API.
For example:
private RTHandle renderTextureHandle;
Create a RenderTextureDescriptor object with the texture properties you need.
For example:
RenderTextureDescriptor textureProperties = new RenderTextureDescriptor(Screen.width, Screen.height, RenderTextureFormat.Default, 0);
Use the ReAllocateIfNeeded method to create a render texture and attach it to the render texture handle. This method creates a render texture only if the render texture handle is null, or the render texture has different properties to the render texture descriptor.
For example:
RenderingUtils.ReAllocateIfNeeded(ref renderTextureHandle, textureProperties, FilterMode.Bilinear, TextureWrapMode.Clamp, name: "My render texture" );
Import the texture, to convert the RTHandle
object to a TextureHandle
object the render graph system can use.
For example:
TextureHandle texture = renderGraph.ImportTexture(renderTextureHandle);
You can then use the TextureHandle
object to read from or write to the render texture.
To import a texture from your project, such as an imported texture attached to a material, follow these steps:
Use the RTHandles.Alloc
API to create a render texture handle from the external texture.
For example:
RTHandle renderTexture = RTHandles.Alloc(texture);
Import the texture, to convert the RTHandle
object to a TextureHandle
object that the render graph system can use.
For example:
TextureHandle textureHandle = renderGraph.ImportTexture(renderTexture);
You can then use the TextureHandle
object to read from or write to the render texture.
You must free the memory a render texture uses at the end of a render pass, using the Dispose
method. For example:
public void Dispose() { renderTexture.Release(); }
The following Scriptable Renderer Feature contains an example render pass that copies a texture asset to a temporary texture. To use this example, follow these steps:
using UnityEngine; using UnityEngine.Rendering.Universal; using UnityEngine.Rendering.RenderGraphModule; using UnityEngine.Rendering; public class BlitFromExternalTexture : ScriptableRendererFeature { // The texture to use as input public Texture2D textureToUse; BlitFromTexture customPass; public override void Create() { // Create an instance of the render pass, and pass in the input texture customPass = new BlitFromTexture(textureToUse); customPass.renderPassEvent = RenderPassEvent.AfterRenderingPostProcessing; } public override void AddRenderPasses(ScriptableRenderer renderer, ref RenderingData renderingData) { renderer.EnqueuePass(customPass); } class BlitFromTexture : ScriptableRenderPass { class PassData { internal TextureHandle textureToRead; } private Texture2D texturePassedIn; public BlitFromTexture(Texture2D textureIn) { // In the render pass's constructor, set the input texture texturePassedIn = textureIn; } public override void RecordRenderGraph(RenderGraph renderGraph, ContextContainer frameContext) { using (var builder = renderGraph.AddRasterRenderPass<PassData>("Copy texture", out var passData)) { // Create a temporary texture and set it as the render target RenderTextureDescriptor textureProperties = new RenderTextureDescriptor(Screen.width, Screen.height, RenderTextureFormat.Default, 0); TextureHandle texture = UniversalRenderer.CreateRenderGraphTexture(renderGraph, textureProperties, "My texture", false); builder.SetRenderAttachment(texture, 0, AccessFlags.Write); // Create a render texture from the input texture RTHandle rtHandle = RTHandles.Alloc(texturePassedIn); // Create a texture handle that the render graph system can use TextureHandle textureToRead = renderGraph.ImportTexture(rtHandle); // Add the texture to the pass data passData.textureToRead = textureToRead; // Set the texture as readable builder.UseTexture(passData.textureToRead, AccessFlags.Read); builder.AllowPassCulling(false); builder.SetRenderFunc((PassData data, RasterGraphContext context) => ExecutePass(data, context)); } } static void ExecutePass(PassData data, RasterGraphContext context) { // Copy the imported texture to the render target Blitter.BlitTexture(context.cmd, data.textureToRead, new Vector4(0.8f,0.6f,0,0), 0, false); // Dispose of the texture RTHandles.Release(data.textureToRead); } } }
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.