Stride

OPEN / CLOSE
  • Features
  • Blog
  • Documentation
  • Community
(icon) Download

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

OPEN / CLOSE
  • English
  • 日本語
    Show / Hide Table of Contents

    FilmGrain Class

    Namespace: Stride.Rendering.Images
    Assembly: Stride.Rendering.dll
    System.Object → ColorTransformBase → ColorTransform → FilmGrain
    Derived from FilmGrain:

    [DataContract("FilmGrain")]
    public sealed class FilmGrain : ColorTransform
    Name Description
    Constructors
    FilmGrain()

    Initializes a new instance of the FilmGrain class.

    FilmGrain(String)

    Initializes a new instance of the FilmGrain class.

    Properties
    Amount

    Amount of grain.

    Animate

    Animates the film grain.

    GrainSize

    Grain size.

    LuminanceFactor

    How the luminance influences the amount of grain.

    Methods
    UpdateParameters(ColorTransformContext)
    | Improve this Doc View Source

    Constructors


    FilmGrain()

    Initializes a new instance of the FilmGrain class.

    public FilmGrain()

    FilmGrain(String)

    Initializes a new instance of the FilmGrain class.

    public FilmGrain(string effect)
    Parameters
    Type Name Description
    System.String effect
    | Improve this Doc View Source

    Properties


    Amount

    Amount of grain.

    [DataMember(10)]
    [DataMemberRange(0, 1, 0.0099999997764825821, 0.10000000149011612, 3)]
    public float Amount { get; set; }
    Property Value
    Type Description
    System.Single

    Animate

    Animates the film grain.

    [DataMember(30)]
    public bool Animate { get; set; }
    Property Value
    Type Description
    System.Boolean

    GrainSize

    Grain size.

    [DataMember(20)]
    [DataMemberRange(0, 10, 0.10000000149011612, 1, 3)]
    public float GrainSize { get; set; }
    Property Value
    Type Description
    System.Single

    LuminanceFactor

    How the luminance influences the amount of grain.

    [DataMember(40)]
    [DataMemberRange(0, 1, 0.0099999997764825821, 0.10000000149011612, 3)]
    public float LuminanceFactor { get; set; }
    Property Value
    Type Description
    System.Single
    | Improve this Doc View Source

    Methods


    UpdateParameters(ColorTransformContext)

    public override void UpdateParameters(ColorTransformContext context)
    Parameters
    Type Name Description
    ColorTransformContext context
    Overrides
    ColorTransformBase.UpdateParameters(ColorTransformContext)

    Inherited Members

    ColorTransformBase.Group
    ColorTransformBase.Shader
    ColorTransformBase.GenericArguments
    ColorTransformBase.Parameters
    ColorTransformBase.Enabled
    ColorTransformBase.PrepareParameters(ColorTransformContext, ParameterCollection, String)

    Extension Methods

    ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)
    ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)
    • Improve this Doc
    • View Source
    In This Article

    Back to top

    Copyright © 2019-2021 .NET Foundation and Contributors
    Supported by the .NET Foundation