Skip to main content

Class OutlineFilter

A outline filter for uGUI components

Assembly: ChocDino.UIFX.dll​
Declaration
[AddComponentMenu("UI/Chocolate Dinosaur UIFX/Filters/UIFX - Outline Filter")]
public class OutlineFilter : FilterBase, IMaterialModifier, IMeshModifier

Inheritance: System.Object -> UnityEngine.Object -> UnityEngine.Component -> UnityEngine.Behaviour -> UnityEngine.MonoBehaviour -> UnityEngine.EventSystems.UIBehaviour -> ChocDino.UIFX.FilterBase

Implements:
UnityEngine.UI.IMaterialModifier, UnityEngine.UI.IMeshModifier

Properties​

Method​

The direction in which the outline grows from the edge.

Declaration
public OutlineMethod Method { get; set; }

Size​

The radius of the outline in pixels.

Declaration
public float Size { get; set; }

DistanceShape​

The shape that the outline grows in.

Declaration
public DistanceShape DistanceShape { get; set; }

Blur​

The radius of the blur filter in pixels.

Declaration
public float Blur { get; set; }

SourceAlpha​

The transparency of the source content. Set to zero to make only the outline show. Range is [0..1] Default is 1.0

Declaration
public float SourceAlpha { get; set; }

Color​

The color of the outline.

Declaration
public Color Color { get; set; }

Direction​

The direction in which the outline grows from the edge.

Declaration
public OutlineDirection Direction { get; set; }

Implements​

  • UnityEngine.UI.IMaterialModifier
  • UnityEngine.UI.IMeshModifier