Class LinearGradientBrush

Implementation of IBrush for linear color gradient (made of 2 color).

System.Object
LinearGradientBrush
System.IComparable
System.IEquatable<LinearGradientBrush>
Namespace: FlaxEngine.GUI
Assembly: FlaxEngine.CSharp.dll
Syntax
public sealed class LinearGradientBrush : Object, IBrush, IComparable, IEquatable<LinearGradientBrush>

Constructors

LinearGradientBrush()

Initializes a new instance of the LinearGradientBrush class.

Declaration
public LinearGradientBrush()

LinearGradientBrush(Color, Color)

Initializes a new instance of the LinearGradientBrush struct.

Declaration
public LinearGradientBrush(Color startColor, Color endColor)
Parameters
Color startColor

The start color.
Color endColor

The end color.

Fields

EndColor

The brush end color.

Declaration
[EditorOrder(1)]
[Tooltip("The brush end color.")]
public Color EndColor
Field Value
Color

StartColor

The brush start color.

Declaration
[EditorOrder(0)]
[ExpandGroups]
[Tooltip("The brush start color.")]
public Color StartColor
Field Value
Color

Properties

Size

Gets the size of the image brush in pixels (if relevant).

Declaration
public Float2 Size { get; }
Property Value
Float2

Implements

Methods

CompareTo(Object)

Declaration
public int CompareTo(object obj)
Parameters
System.Object obj

Returns
System.Int32

Draw(Rectangle, Color)

Draws the specified image using Render2D graphics backend.

Declaration
public void Draw(Rectangle rect, Color color)
Parameters
Rectangle rect

The draw area rectangle.
Color color

The color.
Implements

Equals(LinearGradientBrush)

Declaration
public bool Equals(LinearGradientBrush other)
Parameters
LinearGradientBrush other

Returns
System.Boolean

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

Returns
System.Boolean

GetHashCode()

Declaration
public override int GetHashCode()
Returns
System.Int32

Extension Methods

See Also