Kōtuku
  • Gallery
  • API
  • Wiki
  • GitHub
    • Audio
    • Config
    • Core
    • Display
    • Document
    • Font
    • HTTP
    • Network
    • Regex
    • SVG
    • Tiri
    • Vector
    • XML
    • XQuery
    • XRandR
      • Audio
      • MP3
      • Sound
      • File
      • MetaClass
      • Module
      • StorageDevice
      • Task
      • Thread
      • Time
      • Compression
      • CompressedStream
      • Config
      • LZMAStream
      • Script
      • Tiri
      • XML
      • XQuery
      • Controller
      • BlurFX
      • ColourFX
      • CompositeFX
      • ConvolveFX
      • DisplacementFX
      • FilterEffect
      • FloodFX
      • ImageFX
      • LightingFX
      • MergeFX
      • MorphologyFX
      • OffsetFX
      • RemapFX
      • SourceFX
      • TurbulenceFX
      • WaveFunctionFX
      • Scintilla
      • Bitmap
      • Clipboard
      • Display
      • Document
      • Font
      • Image
      • Pointer
      • Surface
      • SVG
      • ClientSocket
      • HTTP
      • NetClient
      • NetLookup
      • NetServer
      • NetSocket
      • Proxy
      • Gradient
      • GradientConic
      • GradientContour
      • GradientDiamond
      • GradientDiffusion
      • GradientDistal
      • GradientGouraud
      • GradientLinear
      • GradientMesh
      • GradientRadial
      • GradientVoronoi
      • Vector
      • VectorClip
      • VectorColour
      • VectorEllipse
      • VectorFilter
      • VectorGradient
      • VectorGroup
      • VectorImage
      • VectorPath
      • VectorPattern
      • VectorPolygon
      • VectorRectangle
      • VectorScene
      • VectorShape
      • VectorSpiral
      • VectorText
      • VectorTransition
      • VectorViewport
      • VectorWave
      • Linux Builds
      • Windows Builds
      • Customising Your Build
      • Kōtuku Objects
      • Kōtuku In Depth
      • Kōtuku Design Patterns
      • Coding With AI
      • Regex Manual
      • XML Comparisons
      • Tiri Reference Manual
      • Config API
      • Defer Syntax
      • GUI API
      • HTTP Server API
      • I/O API
      • JSON API
      • OAuth API
      • Options API
      • Proxy Server API
      • Tempus API
      • URL API
      • VFX API
      • Widgets
      • RIPL Reference Manual
      • Origo
      • Flute / Unit Testing
      • Tuku
      • Embedded Document Format
      • TDL Reference Manual
      • TDL Tools
      • Action Reference Manual
      • System Error Codes

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 must 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
 HeightUNITPrimitive 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 as 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.
 WidthUNITPrimitive width of the effect area.

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

 XUNITPrimitive X coordinate for the effect.

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

 XMLDefSTRINGReturns an SVG compliant XML string that describes the effect.
 YUNITPrimitive 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:

MoveToBackMove an effect to the back of the VectorFilter's list order.
MoveToFrontMove an effect to the front of the VectorFilter's list order.
FilterEffect class documentation © Paul Manias © 2010-2026

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-2026