Sapphire Plug-ins for Autodesk: GlareMaskCmp


Generates rainbow halos and/or glint-like rays at locations where the Source clip is brighter than the threshold. Each glare's color is scaled by the color of the Mask input, and then the glares are combined with the Back input clip. This is similar to Glare, but here a Mask input is provided, and also the glint source and background can be different clips.


Front: The clip to use as foreground.

Back: The clip to combine the glares with.

Matte: Specifies the opacities of the Front clip. These values are scaled by the Source Opacity parameter before being used.

Mask: The source glare colors are scaled by this input. A monochrome Mask can be used to choose a subset of Source areas that will generate glares. A color Mask can be used to selectively adjust the glare colors in different regions. The Mask is applied to the source before the glares are generated so it will not clip the resulting glares.


Load Preset: Push-button .
Brings up the Preset Browser to browse all available presets for this effect.

Save Preset: Push-button .
Brings up the Preset Save dialog to save a preset for this effect.

Type: Default: 0, Range: 0 or greater.
The style of glare to apply. Custom glare types can also be made, or existing types modified, by editing the "s_glares.text" file.

Convolve: Check-box,  Default: off.
Determines the method for applying the glares to the Background.

Size: Default: 1, Range: 0 or greater.
Scales the size of the glares. This parameter can be adjusted using the Size Widget.

Rel Height: Default: 1, Range: 0 or greater.
Scales the vertical dimension of the glares, making them elliptical instead of circular.

Rotate: Default: 0, Range: any.
Rotates the ray elements of the glares, if any, in degrees.

Source Opacity: Default: 1, Range: 0 or greater.
Scales the opacity of the Source input when combined with the glares. This does not affect the generation of the glares themselves.

Scale Back: Default: 1, Range: 0 to 1.
Scales the brightness of the background. This parameter only has an effect if the background input is provided, and is visible due to a partially transparent Source image or a reduced Source Opacity parameter value.

Brightness: Default: 1, Range: 0 or greater.
Scales the brightness of all the glares.

Saturation: Default: 1, Range: any.
Scales the color saturation of the glare elements. Increase for more intense colors. Set to 0 for monochrome glares.

Rays Num Scale: Default: 1, Range: 0 or greater.
Increases or decreases the number of rays.

Rays Length: Default: 1, Range: 0 or greater.
Adjusts the length of the rays without changing their thickness.

Rays Thickness: Default: 1, Range: 0 or greater.
Adjusts the thickness of the individual rays.

Glare Under Src: Default: 0, Range: 0 to 1.
Set to 1 to composite the Source input over the glares.

Glare From Matte: Default: 0, Range: 0 to 1.
Set to 1 to generate glares from the alpha channel of the source input instead of the RGB channels. In this case the glares will not pick up color from the source and will typically be brighter. Values between 0 and 1 interpolate between using the RGB and the Alpha.

Scale Colors: Default rgb: [1 1 1].
Scales the color of the glares. The colors and brightnesses of the glares are also affected by the Source input.

Threshold: Default: 0.8, Range: 0 or greater.
Glares are generated from locations in the source clip that are brighter than this value. A value of 0.9 causes glares at only the brightest spots. A value of 0 causes glares for every non-black area.

Threshold Add Color: Default rgb: [0 0 0].
This can be used to raise the threshold on a specific color and thereby reduce the glares generated on areas of the source clip containing that color.

Threshold Blur: Default: 0, Range: 0 or greater.
Increase to smooth out the areas creating glares. This can be used to eliminate glares generated from small speckles or to simply soften the glares. Increasing this may put more highlights below the threshold and darken the resulting glares, but you can decrease the Threshold parameter to compensate.

Glare Res: Popup menu,  Default: Full .
Selects the resolution factor for the glares. Higher resolutions give sharper glares, lower resolutions give smoother glares and faster processing. This 'Res' factor only affects the glares: the background is still combined with the glares at full resolution.
Full: Full resolution is used.
Half: The glares are calculated at half resolution.
Quarter: The glares are calculated at quarter resolution.

Mask Type: Popup menu,  Default: Luma .
This setting is ignored unless the Mask input is provided.
Luma: uses the luminance of the Mask input to scale the brightness of the glares.
Color: uses the RGB channels of the Mask input to scale the colors of the glares.

Invert Mask: Check-box,  Default: off.
If enabled, inverts the mask input so the effect is applied to areas where the Mask is black instead of white.

Comp Premult: Check-box,  Default: off, Shared .
Enable this for a better composite if the Front pixel values have been pre-multiplied by the Matte pixel values. This is also known as an 'additive' composite.


Blur Glare: Default: 0, Range: 0 or greater, Shared .
The glare is blurred by this amount before being combined with the background.

Hue Shift: Default: 0, Range: any, Shared .
Shifts the hue of the glare, in revolutions from red to green to blue to red.


Mocha: Default: 0, Range: 0 or greater, Shared .
Brings up the Mocha window for tracking footage and generating masks.

Blur Mocha: Default: 0, Range: 0 or greater, Shared .
Blurs the Mocha Mask by this amount before using. This can be used to soften the edges or quantization artifacts of the mask, and smooth out the time displacements.

Mocha Opacity: Default: 1, Range: 0 to 1, Shared .
Controls the strength of the Mocha mask. Lower values reduce the intensity of the effect.

Invert Mocha: Check-box,  Default: off, Shared .
If enabled, the black and white of the Mocha Mask are inverted before applying the effect.

Show Mocha Only: Check-box,  Default: off, Shared .
Bypass the effect and show the Mocha Mask itself.

Bypass Mocha: Check-box,  Default: off, Shared .
Ignore the Mocha Mask and apply the effect to the entire source clip.

Combine Masks: Popup menu,  Default: Union .
Determines how to combine the Mocha Mask and Input Mask when both are supplied to the effect.
Union: Uses the area covered by both masks together.
Intersect: Uses the area that overlaps between the two masks.
Mocha Only: Ignore the Input Mask and only use the Mocha Mask.
See general info for: Res , On Fields , Redraw , Undo , Load Defaults , Crop , Add Noise , and Use Gamma .

See Also:

Sapphire Plug-ins Introduction


Join our email newsletter and keep up to date