| 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. |
| tagName | Specifies the name of the Pass Tag or SubShader Tag that identifies renderers whose render state will be overridden. When this is not specified, the default value is "RenderType". |
| isPassTagName | If set to true, tagName specifies a Pass Tag. If set to false, tagName specifies a SubShader Tag. When this is not specified, the default value is false. |
| tagValues | Specifies the values of the Pass Tag or SubShader Tag that identifies renderers whose render state will be overridden. |
| 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.