Click or drag to resize
BlendEffect Class
Creates a blend effect that combines two images.
Inheritance Hierarchy
SystemObject
  Microsoft.Graphics.Canvas.EffectsBlendEffect

Namespace:  Microsoft.Graphics.Canvas.Effects
Assembly:  Microsoft.Graphics.Canvas (in Microsoft.Graphics.Canvas.dll) Version: 0.0.0.0
Syntax
C#
Copy
public sealed class BlendEffect : ICanvasEffect, 
	IGraphicsEffect, IGraphicsEffectSource, ICanvasImage, IDisposable

The BlendEffect type exposes the following members.

Constructors
  NameDescription
Public methodBlendEffect
Initializes a new instance of the BlendEffect class.
Top
Properties
  NameDescription
Public propertyBackground
Background image input for blend effect.
Public propertyBufferPrecision
Specifies what precision to use for intermediate buffers when drawing this effect.
Public propertyCacheOutput
Enables caching the output from drawing this effect.
Public propertyForeground
Foreground image input for blend effect.
Public propertyMode
Gets and sets blend mode for effect processing.
Public propertyName
Attaches a user-defined name string to the effect.
Top
Methods
  NameDescription
Public methodDispose
Releases all resources used by the effect.
Public methodGetBounds(ICanvasResourceCreator)
Retrieves the bounds of this BlendEffect.
Public methodGetBounds(ICanvasResourceCreator, Matrix3x2)
Retrieves the bounds of this BlendEffect.
Public methodGetInvalidRectangles
Queries what regions of the effect output have changed since it was last drawn.
Public methodCode exampleGetRequiredSourceRectangle
Queries what part of an effect source image is needed to draw an output region.
Public methodGetRequiredSourceRectangles
Queries what parts of the effect source images are needed to draw an output region.
Public methodInvalidateSourceRectangle
Notifies the effect that one of its source images has changed.
Top
Remarks

The output bitmap for this effect is always the size of the union of the two input images.

When using this effect with InvalidateSourceRectangle, GetRequiredSourceRectangle, or GetRequiredSourceRectangles, its Background property corresponds to source index #0, and Foreground to source index #1.

Examples

Suppose, we have a cat and flower images loaded as CanvasBitmap,

Copy
BlendEffect blendEffect = new BlendEffect()
{
    Background = flower,
    Foreground = cat,
    Mode = BlendEffectMode.SoftLight
};

Use the Draw event to display it:

Copy
void myWidget_Draw(CanvasControl sender, CanvasDrawEventArgs args)
{
    args.DrawingSession.DrawImage(blendEffect, 42, 42);
}

This Windows Runtime type corresponds to the D2D Blend effect.

See Also