Shadow Effect Control

This section describes extensions that control different shadow effects (e.g., blur, knockout).

blurX, blurY properties

blurX:Number  [read-write] 
blurY:Number  [read-write] 

Scaleform version: 2.0.41

Gets or sets the blur radii of the text. Valid values are from 0 to 15.9 (floating point).

The default value is 0.

See also: blurStrength

blurStrength property

blurStrength:Number [read-write]

Scaleform version: 2.0.41

Gets or sets the blur strength of the text. Valid values are from 0 to 15.9 (floating point).

The default value is 0.

See also:

blurX
blurY

shadowAlpha property

shadowAlpha:Number [read-write]

Scaleform version: 2.0.41

Controls the alpha transparency value for the shadow color. Valid values are 0.00 to 1.00 (e.g., .25 sets a transparency value of 25%).

See also: shadowColor

shadowAngle property

shadowAngle:Number [read-write]

Scaleform version: 2.0.41

Controls the angle of the shadow, similar to DropShadowFilter. Valid values are 0 to 360˚ (floating point). The default value is 45.

See also: DropShadowFilter

shadowBlurX, shadowBlurY properties

shadowBlurX:Number  [read-write] 
shadowBlurY:Number  [read-write] 

Scaleform version: 2.0.41

Controls the blur radii of the shadow. Valid values are from 0 to 15.9 (floating point).

The default value is 0.

See also: shadowStrength

shadowColor property

shadowColor:Number [read-write]

Scaleform version: 1.1.31

Specifies the color of shadow (see shadowStyle for details). The color is specified in the following format: 0xRRGGBB, in which RR is the hexadecimal representation of the red component [0..255], BB the hexadecimal representation of the blue component [0..255] and GG the hexadecimal representation of the green component [0..255].

See also: shadowStyle

shadowDistance property

shadowDistance:Number  [read-write] 

Scaleform version: 2.0.41

Controls the offset distance for the shadow, in pixels, similar to DropShadowFilter.

See also: DropShadowFilter

shadowHideObject property

shadowHideObject:Boolean [read-write]

Scaleform version: 2.0.41

Indicates whether or not the text is hidden. The value true indicates that the text itself is not drawn; only the shadow is visible. The default is false (show the text).

shadowKnockOut property

shadowKnockOut:Boolean [read-write]

Scaleform version: 2.0.41

Controls a knockout effect (true), which effectively makes the object's fill transparent and reveals the background color of the document. The default is false (no knockout).

shadowQuality property

shadowQuality:Number [read-write]

Scaleform version: 2.0.41

Controls the quality of the shadow or glow filter. Unlike Flash, the only values that make sense are 1 or 2. Value 1 means low quality, 2 or above means high quality.

shadowStrength property

shadowStrength:Number [read-write]

Scaleform version: 2.0.41

Controls the blur strength of the shadow. Valid values are from 0 to 15.9 (floating point).

The default value is 0.

See also:

shadowBlurX
shadowBlurY

shadowStyle property

shadowStyle:String [read-write]

Scaleform version: 1.1.31

Combined with shadowColor, controls shadow rendering for the text field. Specifically, the shadowStyle format string describes the set of text layers that will be applied, together with their coordinates. For example:

field.shadowStyle = "s{0,-1.5}{-1.4,1.2}{1.4,1.2}t{0,0}";
field.shadowColor = 0xff0000;

Within the string the "s" character delimits the shadow layer that will be drawn with shadowColor color value, while the "t" character delimits the front text layer drawn with the standard TextField.textColor color value. These delimiters are followed by the coordinate pairs describing offsets at which each text layer will be rendered; each coordinate unit maps to one pixel when identity transform is applied to the text. If the "t" delimiter and its coordinate pair are omitted from the style string, text will be drawn identically to when "t{0,0}" is specified. Please note that in the current implementation using shadow layers will generate extra triangles and draw primitive calls, as text is rendered multiple times. It is strongly recommended to measure the resulting performance and to limit shadow use when possible. See also:

shadowColor
TextField.textColor