PictureEffects REALbasic Plugin

HueSaturation Class

A class to do Hue, Saturation and Lightness filters on pictures.

MPImageFilter
   HueSaturation

class HueSaturation

Constructors

HueSaturationThe default constructor for the HueSaturation class, all values are set to zero.
HueSaturationUse this constructor to construct a HueSaturation object where the Hue, Saturation and Lightness properties have been preset for the Master channel, and the Calculate function has been pre called for you.

Properties

ErrorCode (Inherited)Returns error code after applying the effect. This value is a Constant defined in the PictureEffectsError module.
MultiprocessingHint (Inherited)Use this property to fine tune CPU usage for this algorithm. By default this property is set to zero (Automatic). This property accepts all constants that are defined in PictureEffectsCPUUsage.
ProgressHandler (Inherited)Use this property to use a progress class to get progress feedback from this function. This class must be a class that Implements the IProgressHandler Interface which is defined in this plugin.

Methods

ApplyEffectUse this function to apply the effect based of the settings of the Hue, Saturation and Lightness properties for all of the channels.
ApplyInPlaceApplies the effect in place on a given 32 bit source image with a given 32 bit mask.
CalculateUse this method to recalculate internal conversation tables. This method must be called after setting all the Hue, Lightness and Saturation properties, before ApplyEffect is called.
HueUse this setter/getter function to set or get a value of Hue for any desired channel.
LightnessUse this setter/getter function to set or get a value of Lightness for any desired channel.
ResetThis method resets all the Hue, Lightness and Saturation properties to 0.0.
SaturationUse this etter/getter function to set or get a value of Saturation for any desired channel.

Supported Platforms:

  • PPC - MacOS 9
  • Carbon - MacOS 9 and MacOS X (PEF)
  • MacOS X PPC - (Mach-O)
  • MacOS X Universal Binary (Mach-O)
  • Win32 - Windows
  • Linux x86