BlendEffect Members

  • Article

Include Protected Members
Include Inherited Members

The BlendEffect type exposes the following members.

Constructors

  Name Description
Public method BlendEffect()
Creates and initializes a new BlendEffect. Note that a Source and ForegroundSource must also be set.
Public method BlendEffect(IImageProvider)
Creates and initializes a new BlendEffect with specified background image sources.
Public method BlendEffect(IImageProvider, IImageProvider)
Creates and initializes a new BlendEffect with specified background and foreground image sources.
Public method BlendEffect(IImageProvider, IImageProvider, BlendFunction)
Creates and initializes a new BlendEffect with specified background and foreground image sources and a blend function.
Public method BlendEffect(IImageProvider, IImageProvider, BlendFunction, Double)
Creates and initializes a new BlendEffect with specified background and foreground image sources, a blend function and a global alpha value.
Public method BlendEffect(IImageProvider, IImageProvider, IImageProvider, BlendFunction, Double)
Creates and initializes a new BlendEffect with specified background, foreground and mask image sources, a blend function and a global alpha value.

Methods

  Name Description
Public method Clone
Clone the image provider.
Public method Close
Public method CreateImageWorker
Create a worker that can perform image processing.
Public method GetBitmapAsync(Void, Bitmap)
Public method GetBitmapAsync(Bitmap, OutputOption)
Creates a Bitmap from the contents of the image provider.
Public method GetInfoAsync
This method is no longer supported and should not be called. See remarks.
Public method GetSources
Public method Lock
This method is no longer supported and should not be called. See remarks.
Public method MapInputSizeToOutputSize
Maps the size of one of the effect's inputs to an output size.
Public method MapOutputSizeToInputSize
Maps the effect's output size to the desired size of one its the inputs.
Public method PreloadAsync
This method is no longer supported and should not be called. See remarks.
Public method SetSource
Set a source by index.

Extension Methods

  Name Description
Public Extension Method AsAnimationFrame
Returns an AnimationFrame with the specified IImageProvider as its source and the specified frame duration.
(Defined by ImageProviderExtensions.)
Public Extension Method GetBitmapAsync
Creates a WriteableBitmap with the contents of the image provider.
(Defined by ImageProviderExtensions.)
Public Extension Method Then<TImageConsumer>
Enables a fluid way of chaining multiple IImageProvider objects and IImageConsumer objects.
(Defined by ImageProviderExtensions.)

Properties

  Name Description
Public property BlendFunction
Blend function to use when blending the two images.
Public property ForegroundSource
The IImageProvider that will be used as the foreround image in the blend operation.
Public property GlobalAlpha
The factor of interpolation between the result of the blend operation and the original image.

Range [-2.5, 2.5], where 0.0 gives a result identical to the source image and 1.0 means the result of the blend operation is fully visible.

The result is calculated using the formula result = (1 - GlobalAlpha) * BackgroundSource + GlobalAlpha * ForegroundSource. By using values outside of the [0.0, 1.0] range one can use extrapolation to achieve additional effects on the image (such as saturation or sharpening).
Public property MaskSource
An optional "mask" IImageProvider that determines per-pixel how much of the result of the blend operation is visible in the final result. If set to null, the alpha channel of the ForegroundSource is used instead.
Public property PropertyDescriptions
Public property Source
The IImageProvider that will be used as the background image in the blend operation.
Public property SourceCount
The number of sources that can be set.
Public property SupportedRenderOptions
Supported rendering options.
Public property TargetArea
A target area within the background image into which the foreground is image blended. Expressed in the unit coordinate space of the background image, i.e., the top left corner of the background image is at (0, 0), and the bottom right corner is at (1, 1).

TargetOutputOption controls how the foreground is fitted into the target area. By default, the foreground image is stretched to fit the target area.

If value equals Windows::Foundation::Rect::Empty, or either Width or Height is smaller than or equal to zero, the foreground will be stretched over whole background and aspect ratio will not be preserved.
Public property TargetAreaRotation
The angle of counter clockwise rotation of TargetArea around its center, in degrees.

If the TargetArea has not been set, or doesn't have a positive width and height, this property will be ignored.
Public property TargetOutputOption
Controls how the foreground is fitted into the target area.

If set to Stretch, the foreground image will be resized to fit the target area exactly. If set to PreserveAspectRatio, the foreground image will be blended into the target area centered and with the original aspect ratio intact. If set to PreserveSize, the size portion of the target area will be ignored, and the foregound image will be blended in its original size.

See Also

BlendEffect Class

Lumia.Imaging.Compositing Namespace