Class DrawImageProcessor

Combines two images together by blending the pixels.

Inheritance

object

DrawImageProcessor

Implements

IImageProcessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SixLabors.ImageSharp.Processing.Processors.Drawing

Assembly: SixLabors.ImageSharp.dll

Syntax

public class DrawImageProcessor : IImageProcessor

Constructors

DrawImageProcessor(Image, Point, PixelColorBlendingMode, PixelAlphaCompositionMode, float)

Initializes a new instance of the DrawImageProcessor class.

Declaration

public DrawImageProcessor(Image foreground, Point backgroundLocation, PixelColorBlendingMode colorBlendingMode, PixelAlphaCompositionMode alphaCompositionMode, float opacity)

Parameters

Type	Name	Description
Image	foreground	The image to blend.
Point	backgroundLocation	The location to draw the foreground image on the background.
PixelColorBlendingMode	colorBlendingMode	The blending mode to use when drawing the image.
PixelAlphaCompositionMode	alphaCompositionMode	The Alpha blending mode to use when drawing the image.
float	opacity	The opacity of the image to blend.

DrawImageProcessor(Image, Point, Rectangle, PixelColorBlendingMode, PixelAlphaCompositionMode, float)

Initializes a new instance of the DrawImageProcessor class.

Declaration

public DrawImageProcessor(Image foreground, Point backgroundLocation, Rectangle foregroundRectangle, PixelColorBlendingMode colorBlendingMode, PixelAlphaCompositionMode alphaCompositionMode, float opacity)

Parameters

Type	Name	Description
Image	foreground	The image to blend.
Point	backgroundLocation	The location to draw the foreground image on the background.
Rectangle	foregroundRectangle	The rectangular portion of the foreground image to draw.
PixelColorBlendingMode	colorBlendingMode	The blending mode to use when drawing the image.
PixelAlphaCompositionMode	alphaCompositionMode	The Alpha blending mode to use when drawing the image.
float	opacity	The opacity of the image to blend.

Properties

AlphaCompositionMode

Gets the Alpha blending mode to use when drawing the image.

Declaration

public PixelAlphaCompositionMode AlphaCompositionMode { get; }

Property Value

Type	Description
PixelAlphaCompositionMode

BackgroundLocation

Gets the location to draw the foreground image on the background.

Declaration

public Point BackgroundLocation { get; }

Property Value

Type	Description
Point

ColorBlendingMode

Gets the blending mode to use when drawing the image.

Declaration

public PixelColorBlendingMode ColorBlendingMode { get; }

Property Value

Type	Description
PixelColorBlendingMode

ForeGround

Gets the image to blend.

Declaration

public Image ForeGround { get; }

Property Value

Type	Description
Image

ForegroundRectangle

Gets the rectangular portion of the foreground image to draw.

Declaration

public Rectangle ForegroundRectangle { get; }

Property Value

Type	Description
Rectangle

Opacity

Gets the opacity of the image to blend.

Declaration

public float Opacity { get; }

Property Value

Type	Description
float

Methods

CreatePixelSpecificProcessor<TPixelBg>(Configuration, Image<TPixelBg>, Rectangle)

Creates a pixel specific IImageProcessor<TPixel> that is capable of executing the processing algorithm on an Image<TPixel>.

Declaration

public IImageProcessor<TPixelBg> CreatePixelSpecificProcessor<TPixelBg>(Configuration configuration, Image<TPixelBg> source, Rectangle sourceRectangle) where TPixelBg : unmanaged, IPixel<TPixelBg>

Parameters

Type	Name	Description
Configuration	configuration	The configuration which allows altering default behaviour or extending the library.
Image<TPixelBg>	source	The source image. Cannot be null.
Rectangle	sourceRectangle	The Rectangle structure that specifies the portion of the image object to draw.

Returns

Type	Description
IImageProcessor<TPixelBg>	The IImageProcessor<TPixel>

Type Parameters

Name	Description
TPixelBg

Implements

IImageProcessor