Class Sprite9SlicingBrush

Implementation of IBrush for Sprite using 9-slicing.

System.Object
Sprite9SlicingBrush
System.IComparable
Namespace: FlaxEngine.GUI
Assembly: FlaxEngine.CSharp.dll
Syntax
public sealed class Sprite9SlicingBrush : Object, IBrush, IComparable

Constructors

Sprite9SlicingBrush()

Initializes a new instance of the Sprite9SlicingBrush class.

Declaration
public Sprite9SlicingBrush()

Fields

Border

The sprite borders (in texture space, range 0-1).

Declaration
[ExpandGroups]
[EditorOrder(3)]
[Limit(0F, 1F, 1F)]
[Tooltip("The sprite borders (in texture space, range 0-1).")]
public Margin Border
Field Value
Margin

BorderSize

The border size.

Declaration
[ExpandGroups]
[EditorOrder(2)]
[Limit(0F, 3.40282347E+38F, 1F)]
[Tooltip("The border size.")]
public float BorderSize
Field Value
System.Single

Filter

The texture sampling filter mode.

Declaration
[ExpandGroups]
[EditorOrder(1)]
[Tooltip("The texture sampling filter mode.")]
public BrushFilter Filter
Field Value
BrushFilter

ShowBorders

Displays borders (editor only).

Declaration
[NoSerialize]
[EditorOrder(4)]
[Tooltip("Displays borders (editor only).")]
public bool ShowBorders
Field Value
System.Boolean

Sprite

The sprite.

Declaration
[ExpandGroups]
[EditorOrder(0)]
[Tooltip("The sprite.")]
public SpriteHandle Sprite
Field Value
SpriteHandle

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(Sprite9SlicingBrush)

Declaration
public bool Equals(Sprite9SlicingBrush other)
Parameters
Sprite9SlicingBrush 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