Class ImageBrush

Provides an implementation of an image brush for painting images within areas.

Inheritance

Object

ImageBrush

Implements

IBrush

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: SixLabors.ImageSharp.Drawing.Processing

Assembly: SixLabors.ImageSharp.Drawing.dll

Syntax

public class ImageBrush : IBrush

Constructors

ImageBrush(Image)

Initializes a new instance of the ImageBrush class.

Declaration

public ImageBrush(Image image)

Parameters

Type	Name	Description
Image	image	The image.

Methods

CreateApplicator<TPixel>(Configuration, GraphicsOptions, ImageFrame<TPixel>, RectangleF)

Creates the applicator for this brush.

Declaration

public BrushApplicator<TPixel> CreateApplicator<TPixel>(Configuration configuration, GraphicsOptions options, ImageFrame<TPixel> source, RectangleF region)
    where TPixel : struct, IPixel<TPixel>

Parameters

Type	Name	Description
Configuration	configuration	The configuration instance to use when performing operations.
GraphicsOptions	options	The graphic options.
ImageFrame<TPixel>	source	The source image.
RectangleF	region	The region the brush will be applied to.

Returns

Type	Description
BrushApplicator<TPixel>	The BrushApplicator<TPixel> for this brush.

Type Parameters

Name	Description
TPixel	The pixel type.

Remarks

The region when being applied to things like shapes would usually be the bounding box of the shape not necessarily the bounds of the whole image.

Implements

IBrush