ssCore.Mask.enable

Enable a mask from the Masks tab or a previously loaded bitmap to create a shaped window.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

name - The name of the mask or loaded bitmap mask that you want to enable.


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.enable( 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.enable( paramsObject );


Notes:

None.


Examples:

ssCore.Mask.enable({name:"Mask5"});