ssCore.Mask.loadBitmap

Load a bitmap (BMP) file that will be used as a mask to create shaped windows.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

name - The name that should be assigned to the new mask, you will need this to enable the mask later.

path - The name of the bitmap file to be loaded. This parameter supports monikers.

maskColor - The color that should be removed to create the desired mask i.e. the color that should become transparent. The mask color is specified in '#rrggbb' format.

tolerance - All colors within the 'tolerance' range will be interpreted as transparent colors. Tolerance values can range from 0 (the color must be an exact match) to 441, which is the 'distance' between #000000 (black) and #ffffff (white).


Output Parameters:

No output parameters.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.Mask.loadBitmap( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.Mask.loadBitmap( paramsObject );


Notes:

None.


Examples:

ssCore.Mask.loadBitmap({name:"Mask5", path:"startdir://triangle.bmp", maskColor:"#FFFFFF", tolerance:50});