Legacy Documentation: Version 2017.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.

ScriptableRenderContext

struct in UnityEngine.Experimental.Rendering

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

Description

Defines state and drawing commands used in a custom render pipelines.

When defining a custom RenderPipeline, a ScriptableRenderContext is used to set state and drawing commands to be submitted to the GPU.

A RenderPipeline.Render method implementation typically culls objects that don't need to be rendered for all the Cameras (see CullResults), 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. Finally, ScriptableRenderContext.Submit is called to execute the render loop.

See Also: RenderPipeline.

Public Functions

DrawRenderersDraw subset of visible objects.
DrawShadowsDraw shadow casters for a single light.
DrawSkyboxDraw skybox.
ExecuteCommandBufferExecute a custom graphics command buffer.
SetupCameraPropertiesSetup camera specific global shader variables.
SubmitSubmit rendering loop for execution.

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