struct in UnityEngine.Rendering
/
Implemented in:UnityEngine.CoreModule
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.
CloseFor 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.
CloseDefines state and drawing commands that custom render pipelines use.
When you define a custom RenderPipeline, you use a ScriptableRenderContext to schedule and submit state updates and drawing commands to the GPU.
A RenderPipeline.Render method implementation typically culls objects that the render pipeline doesn't need to render for every Camera (see CullingResults), and then makes a series of calls to ScriptableRenderContext.DrawRenderers intermixed with ScriptableRenderContext.ExecuteCommandBuffer calls. These calls set up global Shader properties, change render targets, dispatch compute shaders, and other rendering tasks. To actually execute the render loop, call ScriptableRenderContext.Submit.
Additional resources: RenderPipeline.
BeginRenderPass | Schedules the beginning of a new render pass. Only one render pass can be active at any time. |
BeginScopedRenderPass | Schedules the beginning of a new render pass. If you call this a using-statement, Unity calls EndRenderPass automatically when exiting the using-block. Only one render pass can be active at any time. |
BeginScopedSubPass | Schedules the beginning of a new sub pass within a render pass. If you call this in a using-statement, Unity executes EndSubPass automatically when exiting the using-block. Render passes can never be standalone, they must always contain at least one sub pass. Only one sub pass can be active at any time. |
BeginSubPass | Schedules the beginning of a new sub pass within a render pass. Render passes can never be standalone, they must always contain at least one sub pass. Only one sub pass can be active at any time. |
CreateGizmoRendererList | Creates a new Gizmo RendererList. |
CreateRendererList | Creates a new renderers RendererList. |
CreateShadowRendererList | Creates a new shadow RendererList. |
CreateSkyboxRendererList | Creates a new skybox RendererList. |
CreateUIOverlayRendererList | Creates a new UIOverlay RendererList. |
CreateWireOverlayRendererList | Creates a new WireOverlay RendererList. |
Cull | Performs culling based on the ScriptableCullingParameters typically obtained from the Camera currently being rendered. |
CullShadowCasters | Performs shadow casters culling for all the visible lights. |
DrawGizmos | Schedules the drawing of a subset of Gizmos (before or after post-processing) for the given Camera. |
DrawUIOverlay | Draw the UI overlay. |
DrawWireOverlay | Schedules the drawing of a wireframe overlay for a given Scene view Camera. |
EndRenderPass | Schedules the end of a currently active render pass. |
EndSubPass | Schedules the end of the currently active sub pass. |
ExecuteCommandBuffer | Schedules the execution of a custom graphics Command Buffer. |
ExecuteCommandBufferAsync | Schedules the execution of a Command Buffer on an async compute queue. The ComputeQueueType that you pass in determines the queue order. |
HasInvokeOnRenderObjectCallbacks | Check if any objects in the scene have OnRenderObject callbacks registered. |
InvokeOnRenderObjectCallback | Schedules an invocation of the OnRenderObject callback for MonoBehaviour scripts. |
PrepareRendererListsAsync | Starts to process the provided RendererLists in the background. |
QueryRendererListStatus | Queries the status of a RendererList. |
SetupCameraProperties | Schedules the setup of Camera specific global Shader variables. |
StartMultiEye | Schedules a fine-grained beginning of stereo rendering on the ScriptableRenderContext. |
StereoEndRender | Schedule notification of completion of stereo rendering on a single frame. |
StopMultiEye | Schedules a stop of stereo rendering on the ScriptableRenderContext. |
Submit | Submits all the scheduled commands to the rendering loop for execution. |
SubmitForRenderPassValidation | This method submits all the scheduled commands to the rendering loop for validation. The validation checks whether render passes that were started with the BeginRenderPass call can execute the scheduled commands. |
EmitGeometryForCamera | Emits UI geometry for rendering for the specified camera. |
EmitWorldGeometryForSceneView | Emits UI geometry into the Scene view for rendering. |
PopDisableApiRenderers | Enable the immediate addition and removal of renderer scene nodes to the scene arrays. |
PushDisableApiRenderers | Prevent the immediate addition or removal of renderer scene nodes to the scene arrays. This protects against the creation of invalid indices or dangling pointers caused by changes to the scene arrays after the culling output has been computed. |
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.