Description of MUSHclient world function: world.WindowMergeImageAlpha
Name | WindowMergeImageAlpha |
---|---|
Type | Method |
Summary | Merges an image into a miniwindow based on an alpha mask |
Prototype | long WindowMergeImageAlpha(BSTR WindowName, BSTR ImageId, BSTR MaskId, long Left, long Top, long Right, long Bottom, short Mode, double Opacity, long SrcLeft, long SrcTop, long SrcRight, long SrcBottom);
|
Description | This merges the previously-loaded image identified by ImageId onto the miniwindow, based on the opacity of the mask MaskId. The mask must be large enough to cover the requested area in the blended image. Note: Available in version 4.36 onwards. |
Lua example |
|
Lua notes |
|
Returns | eBadParameter - Opacity not in range 0 to 1, or mask not large enough
|
Introduced in version | 4.36 |
See also ...
Function | Description |
---|---|
WindowBlendImage | Blends an image into a miniwindow, using a specified blending mode |
WindowGetImageAlpha | Draws the alpha channel of an image into a miniwindow |
WindowLoadImage | Loads an image into a miniwindow from a disk file |
Enter a word or phrase in the box below to narrow the list down to those that match.
The function name, prototype, summary, and description are searched.
Leave blank to show all functions.
Many functions return a "code" which indicates the success or otherwise of the function.
You can view a list of the return codes
The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).
You can view a list of the data types used in function prototypes
Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.