Share via


VignettingFilter Class

Applies vignetting effect to the image.
Dn859711.VignettingFilter(en-us,WIN.10).jpg

Namespace: Lumia.Imaging.Artistic
Assembly: Lumia.Imaging (in Lumia.Imaging.dll) Version: 255.255.255.255

Syntax

public sealed class VignettingFilter : IFilter, 
    __IVignettingFilterPublicNonVirtuals
'Declaration
Public NotInheritable Class VignettingFilter
    Implements IFilter, __IVignettingFilterPublicNonVirtuals
public ref class VignettingFilter sealed : IFilter, 
    __IVignettingFilterPublicNonVirtuals
Lumia.Imaging.Artistic.VignettingFilter = function();

Type.createClass(
    'Lumia.Imaging.Artistic.VignettingFilter',
    null,
    Lumia.Imaging.IFilter,
    Lumia.Imaging.Artistic.__IVignettingFilterPublicNonVirtuals);

Examples

using (var filterEffect = new FilterEffect(source))
{
    // Initialize the filter and add the filter to the FilterEffect collection
    var filter = new VignettingFilter(0.5, new Windows.UI.Color { R = 104, G = 103, B = 71 });

    filterEffect.Filters = new IFilter[] { filter };

    // Create a target where the filtered image will be rendered to
    var target = new WriteableBitmap(width, height);

    // Create a new renderer which outputs WriteableBitmaps
    using (var renderer = new WriteableBitmapRenderer(filterEffect, target))
    {
        // Render the image with the filter(s)
        await renderer.RenderAsync();

        // Set the output image to Image control as a source
        ImageControl.Source = target;
    }

    await SaveEffectAsync(filterEffect, "VignettingFilter.jpg", outputImageSize);
}

Inheritance Hierarchy

System.Object
  Lumia.Imaging.Artistic.VignettingFilter

Version Information

Lumia Imaging SDK

Supported in: 2.0

See Also

VignettingFilter.VignettingFilter Members

Lumia.Imaging.Artistic Namespace