Version: 2019.4
LanguageEnglish
  • C#

ScriptableRenderContext.DrawRenderers

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

Declaration

public void DrawRenderers(Rendering.CullingResults cullingResults, ref Rendering.DrawingSettings drawingSettings, ref Rendering.FilteringSettings filteringSettings);

Declaration

public void DrawRenderers(Rendering.CullingResults cullingResults, ref Rendering.DrawingSettings drawingSettings, ref Rendering.FilteringSettings filteringSettings, ref Rendering.RenderStateBlock stateBlock);

Declaration

public void DrawRenderers(Rendering.CullingResults cullingResults, ref Rendering.DrawingSettings drawingSettings, ref Rendering.FilteringSettings filteringSettings, NativeArray<ShaderTagId> renderTypes, NativeArray<RenderStateBlock> stateBlocks);

Parameters

cullingResults The set of visible objects to draw. You typically obtain this from ScriptableRenderContext.Cull.
drawingSettings A struct that describes how to draw the objects.
filteringSettings A struct that describes how to filter the set of visible objects, so that Unity only draws a subset.
stateBlock A set of values that Unity uses to override the GPU's render state.
renderTypes An array of ShaderTagId structs, where the name is the value of a SubShader Tag that has the name "RenderType".
stateBlocks An array of structs that describe which parts of the GPU's render state to override.

Description

Schedules the drawing of a set of visible objects, and optionally overrides the GPU's render state.

This function creates commands to draw the specified geometry, and adds the commands to the internal command list of the ScriptableRenderContext. The ScriptableRenderContext executes all the commands in its internal list when ScriptableRenderContext.Submit is called.

For a full example that demonstrates how to use this function in context, see Creating a simple render loop in a custom render pipeline. This short example demonstrates using a CommandBuffer to set the view matrix, and then calling this function to draw geometry using that matrix:

using UnityEngine;
using UnityEngine.Rendering;

public class ExecuteCommandBufferExample { ScriptableRenderContext scriptableRenderContext;

// Placeholder data DrawingSettings exampleDrawingSettings; CullingResults exampleCullingResults = new CullingResults(); FilteringSettings exampleFilteringSettings = new FilteringSettings();

public void Draw() { // Create a CommandBuffer to set the view matrix Matrix4x4 exampleViewMatrix = Matrix4x4.Scale(new Vector3(2f, 2f, 2f)); CommandBuffer myCommandBuffer = new CommandBuffer(); myCommandBuffer.SetViewMatrix(exampleViewMatrix);

// Schedule the execution of the CommandBuffer scriptableRenderContext.ExecuteCommandBuffer(myCommandBuffer); myCommandBuffer.Clear();

// Schedule the drawing operation scriptableRenderContext.DrawRenderers(exampleCullingResults, ref exampleDrawingSettings, ref exampleFilteringSettings);

// Perform all scheduled tasks, in the order that they were scheduled // This means that the CommandBuffer is executed before the drawing operation occurs scriptableRenderContext.Submit(); } }

Overriding the render state

When you draw geometry using this function, you can use one or more RenderStateBlock structs to override the GPU's render state in the following ways:

You can use the stateBlock parameter to provide a single RenderStateBlock struct. Unity uses the render state defined in stateBlock for all the geometry that this function draws.

You can use the stateBlocks parameter to provide an array of RenderStateBlock structs, and the renderTypes parameter to provide an array of values for the SubShader Tag with a name of RenderType. For each element in the renderTypes array, if Unity finds geometry with a SubShader Tag name of RenderType and a matching value, it uses the render state defined in the corresponding element of the stateBlocks array. If there are multiple matches, Unity uses the first one. If an element in the renderTypes array has the default value for ShaderTagId, Unity treats this as a catch-all and uses the corresponding render state for all geometry.

This example demonstrates how to override the render state:

using UnityEngine;
using UnityEngine.Rendering;
using Unity.Collections;

public class OverrideRenderStateExample { ScriptableRenderContext scriptableRenderContext;

// Placeholder data DrawingSettings exampleDrawingSettings; CullingResults exampleCullingResults = new CullingResults(); FilteringSettings exampleFilteringSettings = new FilteringSettings();

// Override the render state for all geometry that this function draws public void OverrideRenderStateForAll() { // Tell Unity how to override the render state var stateBlock = new RenderStateBlock(RenderStateMask.Depth); stateBlock.depthState = new DepthState(true, CompareFunction.LessEqual);

// Schedule a command to draw the geometry using the desired render state // Unity will execute all scheduled commands during the next call to ScriptableRenderContext.Submit scriptableRenderContext.DrawRenderers(exampleCullingResults, ref exampleDrawingSettings, ref exampleFilteringSettings, ref stateBlock); }

// Override the render state for all geometry that has a SubShader Tag // with a name of "RenderType" and a value of "ExampleRenderTypeTagValue" public void OverrideRenderStateUsingRenderTypeTag() { // Create the parameters that tell Unity how to override the render state var stateBlock = new RenderStateBlock(RenderStateMask.Depth); stateBlock.depthState = new DepthState(true, CompareFunction.Greater); var stateBlocks = new NativeArray<RenderStateBlock>(1, Allocator.Temp); stateBlocks[0] = stateBlock;

// Create the parameters that tell Unity when to override the render state ShaderTagId renderType = new ShaderTagId("ExampleRenderTypeTagValue"); var renderTypes = new NativeArray<ShaderTagId>(1, Allocator.Temp); renderTypes[0] = renderType;

// Schedule a command to draw the geometry using the desired render state // Unity will execute all scheduled commands during the next call to ScriptableRenderContext.Submit scriptableRenderContext.DrawRenderers(exampleCullingResults, ref exampleDrawingSettings, ref exampleFilteringSettings, renderTypes, stateBlocks);

// DrawRenderers copies the array contents, so it is safe to dispose of the native arrays stateBlocks.Dispose(); renderTypes.Dispose(); } }