Class ShaderDebugPrintManager

Internal development tool. Manages gpu-buffers for shader debug printing.

Inheritance
object
ShaderDebugPrintManager
Inherited Members
Namespace: UnityEngine.Rendering
Assembly: Unity.RenderPipelines.Core.Runtime.dll
Syntax
public sealed class ShaderDebugPrintManager

Properties

instance

Get the current instance.

Declaration
public static ShaderDebugPrintManager instance { get; }
Property Value
Type Description
ShaderDebugPrintManager

outputAction

Action taken for each print line. By default prints to the debug log.

Declaration
public Action<string> outputAction { set; }
Property Value
Type Description
Action<string>

outputLine

Get current print line.

Declaration
public string outputLine { get; }
Property Value
Type Description
string

Methods

DefaultOutput(string)

The default output action. Print to the debug log.

Declaration
public void DefaultOutput(string line)
Parameters
Type Name Description
string line

Line to be printed.

EndFrame()

Initiate async read-back of the GPU buffer to the CPU. Prepare a new GPU buffer for the next frame.

Declaration
public void EndFrame()

PrintImmediate()

Initiate synchronous read-back of the GPU buffer to the CPU and executes output action. By default prints to the debug log.

Declaration
public void PrintImmediate()

SetShaderDebugPrintBindings(CommandBuffer)

Binds the gpu-buffers for current frame.

Declaration
public void SetShaderDebugPrintBindings(CommandBuffer cmd)
Parameters
Type Name Description
CommandBuffer cmd

CommandBuffer to store the commands.

SetShaderDebugPrintInputConstants(CommandBuffer, ShaderDebugPrintInput)

Set shader input constants.

Declaration
public void SetShaderDebugPrintInputConstants(CommandBuffer cmd, ShaderDebugPrintInput input)
Parameters
Type Name Description
CommandBuffer cmd

CommandBuffer to store the commands.
ShaderDebugPrintInput input

Input parameters for the constants.

Extension Methods