Class FilmGrain

A volume component that holds settings for the Film Grain effect.

Inheritance
Object
VolumeComponent
FilmGrain
Inherited Members
UnityEngine.Rendering.VolumeComponent.TryGetRevertMethodForFieldName(UnityEditor.SerializedProperty, System.Action<UnityEditor.SerializedProperty>)
UnityEngine.Rendering.VolumeComponent.GetSourceTerm()
UnityEngine.Rendering.VolumeComponent.TryGetApplyMethodForFieldName(UnityEditor.SerializedProperty, System.Action<UnityEditor.SerializedProperty>)
UnityEngine.Rendering.VolumeComponent.GetSourceName(UnityEngine.Component)
Namespace: UnityEngine.Rendering.HighDefinition
Syntax
[Serializable]
[VolumeComponentMenu("Post-processing/Film Grain")]
[SupportedOnRenderPipeline(typeof(HDRenderPipelineAsset))]
public sealed class FilmGrain : VolumeComponent, IApplyRevertPropertyContextMenuItemProvider, IPostProcessComponent

Fields

intensity

Controls the strength of the film grain effect.

Declaration
[Tooltip("Use the slider to set the strength of the Film Grain effect.")]
public ClampedFloatParameter intensity
Field Value
Type Description
ClampedFloatParameter

response

Controls the noisiness response curve. The higher you set this value, the less noise there is in brighter areas.

Declaration
[Tooltip("Controls the noisiness response curve. The higher you set this value, the less noise there is in brighter areas.")]
public ClampedFloatParameter response
Field Value
Type Description
ClampedFloatParameter

texture

Specifies a tileable Texture to use for the grain. The neutral value for this Texture is 0.5 which means that HDRP does not apply grain at this value.

Declaration
[Tooltip("Specifies a tileable Texture to use for the grain. The neutral value for this Texture is 0.5 which means that HDRP does not apply grain at this value.")]
public Texture2DParameter texture
Field Value
Type Description
Texture2DParameter

type

Specifies the type of grain to use. Use Custom to provide your own texture.

Declaration
[Tooltip("Specifies the type of grain to use. Select a preset or select \"Custom\" to provide your own Texture.")]
public FilmGrainLookupParameter type
Field Value
Type Description
FilmGrainLookupParameter
See Also

Methods

IsActive()

Tells if the effect needs to be rendered or not.

Declaration
public bool IsActive()
Returns
Type Description
Boolean

true if the effect should be rendered, false otherwise.
Implements