CustomFilterBase Class

Base class for user-defined custom filters with support for block based processing.

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

Syntax

public abstract class CustomFilterBase : ICustomFilter2, 
    ICustomFilter, IFilter, IDisposable
'Declaration
Public MustInherit Class CustomFilterBase
    Implements ICustomFilter2, ICustomFilter, IFilter, IDisposable
public ref class CustomFilterBase abstract : ICustomFilter2, 
    ICustomFilter, IFilter, IDisposable
Lumia.Imaging.Custom.CustomFilterBase = function();

Type.createClass(
    'Lumia.Imaging.Custom.CustomFilterBase',
    null,
    Lumia.Imaging.Custom.ICustomFilter2,
    Lumia.Imaging.Custom.ICustomFilter,
    Lumia.Imaging.IFilter,
    IDisposable);

Remarks

To create a custom filter, CustomFilterBase should be subclassed and provide an implementation of OnProcess(PixelRegion, PixelRegion).

Since the custom filter may be invoked concurrently from multiple parallel rendering sessions, any state the filter needs to modify during rendering should be stored in a second user-defined class. The filter should override CreateSessionState() and return new instances of the state class. These can be accessed from within OnProcess(PixelRegion, PixelRegion) using the SessionState property. Additionally, the ImageSize and AcceptedColorMode properties contain session-specific values accessible from within OnProcess(PixelRegion, PixelRegion).

Inheritance Hierarchy

System.Object
  Lumia.Imaging.Custom.CustomFilterBase

Version Information

Lumia Imaging SDK

Supported in: 2.0

See Also

CustomFilterBase.CustomFilterBase Members

Lumia.Imaging.Custom Namespace