cullingResults | Specifies which set of visible objects to draw, typically obtained from Cull. |
drawingSettings | Specifies how to draw GameObjects. |
filteringSettings | Specifies how the render pipeline should further filter the Renderers in the Scene. |
stateBlock | Specifies parts of the render state to override. |
renderTypes | Specifies render types whose render states are overridden. |
stateBlocks | Specifies parts of the render state to override for specific render types. |
Schedules the drawing of a subset of visible GameObjects.
During the call to ScriptableRenderContext.DrawRenderers, ScriptableRenderContext registers the draw parameters into its own internal list of commands to execute.
The actual execution of these commands happens during ScriptableRenderContext.Submit.
If you supply a state block, it overrides the render state for all GameObjects that the render pipeline draws during the function call. If you supply an array of RenderTypes, it overrides the render state for GameObjects where the RenderType of the sub-shader matches a value in the array. If multiple mappings match, Unity uses the first one. A mapping with renderType set to null matches everything.
Make sure that you call ExecuteCommandBuffer before DrawRenderers if your draw call depends on a state of the pipeline that you specify in a CommandBuffer.
The code sample below illustrates a case when commands are submitted in an incorrect order; followed by a case that behaves as expected:
using UnityEngine; using UnityEngine.Rendering;
internal class ExecuteCommandBufferExample { // TODO: replace with actual settings ScriptableRenderContext scriptableRenderContext; DrawingSettings drawingSettings; CullingResults cullingResults = new CullingResults(); FilteringSettings filteringSettings = new FilteringSettings();
Matrix4x4 myViewMatrix = Matrix4x4.Scale(new Vector3(2f, 2f, 2f));
public void DrawRenderersExampleIncorrect() { CommandBuffer myCommandBuffer = new CommandBuffer();
myCommandBuffer.SetViewMatrix(myViewMatrix);
scriptableRenderContext.DrawRenderers(cullingResults, ref drawingSettings, ref filteringSettings); // NO! When scriptableRenderContext submits the DrawRenderers command, it will not know about myViewMatrix :(
scriptableRenderContext.ExecuteCommandBuffer(myCommandBuffer); myCommandBuffer.Clear(); }
public void DrawRenderersExampleBetter() { CommandBuffer myCommandBuffer = new CommandBuffer();
myCommandBuffer.SetViewMatrix(myViewMatrix);
scriptableRenderContext.ExecuteCommandBuffer(myCommandBuffer); myCommandBuffer.Clear();
scriptableRenderContext.DrawRenderers(cullingResults, ref drawingSettings, ref filteringSettings); // OK! During next scriptableRenderContext.Submit() call, scriptableRenderContext will set myViewMatrix *before* drawing the renderers. } }
See Also: CullingResults, DrawingSettings, FilteringSettings, RenderStateBlock.
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.