CustomEffectAdapter Class

Article
09/16/2015

An adapter that allows the creation of a user implemented custom effect.

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

Syntax

public sealed class CustomEffectAdapter : IClosable, 
    IImageConsumer, IImageProvider, __ICustomEffectAdapterPublicNonVirtuals

'Declaration
Public NotInheritable Class CustomEffectAdapter
    Implements IClosable, IImageConsumer, IImageProvider, __ICustomEffectAdapterPublicNonVirtuals

public ref class CustomEffectAdapter sealed : IClosable, 
    IImageConsumer, IImageProvider, __ICustomEffectAdapterPublicNonVirtuals

Lumia.Imaging.Custom.CustomEffectAdapter = function();

Type.createClass(
    'Lumia.Imaging.Custom.CustomEffectAdapter',
    null,
    Windows.Foundation.IClosable,
    Lumia.Imaging.IImageConsumer,
    Lumia.Imaging.IImageProvider,
    Lumia.Imaging.Custom.__ICustomEffectAdapterPublicNonVirtuals);

Remarks

The intended usage pattern is that the user implements an "outer class" representing the effect. This outer class should:

Privately own a CustomEffectAdapter.
Implement IImageConsumer and propagate all method/property calls to the CustomEffectAdapter.
Implement IImageProvider and propagate all method/property calls to the CustomEffectAdapter.
Implement and handle ICustomEffect.

Note that in C#/.NET, the CustomEffectBase base class is recommended instead, as it implements this pattern. That leaves only a couple of overloads for the user class to provide.

Members of this class are not guaranteed to be thread safe.

Inheritance Hierarchy

System.Object
Lumia.Imaging.Custom.CustomEffectAdapter

Version Information

Lumia Imaging SDK

Supported in: 2.0