Skip to main content

ImageBrush Class

Definition

Namespace:Avalonia.Media
Assembly:Avalonia.Base
Package:Avalonia

Paints an area with an Avalonia.Media.Imaging.IBitmap.

public class ImageBrush

Inheritance: object -> AvaloniaObject -> Animatable -> Brush -> TileBrush -> ImageBrush

Implements: IBrush, IImageBrush, IMutableBrush, ITileBrush

Constructors

NameDescription
ImageBrush (2 overloads)Initializes a new instance of the Avalonia.Media.ImageBrush class.

ImageBrush overloads

ImageBrush Constructor

Initializes a new instance of the Avalonia.Media.ImageBrush class.

public ImageBrush()

ImageBrush Constructor

Initializes a new instance of the Avalonia.Media.ImageBrush class.

public ImageBrush(Avalonia.Media.IImageBrushSource source)
Parameters

source Avalonia.Media.IImageBrushSource

The image to draw.

Methods

NameDescription
ToImmutableNo summary available.
ParseParses a brush string. Inherited from Brush.
Bind (8 overloads)Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject.
CheckAccessReturns a value indicating whether the current thread is the UI thread. Inherited from AvaloniaObject.
ClearValue (4 overloads)Clears a Avalonia.AvaloniaProperty's local value. Inherited from AvaloniaObject.
CoerceValueCoerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject.
EqualsCompares two objects using reference equality. Inherited from AvaloniaObject.
GetBaseValueInherited from AvaloniaObject.
GetHashCodeGets the hash code for the object. Inherited from AvaloniaObject.
GetValue (3 overloads)Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
IsAnimatingChecks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject.
IsSetChecks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject.
SetCurrentValue (2 overloads)Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject.
SetValue (3 overloads)Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
VerifyAccessChecks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject.

ToImmutable Method

public Avalonia.Media.IImmutableBrush ToImmutable()

Returns

Avalonia.Media.IImmutableBrush

Properties

NameDescription
SourceGets or sets the image to draw.
AlignmentXGets or sets the horizontal alignment of a tile in the destination. Inherited from TileBrush.
AlignmentYGets or sets the horizontal alignment of a tile in the destination. Inherited from TileBrush.
DestinationRectGets or sets the rectangle on the destination in which to paint a tile. Inherited from TileBrush.
SourceRectGets or sets the rectangle of the source image that will be displayed. Inherited from TileBrush.
StretchGets or sets a value controlling how the source rectangle will be stretched to fill the destination rect. Inherited from TileBrush.
TileModeGets or sets the brush's tile mode. Inherited from TileBrush.
OpacityGets or sets the opacity of the brush. Inherited from Brush.
TransformGets or sets the transform of the brush. Inherited from Brush.
TransformOriginGets or sets the origin of the brush Avalonia.Media.Brush.Transform Inherited from Brush.
TransitionsGets or sets the property transitions for the control. Inherited from Animatable.
DispatcherReturns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject.
ItemInherited from AvaloniaObject.

Source Property

Gets or sets the image to draw.

public Avalonia.Media.IImageBrushSource Source { get; set; }

Fields

NameDescription
SourcePropertyDefines the Avalonia.Visual property.
AlignmentXPropertyDefines the Avalonia.Media.TileBrush.AlignmentX property. Inherited from TileBrush.
AlignmentYPropertyDefines the Avalonia.Media.TileBrush.AlignmentY property. Inherited from TileBrush.
DestinationRectPropertyDefines the Avalonia.Media.TileBrush.DestinationRect property. Inherited from TileBrush.
SourceRectPropertyDefines the Avalonia.Media.TileBrush.SourceRect property. Inherited from TileBrush.
StretchPropertyDefines the Avalonia.Media.TileBrush.Stretch property. Inherited from TileBrush.
TileModePropertyDefines the Avalonia.Media.TileBrush.TileMode property. Inherited from TileBrush.
OpacityPropertyDefines the Avalonia.Media.Brush.Opacity property. Inherited from Brush.
TransformOriginPropertyDefines the Avalonia.Media.Brush.TransformOrigin property Inherited from Brush.
TransformPropertyDefines the Avalonia.Media.Brush.Transform property. Inherited from Brush.
TransitionsPropertyDefines the Avalonia.Animation.Animatable.Transitions property. Inherited from Animatable.

SourceProperty Field

Defines the Avalonia.Visual property.

public Avalonia.StyledProperty<TValue><Avalonia.Media.IImageBrushSource> SourceProperty

Events

NameDescription
PropertyChangedRaised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject.