RenderStateBlock

Description

A set of values that Unity uses to override the GPU's render state.

When you call ScriptableRenderContext.DrawRenderers, you can use this to override the render state for some or all of the geometry.

Note: You must set mask to tell Unity which parts of the render state to override to apply. For example, to apply the values in blendState, mask must include RenderStateMask.Blend.

using UnityEngine;
using UnityEngine.Rendering;

public class OverrideRenderStateExample
{
    ScriptableRenderContext scriptableRenderContext;

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

    public void OverrideRenderState()
    {
        // Tell Unity how to override the render state when it draws the geometry.
        var stateBlock = new RenderStateBlock(RenderStateMask.Depth);
        stateBlock.depthState = new DepthState(true, CompareFunction.LessEqual);

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

        // Perform all scheduled tasks, in the order that they were scheduled.
        scriptableRenderContext.Submit();
    }
}

Additional resources: ScriptableRenderContext.DrawRenderers, RenderStateMask.

Properties

Constructors