The BlurFilter object lets you apply a blur visual effect to display objects. A blur effect softens the details of an image. You can produce blurs that range from a softly unfocused look to a Gaussian blur, a hazy appearance like viewing an image through semi-opaque glass. When the quality property of this filter is set to low, the result is a softly unfocused look. When the quality property is set to high, it approximates a Gaussian blur filter. You can apply the filter to any display object (that is, objects that inherit from the DisplayObject object), such as TextField, as well as to BitmapData objects.

To create a new filter, use the constructor new BlurFilter(). The use of filters depends on the object to which you apply the filter:


To apply filters use the filters property (inherited from DisplayObject). Setting the filters property of an object does not modify the object, and you can remove the filter by clearing the filters property.

To apply filters to BitmapData objects, use the BitmapData.applyFilter() method. Calling applyFilter() on a BitmapData object takes the source BitmapData object and the filter object and generates a filtered image as a result.

If you apply a filter to a display object, the cacheAsBitmap property of the display object is set to true. If you remove all filters, the original value of cacheAsBitmap is restored.


This filter supports Stage scaling. However, it does not support general scaling, rotation, and skewing. If the object itself is scaled (scaleX and scaleY are not set to 100%), the filter effect is not scaled. It is scaled only when the user zooms in on the Stage.


A filter is not applied if the resulting image exceeds the maximum dimensions.


Can be created with method new:

Lib.Media.Filters.BlurFilter.new(blurX, blurY, quality)

Initializes the filter with the specified parameters.

blurX - (default = 4.0) - The amount to blur horizontally. Valid values are from 0 to 255.0 (floating-point value).

blurY - (default = 4.0) - The amount to blur vertically. Valid values are from 0 to 255.0 (floating-point value).

quality (default = 1) - The number of times to apply the filter. You can specify the quality using the BitmapFilterQuality constants:

Lib.Media.Filters.BitmapFilterQuality.LOW (1)

Lib.Media.Filters.BitmapFilterQuality.MEDIUM (2)

Lib.Media.Filters.BitmapFilterQuality.HIGH (3)

High quality approximates a Gaussian blur. For most applications, these three values are sufficient. Although you can use additional numeric values up to 15 to achieve different effects, be aware that higher values are rendered more slowly.


Created BlurFilter object has properties:

blurX

The amount of horizontal blur.

blurY

The amount of vertical blur.

quality

The number of times to perform the blur.


methods:

clone()

Returns a copy of this filter object.



Created with the Personal Edition of HelpNDoc: Easily create Qt Help files