g:image.brightness Property

Gets or sets the brightness of the g:image element.

This property is read/write.

Syntax

propVal = g:image.brightness(fBrightness)

  
g:image.brightness(fBrightness)

   = propVal

Parameters

fBrightness [in]

fBrightness [out]
Sets or retrieves the "white" level applied to the target element. The value ranges from 0.0 to 100.0.

Value	Meaning
0.0	Default. No brightness effect applied. The target element is not modified.
1.0	Brightness effect of 100%. The target element has no detail, color, or contrast; it is opaque but effectively blank (white).
100.0	Brightness effect of 1%.

Remarks

The brightness effect can be specified in the gadget HTML and script files.

The opacity of the g:image element must be set to a value of at least 1 for the brightness effect to be visible.

Examples

The following example demonstrates how to add a brightness effect to the g:image element from a gadget script file.

\\ imgBackground is the value of the 'id' attribute for the g:background element.
var imgBrightness = imgBackground.addImageObject(file, intX, intY);
imgBrightness.brightness = 1.0;

The following example demonstrates how to add a brightness effect to the g:image element in the gadget HTML file.

<g:image src="..\aerologo.png" brightness="1.0"/>

Requirements

Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
IDL	Sidebar.idl
DLL	Sidebar.Exe version 1.00 or later