Class CustomPostProcessVolumeComponent

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

Inheritance

object

Object

ScriptableObject

VolumeComponent

CustomPostProcessVolumeComponent

Implements

IApplyRevertPropertyContextMenuItemProvider

Inherited Members

VolumeComponent.active

VolumeComponent.displayName

VolumeComponent.parameters

VolumeComponent.OnEnable()

VolumeComponent.Override(VolumeComponent, float)

VolumeComponent.SetAllOverridesTo(bool)

VolumeComponent.GetHashCode()

VolumeComponent.AnyPropertiesIsOverridden()

VolumeComponent.OnDestroy()

VolumeComponent.Release()

VolumeComponent.TryGetRevertMethodForFieldName(SerializedProperty, out Action<SerializedProperty>)

VolumeComponent.GetSourceTerm()

VolumeComponent.TryGetApplyMethodForFieldName(SerializedProperty, out Action<SerializedProperty>)

VolumeComponent.GetSourceName(Component)

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.Rendering.HighDefinition

Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll

Syntax

public abstract class CustomPostProcessVolumeComponent : VolumeComponent, IApplyRevertPropertyContextMenuItemProvider

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
bool

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
RTHandle	source	Source Render Target, it contains the camera color buffer in it's current state
RTHandle	destination	Destination Render Target

Setup()

Setup function, called once before render is called.

Declaration

public virtual void Setup()

Implements

IApplyRevertPropertyContextMenuItemProvider