Parasol Framework
  • Modules
  • Classes
  • Wiki

FilterEffect Class

FilterEffect is a support class for managing effects hosted by the VectorFilter class.

The FilterEffect class provides base-class functionality for effect classes. FilterEffect objects mut not be instantiated directly by the client.

The documented fields and actions here are integral to all effects that utilise this class.

Structure

The FilterEffect class consists of the following fields:

Access
NameTypeComment
  DimensionsDMFDimension flags are stored here.

Dimension flags are automatically defined when setting the X, Y, Width and Height fields.

NameDescription
DMF::FIXED_CENTER_XThe CenterX field is a fixed size.
DMF::FIXED_CENTER_YThe CenterY field is a fixed size.
DMF::FIXED_DEPTHThe Depth field is a fixed size.
DMF::FIXED_HEIGHTThe Height field is a fixed size.
DMF::FIXED_RADIUS_XThe RadiusX field is a fixed size.
DMF::FIXED_RADIUS_YThe RadiusY field is a fixed size.
DMF::FIXED_WIDTHThe Width field is a fixed suze.
DMF::FIXED_XThe X field is a fixed coordinate.
DMF::FIXED_X_OFFSETThe XOffset field is a fixed coordinate.
DMF::FIXED_YThe Y field is a fixed coordinate.
DMF::FIXED_Y_OFFSETThe YOffset field is a fixed coordinate.
DMF::FIXED_ZThe Z field is a fixed coordinate.
DMF::SCALED_CENTER_XThe CenterX field is scaled to this object's parent.
DMF::SCALED_CENTER_YThe CenterY field is scaled to this object's parent.
DMF::SCALED_DEPTHThe Depth field is scaled to this object's parent.
DMF::SCALED_HEIGHTThe Height field is scaled to this object's parent.
DMF::SCALED_RADIUS_XThe RadiusX field is scaled to this object's parent.
DMF::SCALED_RADIUS_YThe RadiusY field is a scaled size to this object's parent.
DMF::SCALED_WIDTHThe Width field is scaled to this object's parent.
DMF::SCALED_XThe X field is scaled to this object's parent.
DMF::SCALED_X_OFFSETThe XOffset field is scaled to this object's parent.
DMF::SCALED_YThe Y field is scaled to this object's parent.
DMF::SCALED_Y_OFFSETThe YOffset field is scaled to this object's parent.
DMF::SCALED_ZThe Z field is a scaled coordinate to this object's parent.
DMF::STATUS_CHANGE_H
DMF::STATUS_CHANGE_V
  HeightDOUBLEPrimitive height of the effect area.

The (Width, Height) field values define the dimensions of the effect within the target clipping area.

  Input*FilterEffectReference to another effect to be used as an input source.

If another effect should be used as a source input, it must be referenced here. The SourceType will be automatically set to REFERENCE as a result.

This field is the SVG equivalent to in. If the Input is not defined by the client then it will default to the previous effect if available, otherwise the source graphic is used.

  Mix*FilterEffectReference to another effect to be used a mixer with Input.

If another effect should be used as a mixed source input, it must be referenced here. The MixType will be automatically set to REFERENCE as a result.

This field is the SVG equivalent to in2. It does nothing if the effect does not supported a mixed source input.

  MixTypeVSFIf a secondary mix input is required for the effect, specify it here.

Some effects support a secondary mix input for compositing, such as the CompositeFX class. If the mixing source is a reference to another effect, set the Mix field instead and this field will be set to REFERENCE automatically.

NameDescription
VSF::ALPHAAs for GRAPHIC except that only the alpha channel is used.
VSF::BKGDAn image snapshot of the SVG document under the filter region at the time that the filter element was invoked.
VSF::BKGD_ALPHAAs for BKGD but only the alpha channel is used.
VSF::FILLThe value of the fill property on the target element for the filter effect.
VSF::GRAPHICRepresents the graphics elements that were the original input into the filter element.
VSF::IGNOREThe filter does not require an input source.
VSF::PREVIOUSUse the previous effect as input, or source graphic if no previous effect.
VSF::REFERENCEThis value is an assigned name for the filter primitive in the form of a custom-ident. If supplied, then graphics that result from processing this filter primitive can be referenced by an in attribute on a subsequent filter primitive within the same filter element. If no value is provided, the output will only be available for re-use as the implicit input into the next filter primitive if that filter primitive provides no value for its in attribute.
VSF::STROKEThe value of the stroke property on the target element for the filter effect.
  Next*FilterEffectNext filter in the chain.
  Prev*FilterEffectPrevious filter in the chain.
  SourceTypeVSFSpecifies an input source for the effect algorithm, if required.

If an effect requires an input source for processing, it must be specified here. If the source is a reference to another effect, set the Input field instead and this field will be set to REFERENCE automatically.

NameDescription
VSF::ALPHAAs for GRAPHIC except that only the alpha channel is used.
VSF::BKGDAn image snapshot of the SVG document under the filter region at the time that the filter element was invoked.
VSF::BKGD_ALPHAAs for BKGD but only the alpha channel is used.
VSF::FILLThe value of the fill property on the target element for the filter effect.
VSF::GRAPHICRepresents the graphics elements that were the original input into the filter element.
VSF::IGNOREThe filter does not require an input source.
VSF::PREVIOUSUse the previous effect as input, or source graphic if no previous effect.
VSF::REFERENCEThis value is an assigned name for the filter primitive in the form of a custom-ident. If supplied, then graphics that result from processing this filter primitive can be referenced by an in attribute on a subsequent filter primitive within the same filter element. If no value is provided, the output will only be available for re-use as the implicit input into the next filter primitive if that filter primitive provides no value for its in attribute.
VSF::STROKEThe value of the stroke property on the target element for the filter effect.
  Target*BitmapTarget bitmap for rendering the effect.
  WidthDOUBLEPrimitive width of the effect area.

The (Width,Height) field values define the dimensions of the effect within the target clipping area.

  XDOUBLEPrimitive X coordinate for the effect.

The (X,Y) field values define the offset of the effect within the target clipping area.

  YDOUBLEPrimitive Y coordinate for the effect.

The (X,Y) field values define the offset of the effect within the target clipping area.

Actions

The following actions are currently supported:

NameComment
MoveToBackMove an effect to the front of the VectorFilter's list order.
MoveToFrontMove an object to the front of its current location.
FilterEffect class documentation © Paul Manias © 2010-2025

DMF Type

NameDescription
DMF::FIXED_CENTER_XThe CenterX field is a fixed size.
DMF::FIXED_CENTER_YThe CenterY field is a fixed size.
DMF::FIXED_DEPTHThe Depth field is a fixed size.
DMF::FIXED_HEIGHTThe Height field is a fixed size.
DMF::FIXED_RADIUS_XThe RadiusX field is a fixed size.
DMF::FIXED_RADIUS_YThe RadiusY field is a fixed size.
DMF::FIXED_WIDTHThe Width field is a fixed suze.
DMF::FIXED_XThe X field is a fixed coordinate.
DMF::FIXED_X_OFFSETThe XOffset field is a fixed coordinate.
DMF::FIXED_YThe Y field is a fixed coordinate.
DMF::FIXED_Y_OFFSETThe YOffset field is a fixed coordinate.
DMF::FIXED_ZThe Z field is a fixed coordinate.
DMF::SCALED_CENTER_XThe CenterX field is scaled to this object's parent.
DMF::SCALED_CENTER_YThe CenterY field is scaled to this object's parent.
DMF::SCALED_DEPTHThe Depth field is scaled to this object's parent.
DMF::SCALED_HEIGHTThe Height field is scaled to this object's parent.
DMF::SCALED_RADIUS_XThe RadiusX field is scaled to this object's parent.
DMF::SCALED_RADIUS_YThe RadiusY field is a scaled size to this object's parent.
DMF::SCALED_WIDTHThe Width field is scaled to this object's parent.
DMF::SCALED_XThe X field is scaled to this object's parent.
DMF::SCALED_X_OFFSETThe XOffset field is scaled to this object's parent.
DMF::SCALED_YThe Y field is scaled to this object's parent.
DMF::SCALED_Y_OFFSETThe YOffset field is scaled to this object's parent.
DMF::SCALED_ZThe Z field is a scaled coordinate to this object's parent.
DMF::STATUS_CHANGE_H
DMF::STATUS_CHANGE_V
FilterEffect module documentation © Paul Manias © 2010-2025

VSF Type

Filter source types - these are used internally

NameDescription
VSF::ALPHAAs for GRAPHIC except that only the alpha channel is used.
VSF::BKGDAn image snapshot of the SVG document under the filter region at the time that the filter element was invoked.
VSF::BKGD_ALPHAAs for BKGD but only the alpha channel is used.
VSF::FILLThe value of the fill property on the target element for the filter effect.
VSF::GRAPHICRepresents the graphics elements that were the original input into the filter element.
VSF::IGNOREThe filter does not require an input source.
VSF::PREVIOUSUse the previous effect as input, or source graphic if no previous effect.
VSF::REFERENCEThis value is an assigned name for the filter primitive in the form of a custom-ident. If supplied, then graphics that result from processing this filter primitive can be referenced by an in attribute on a subsequent filter primitive within the same filter element. If no value is provided, the output will only be available for re-use as the implicit input into the next filter primitive if that filter primitive provides no value for its in attribute.
VSF::STROKEThe value of the stroke property on the target element for the filter effect.
FilterEffect module documentation © Paul Manias © 2010-2025

Class Info

IDID_FILTEREFFECT
CategoryGraphics
Includemodules/filtereffect.h
Version1

Class List

  • Audio
    • Audio
    • Sound
  • Core
    • File
    • MetaClass
    • Module
    • StorageDevice
    • Task
    • Thread
    • Time
  • Data
    • Compression
    • Config
    • Script
    • XML
  • Effects
    • BlurFX
    • ColourFX
    • CompositeFX
    • ConvolveFX
    • DisplacementFX
    • FilterEffect
    • FloodFX
    • ImageFX
    • LightingFX
    • MergeFX
    • MorphologyFX
    • OffsetFX
    • RemapFX
    • SourceFX
    • TurbulenceFX
    • WaveFunctionFX
  • Extensions
    • Scintilla
    • ScintillaSearch
  • Graphics
    • Bitmap
    • Clipboard
    • Display
    • Document
    • Font
    • Picture
    • Pointer
    • Surface
    • SVG
  • Network
    • ClientSocket
    • HTTP
    • NetSocket
    • Proxy
  • Vectors
    • Vector
    • VectorClip
    • VectorColour
    • VectorEllipse
    • VectorFilter
    • VectorGradient
    • VectorGroup
    • VectorImage
    • VectorPath
    • VectorPattern
    • VectorPolygon
    • VectorRectangle
    • VectorScene
    • VectorShape
    • VectorSpiral
    • VectorText
    • VectorTransition
    • VectorViewport
    • VectorWave