Version: 2023.2
LanguageEnglish
  • C#

Light.AddCommandBuffer

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

Switch to Manual

Declaration

public void AddCommandBuffer(Rendering.LightEvent evt, Rendering.CommandBuffer buffer);

Declaration

public void AddCommandBuffer(Rendering.LightEvent evt, Rendering.CommandBuffer buffer, Rendering.ShadowMapPass shadowPassMask);

Parameters

evt When to execute the command buffer during rendering.
buffer The buffer to execute.
shadowPassMask A mask specifying which shadow passes to execute the buffer for.

Description

Add a command buffer to be executed at a specified place.

Multiple command buffers can be set to execute at the same light event (or even the same buffer can be added multiple times). To remove command buffer from execution, use RemoveCommandBuffer.

Passing a shadow pass mask allows detailed control over which shadow passes will execute the buffer.

Additional resources: CommandBuffer, ShadowMapPass, RemoveCommandBuffer, GetCommandBuffers.