### QPx_FilterAreaImage

QPx_FilterAreaImage(areaRef; filterSettings; selectionOnly):error
| areaRef | Longint | QPix area reference
| filterSettings | BLOB | Filter settings
| selectionOnly | Longint | Filter selection only
| error | Longint | Error result

Applies a filter to the image in a QPix plug-in area.

The QPix plug-in area is specified by areaRef. If areaRef is not a valid QPix plug-in area reference, qpx_paramErr is returned.

The filterSettings parameter specifies the filter to be applied and its associated settings. To let the user select a filter and retrieve the selected filter and settings, call the QPx_DoFilterSettingsDialog command.

To get information about all available QuickTime filters, call the QPx_GetFilterList command.

Note: The BLOB parameter must contain filter settings that has previously been obtained using the QPx_DoFilterSettingsDialog command. The structure of this BLOB is private to QuickTime and cannot be constructed or altered with 4D BLOB commands.

The selectionOnly parameter is a number that denotes what part of the image to filter. To filter the whole image, set selectionOnly to 0. To filter the image portion that is currently selected with the marquee tool, set selectionOnly to 1.

Example

``Display the filter settings dialog and apply` ``the selected filter and settings to the area image` `` `C_LONGINT($error)` `C_STRING(4;$filterType)` `C_BLOB($settings)` `` `$error:=QPx_DoFilterSettingsDialog($settings;$filterType)` `` `If ($error=qpx_noErr)` `` `$error:=QPx_FilterAreaImage(gQPixArea;$settings)` `` `End if` ``

Related commands

QPx_DoFilterSettingsDialog | Displays the standard filter dialog to the user
QPx_GetFilterList | Returns a list of available QuickTime filters
QPx_BrightnessContrastAreaImg | Applies the "Escape Brightness and Contrast" filter to the image in a QPix plug-in area
QPx_SharpenAreaImage | Applies the "Sharpen" filter to the image in a QPix plug-in area
QPx_BlurAreaImage | Applies the "Blur" filter to the image in a QPix plug-in area
QPx_RGBBalanceAreaImage | Applies the "RGB Balance" filter to the image in a QPix plug-in area
QPx_HSLBalanceAreaImage | Applies the "HSL Balance" filter to the image in a QPix plug-in area

QPix © Escape
Generated by QDoc 2.8 on Wed, Feb 17, 2010 17:44:33