CompositeEffect Class

Combines two or more images.

Inheritance Hierarchy

SystemObject
Microsoft.Graphics.Canvas.EffectsCompositeEffect

Namespace: Microsoft.Graphics.Canvas.Effects
Assembly: Microsoft.Graphics.Canvas (in Microsoft.Graphics.Canvas.dll) Version: 0.0.0.0

Syntax

Copy

public sealed class CompositeEffect : ICanvasEffect, 
	IGraphicsEffect, IGraphicsEffectSource, ICanvasImage, IDisposable

The CompositeEffect type exposes the following members.

Constructors

	Name	Description
	CompositeEffect	Initializes a new instance of the CompositeEffect class.

Top

Properties

	Name	Description
	BufferPrecision	Specifies what precision to use for intermediate buffers when drawing this effect.
	CacheOutput	Enables caching the output from drawing this effect.
	Mode	Gets and sets composite mode for effect processing.
	Name	Attaches a user-defined name string to the effect.
	Sources	Gets a collection of the input sources attached to the effect.

Top

Methods

	Name	Description
	Dispose	Releases all resources used by the effect.
	GetBounds(ICanvasResourceCreator)	Retrieves the bounds of this CompositeEffect.
	GetBounds(ICanvasResourceCreator, Matrix3x2)	Retrieves the bounds of this CompositeEffect.
	GetInvalidRectangles	Queries what regions of the effect output have changed since it was last drawn.
	GetRequiredSourceRectangle	Queries what part of an effect source image is needed to draw an output region.
	GetRequiredSourceRectangles	Queries what parts of the effect source images are needed to draw an output region.
	InvalidateSourceRectangle	Notifies the effect that one of its source images has changed.

Top

Remarks

Examples

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

Copy

CompositeEffect compositeEffect = new CompositeEffect();
compositeEffect.Mode = CompositeEffectMode.Add;
compositeEffect.Sources.Add(cat);
compositeEffect.Sources.Add(flower);

Use the Draw event to display it:

Copy

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

This Windows Runtime type corresponds to the D2D Composite effect.

Reference

Microsoft.Graphics.Canvas.Effects Namespace