Class ImageBrush<TPixel>

Namespace

SixLabors.ImageSharp.Drawing.Processing

Assembly

SixLabors.ImageSharp.Drawing.dll

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

public sealed class ImageBrush<TPixel> : ImageBrush, IEquatable<Brush> where TPixel : unmanaged, IPixel<TPixel>

Type Parameters

TPixel

The pixel format of the source image.

Inheritance

object

Brush

ImageBrush

ImageBrush<TPixel>

Implements

IEquatable<Brush>

Inherited Members

ImageBrush.UntypedImage

ImageBrush.SourceRegion

ImageBrush.Offset

ImageBrush.WrapX

ImageBrush.WrapY

ImageBrush.Equals(Brush)

ImageBrush.GetHashCode()

ImageBrush.CreateRenderer<TPixel>(Configuration, GraphicsOptions, int, RectangleF)

Brush.Equals(object)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ImageBrush(Image<TPixel>)

Initializes a new instance of the ImageBrush<TPixel> class.

public ImageBrush(Image<TPixel> image)

Parameters

image Image<TPixel>

The source image to draw.

ImageBrush(Image<TPixel>, WrapMode, WrapMode)

Initializes a new instance of the ImageBrush<TPixel> class.

public ImageBrush(Image<TPixel> image, WrapMode wrapX, WrapMode wrapY)

Parameters

image Image<TPixel>

The source image to draw.

wrapX WrapMode

The wrap mode used when sampling horizontally beyond the source region.

wrapY WrapMode

The wrap mode used when sampling vertically beyond the source region.

ImageBrush(Image<TPixel>, Point)

Initializes a new instance of the ImageBrush<TPixel> class.

public ImageBrush(Image<TPixel> image, Point offset)

Parameters

image Image<TPixel>

The source image to draw.

offset Point

An offset to apply to the image while drawing the texture.

ImageBrush(Image<TPixel>, Point, WrapMode, WrapMode)

Initializes a new instance of the ImageBrush<TPixel> class.

public ImageBrush(Image<TPixel> image, Point offset, WrapMode wrapX, WrapMode wrapY)

Parameters

image Image<TPixel>

The source image to draw.

offset Point

An offset to apply to the image while drawing the texture.

wrapX WrapMode

The wrap mode used when sampling horizontally beyond the source region.

wrapY WrapMode

The wrap mode used when sampling vertically beyond the source region.

ImageBrush(Image<TPixel>, RectangleF)

Initializes a new instance of the ImageBrush<TPixel> class.

public ImageBrush(Image<TPixel> image, RectangleF region)

Parameters

image Image<TPixel>

The source image to draw.

region RectangleF

The region of interest within the source image.

ImageBrush(Image<TPixel>, RectangleF, WrapMode, WrapMode)

Initializes a new instance of the ImageBrush<TPixel> class.

public ImageBrush(Image<TPixel> image, RectangleF region, WrapMode wrapX, WrapMode wrapY)

Parameters

image Image<TPixel>

The source image to draw.

region RectangleF

The region of interest within the source image.

wrapX WrapMode

The wrap mode used when sampling horizontally beyond the source region.

wrapY WrapMode

The wrap mode used when sampling vertically beyond the source region.

ImageBrush(Image<TPixel>, RectangleF, Point)

Initializes a new instance of the ImageBrush<TPixel> class.

public ImageBrush(Image<TPixel> image, RectangleF region, Point offset)

Parameters

image Image<TPixel>

The source image to draw.

region RectangleF

The region of interest within the source image.

offset Point

An offset to apply to the image while drawing the texture.

ImageBrush(Image<TPixel>, RectangleF, Point, WrapMode, WrapMode)

Initializes a new instance of the ImageBrush<TPixel> class.

public ImageBrush(Image<TPixel> image, RectangleF region, Point offset, WrapMode wrapX, WrapMode wrapY)

Parameters

image Image<TPixel>

The source image to draw.

region RectangleF

The region of interest within the source image.

offset Point

An offset to apply to the image while drawing the texture.

wrapX WrapMode

The wrap mode used when sampling horizontally beyond the source region.

wrapY WrapMode

The wrap mode used when sampling vertically beyond the source region.

Properties

SourceImage

Gets the typed source image used by this brush.

public Image<TPixel> SourceImage { get; }

Property Value

Image<TPixel>

Methods

Transform(Matrix4x4, Rectangle, Rectangle)

Returns a new brush with its defining geometry transformed by the given matrix.

public override Brush Transform(Matrix4x4 matrix, Rectangle sourceInterest, Rectangle preparedInterest)

Parameters

matrix Matrix4x4

The transformation matrix to apply.

sourceInterest Rectangle

The command interest before preparation.

preparedInterest Rectangle

The command interest after preparation.

Returns

Brush

A transformed brush, or this if the brush has no spatial parameters.