To add your own texture to the cameraA 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 history and read the data in later frames, create a camera history type to store the texture between frames.
Follow these steps:
Create a class that inherits from CameraHistoryItem
. For example:
public class ExampleHistoryType : CameraHistoryItem { ... }
In the class, add an id for the camera history system. For example:
private int uniqueId;
The id represents the complete history of one texture, including the current and previous frames.
You can also add any other data you need, for example a texture descriptor you need to store between frames.
Override the OnCreate
method. In the method, call the OnCreate
method of the parent class, and generate the unique id. For example:
public override void OnCreate(BufferedRTHandleSystem owner, uint typeId) { // Call the OnCreate method of the parent class base.OnCreate(owner, typeId); // Generate the unique id uniqueId = MakeId(0); }
Create public properties for the current and previous textures, so that render passes can access them. For example:
public RTHandle currentTexture => GetCurrentFrameRT(uniqueId); public RTHandle previousTexture => GetPreviousFrameRT(uniqueId);
Allocate memory for the texture. For example:
// Allocate 2 textures using a texture descriptor, assign them to the uniqueId, and give them a name. AllocHistoryFrameRT(uniqueId, 2, ref textureDescriptor, "ExampleHistoryTexture");
Implement the Reset
method to release the history textures when the camera history system resets the type. For example:
public override void Reset() { ReleaseHistoryFrameRT(uniqueId); }
You might also need to reallocate memory each frame if a render pass writes a texture with a different size or format.
To write to the texture you created, follow these steps:
To request access to the texture in a ScriptableRenderPass
class, use the RequestAccess
API with your camera history type. For example:
cameraData.historyManager.RequestAccess<ExampleHistoryType>();
Get the texture for the current frame for writing, and convert it to a handle the render graph system can use. For example:
// Get the textures ExampleHistoryType history = cameraData.historyManager.GetHistoryForWrite<ExampleHistoryType>(); // Get the texture for the current frame RTHandle historyTexture = history?.currentTexture; // Convert the texture into a handle the render graph system can use historyTexture = renderGraph.ImportTexture(historyTexture);
You can then write to the texture in your render pass. For more information, refer to Using textures.
To read from the texture, use the RequestAccess
API with the camera history type you created.
You must write to the texture before you read from it.
For more information, refer to Get data from previous frames.
The following is an example of a camera history type.
using UnityEngine; using UnityEngine.Rendering; public class ExampleHistoryType : CameraHistoryItem { private int m_Id; // Add a descriptor for the size and format of the texture. private RenderTextureDescriptor m_Descriptor; // Add a hash key to track changes to the descriptor. private Hash128 m_DescKey; public override void OnCreate(BufferedRTHandleSystem owner, uint typeId) { base.OnCreate(owner, typeId); m_Id = MakeId(0); } // Release the history GPU resources (textures) when the camera history system resets the type. public override void Reset() { ReleaseHistoryFrameRT(m_Id); } public RTHandle currentTexture => GetCurrentFrameRT(m_Id); public RTHandle previousTexture => GetPreviousFrameRT(m_Id); // The render pass calls the Update method every frame, to initialize, update, or dispose of the textures. public void Update(RenderTextureDescriptor textureDescriptor) { // Dispose of the textures if the memory needs to be reallocated. if (m_DescKey != Hash128.Compute(ref textureDescriptor)) ReleaseHistoryFrameRT(m_Id); // Allocate the memory for the textures if it's not already allocated. if (currentTexture == null) { AllocHistoryFrameRT(m_Id, 2, ref textureDescriptor, "HistoryTexture"); // Store the descriptor and hash key for future changes. m_Descriptor = textureDescriptor; m_DescKey = Hash128.Compute(ref textureDescriptor); } } }
The following is an example of a render pass that writes to the texture. You can use a URP material as the material
, and a Scriptable Renderer Feature to inject the render pass into the render pipelineA series of operations that take the contents of a Scene, and displays them on a screen. Unity lets you choose from pre-built render pipelines, or write your own. More info
See in Glossary.
using UnityEngine; using UnityEngine.Rendering; using UnityEngine.Rendering.Universal; using UnityEngine.Rendering.RenderGraphModule; class WriteToHistoryTexture : ScriptableRenderPass { // Property for the custom material that writes to the history texture. public Material m_Material; private class PassData { internal Material material; } public override void RecordRenderGraph(RenderGraph renderGraph, ContextContainer frameData) { var cameraData = frameData.Get<UniversalCameraData>(); // Request access to the history texture. cameraData.historyManager.RequestAccess<ExampleHistoryType>(); var history = cameraData.historyManager.GetHistoryForWrite<ExampleHistoryType>(); if (history != null) { // Make the history a color-only texture to match the camera target. var historyDesc = cameraData.cameraTargetDescriptor; historyDesc.depthBufferBits = 0; historyDesc.msaaSamples = 1; // Call the Update method of the camera history type. history.Update(historyDesc); using (var builder = renderGraph.AddRasterRenderPass<PassData>("Write to history texture", out var passData)) { UniversalResourceData resourceData = frameData.Get<UniversalResourceData>(); RTHandle historyTexture = history?.currentTexture; // Set the render graph to render to the history texture. builder.SetRenderAttachment(renderGraph.ImportTexture(historyTexture), 0, AccessFlags.Write); passData.material = m_Material; builder.SetRenderFunc(static (PassData data, RasterGraphContext context) => { // Draw a triangle to the history texture context.cmd.DrawProcedural(Matrix4x4.identity, data.material, 0, MeshTopology.Triangles, 3, 1); }); } } } }
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.