Click or drag to resize
ColorSourceEffect Class
Generates an image containing a solid color, which can be used as input to other effects (for instance to specify a background color).
Inheritance Hierarchy
SystemObject
  Microsoft.Graphics.Canvas.EffectsColorSourceEffect

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 ColorSourceEffect : ICanvasEffect, 
	IGraphicsEffect, IGraphicsEffectSource, ICanvasImage, IDisposable

The ColorSourceEffect type exposes the following members.

Constructors
  NameDescription
Public methodColorSourceEffect
Initializes a new instance of the ColorSourceEffect class.
Top
Properties
  NameDescription
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 propertyColor
Specifies the color to be generated.
Public propertyColorHdr
Specifies the high-dynamic-range color to be generated.
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 ColorSourceEffect.
Public methodGetBounds(ICanvasResourceCreator, Matrix3x2)
Retrieves the bounds of this ColorSourceEffect.
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

This effect generates an infinite expanse of solid color. If you want only a smaller region of solid color, feed its output through the CropEffect.

Note: this effect passes along the specified color value as specified. You must manually pre-multiply the values if you plan to pass the output to effects that expect a pre-multiplied alpha input.

This Windows Runtime type corresponds to the D2D Flood effect.

See Also