docs.unity3d.com
    Show / Hide Table of Contents

    Class FilmGrain

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

    Inheritance
    Object
    VolumeComponent
    FilmGrain
    Inherited Members
    VolumeComponent.active
    VolumeComponent.OnEnable()
    VolumeComponent.OnDisable()
    VolumeComponent.Override(VolumeComponent, Single)
    VolumeComponent.SetAllOverridesTo(Boolean)
    VolumeComponent.GetHashCode()
    VolumeComponent.AnyPropertiesIsOverridden()
    VolumeComponent.OnDestroy()
    VolumeComponent.Release()
    VolumeComponent.displayName
    VolumeComponent.parameters
    Namespace: UnityEngine.Rendering.HighDefinition
    Syntax
    [Serializable]
    [VolumeComponentMenuForRenderPipeline("Post-processing/Film Grain", new Type[]{typeof(HDRenderPipeline)})]
    public sealed class FilmGrain : VolumeComponent, 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
    FilmGrainLookup

    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
    IPostProcessComponent.IsActive()
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023