Class CustomPostProcessVolumeComponent

Volume component class to inherit when you implement a custom post process

Inheritance

Object

UnityEngine.Rendering.VolumeComponent

CustomPostProcessVolumeComponent

Inherited Members

UnityEngine.Rendering.VolumeComponent.active

UnityEngine.Rendering.VolumeComponent.OnEnable()

UnityEngine.Rendering.VolumeComponent.Override(UnityEngine.Rendering.VolumeComponent, System.Single)

UnityEngine.Rendering.VolumeComponent.SetAllOverridesTo(System.Boolean)

UnityEngine.Rendering.VolumeComponent.GetHashCode()

UnityEngine.Rendering.VolumeComponent.OnDestroy()

UnityEngine.Rendering.VolumeComponent.Release()

UnityEngine.Rendering.VolumeComponent.displayName

UnityEngine.Rendering.VolumeComponent.parameters

Namespace: UnityEngine.Rendering.HighDefinition

Syntax

public abstract class CustomPostProcessVolumeComponent : VolumeComponent

Properties

injectionPoint

Injection point of the custom post process in HDRP.

Declaration

public virtual CustomPostProcessInjectionPoint injectionPoint { get; }

Property Value

Type	Description
CustomPostProcessInjectionPoint

visibleInSceneView

True if you want your custom post process to be visible in the scene view.false False otherwise.

Declaration

public virtual bool visibleInSceneView { get; }

Property Value

Type	Description
Boolean

Methods

Cleanup()

Cleanup function, called when the render pipeline is disposed.

Declaration

public virtual void Cleanup()

OnDisable()

Unity calls this method when the object goes out of scope.

Declaration

protected override void OnDisable()

Overrides

UnityEngine.Rendering.VolumeComponent.OnDisable()

Render(CommandBuffer, HDCamera, RTHandle, RTHandle)

Called every frame for each camera when the post process needs to be rendered.

Declaration

public abstract void Render(CommandBuffer cmd, HDCamera camera, RTHandle source, RTHandle destination)

Parameters

Type	Name	Description
CommandBuffer	cmd	Command Buffer used to issue your commands
HDCamera	camera	Current Camera
UnityEngine.Rendering.RTHandle	source	Source Render Target, it contains the camera color buffer in it's current state
UnityEngine.Rendering.RTHandle	destination	Destination Render Target

Setup()

Setup function, called once before render is called.

Declaration

public virtual void Setup()