Click or drag to resize
ConvolveMatrixEffect Properties

The ConvolveMatrixEffect type exposes the following members.

Properties
  NameDescription
Public propertyBorderMode
Gets and sets the border mode for edge pixels.
Public propertyBufferPrecision
Specifies what precision to use for intermediate buffers when drawing this effect.
Public propertyCacheOutput
Enables caching the output from drawing this effect.
Public propertyClampOutput
If set, the effect clamps color values to between 0 and 1 before passing them on to the next effect in the graph. If false, the effect will not clamp values, although subsequent effects or the output surface may later clamp if they are not of high enough precision. Default value false.
Public propertyDivisor
After the filter kernel is applied to a pixel, the result is divided by this value. Default 1.
Public propertyInterpolationMode
Interpolation mode used to scale the source image to the specified KernelScale. Default value Linear.
Public propertyKernelHeight
Height of the filter kernel matrix. Default value 3.
Public propertyKernelMatrix
The filter kernel matrix. This array must be sized KernelWidth * KernelHeight. Default value {0,0,0,0,1,0,0,0,0}.
Public propertyKernelOffset
Shifts the filter kernel from its default position centered on the output pixel. Default value (0,0).
Public propertyKernelScale
Scales how the filter kernel is mapped onto the 2D source image. Default value (1,1).
Public propertyKernelWidth
Width of the filter kernel matrix. Default value 3.
Public propertyName
Attaches a user-defined name string to the effect.
Public propertyOffset
After applying the filter kernel and divisor, this offset is added to the result. Default value 0.
Public propertyPreserveAlpha

Specifies whether the convolution filter is applied to alpha as well as the color channels.

When set to false, the filter applies equally to all of the red, green, blue, and alpha channels, operating on premultiplied alpha format data.

When set to true, only the color channels are filtered, while alpha values are kept unchanged. In this case the effect will temporarily unpremultiply the red, green, and blue color component values, apply the filter kernel only to the color channels, and then re-premultiply the result.

Default value false.

Public propertySource
Gets or sets the input source for ConvolveMatrix effect.
Top
See Also