Class SpriteBrush

Implementation of IBrush for Sprite.

Inheritance

System.Object

SpriteBrush

Implements

IBrush

System.IComparable

System.IEquatable<SpriteBrush>

Namespace: FlaxEngine.GUI

Assembly: FlaxEngine.CSharp.dll

Syntax

public sealed class SpriteBrush : Object, IBrush, IComparable, IEquatable<SpriteBrush>

Constructors

SpriteBrush()

Initializes a new instance of the SpriteBrush class.

Declaration

public SpriteBrush()

SpriteBrush(SpriteHandle)

Initializes a new instance of the SpriteBrush struct.

Declaration

public SpriteBrush(SpriteHandle sprite)

Parameters

SpriteHandle sprite The sprite.

Fields

Filter

The texture sampling filter mode.

Declaration

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

Field Value

BrushFilter

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

IBrush.Size

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

IBrush.Draw(Rectangle, Color)

Equals(SpriteBrush)

Declaration

public bool Equals(SpriteBrush other)

Parameters

SpriteBrush 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

Extensions.ReflectiveCompare<T>(T, T)

Extensions.DeepClone<T>(T)

Extensions.RawClone<T>(T)

See Also

IBrush