Stride

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

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

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

    Vignetting Class

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

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

    Initializes a new instance of the Vignetting class.

    Vignetting(String)

    Initializes a new instance of the Vignetting class.

    Properties
    Amount

    Amount of vignetting (alpha of the halo).

    Color

    Color of the vignetting halo.

    Radius

    Radius from the center, from which vignetting begins.

    Methods
    UpdateParameters(ColorTransformContext)
    | Improve this Doc View Source

    Constructors


    Vignetting()

    Initializes a new instance of the Vignetting class.

    public Vignetting()

    Vignetting(String)

    Initializes a new instance of the Vignetting class.

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

    Properties


    Amount

    Amount of vignetting (alpha of the halo).

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

    Color

    Color of the vignetting halo.

    [DataMember(30)]
    public Color3 Color { get; set; }
    Property Value
    Type Description
    Color3

    Radius

    Radius from the center, from which vignetting begins.

    [DataMember(20)]
    [DataMemberRange(0, 1, 0.0099999997764825821, 0.10000000149011612, 3)]
    public float Radius { 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