MUSHclient scripting

Description of MUSHclient world function: world.BlendPixel

Name	BlendPixel
Type	Method
Summary	Blends a single pixel with another, using a specified blending mode
Prototype	`long BlendPixel(long Blend, long Base, short Mode, double Opacity);` View list of data type meanings
Description	This does the same thing as WindowBlendImage, except it operates on a single pixel (that is, a single RGB colour for the blend colour, and a single RGB colour for the base colour). This does the same thing, to a single pixel, as WindowBlendImage (with the same codes). This is intended for situations where you need to work on individual colours - either in a miniwindow image, or generally, to do things like merge them together in various ways. Blend - the RGB code of the pixel to be blended Base - the RGB code of the base pixel Mode - the blending method. Mode 1 - Normal Mode 2 - Average Mode 3 - Interpolate Mode 4 - Dissolve Mode 5 - Darken Mode 6 - Multiply Mode 7 - Colour Burn Mode 8 - Linear Burn Mode 9 - Inverse Colour Burn Mode 10 - Subtract Mode 11 - Lighten Mode 12 - Screen Mode 13 - Colour Dodge Mode 14 - Linear Dodge Mode 15 - Inverse Colour Dodge Mode 16 - Add Mode 17 - Overlay Mode 18 - Soft Light Mode 19 - Hard Light Mode 20 - Vivid Light Mode 21 - Linear Light Mode 22 - Pin Light Mode 23 - Hard Mix Mode 24 - Difference Mode 25 - Exclusion Mode 26 - Reflect Mode 27 - Glow Mode 28 - Freeze Mode 29 - Heat Mode 30 - Negation Mode 31 - Phoenix Mode 32 - Stamp Mode 33 - Xor Mode 34 - And Mode 35 - Or Mode 36 - Red Mode 37 - Green Mode 38 - Blue Mode 39 - Yellow Mode 40 - Cyan Mode 41 - Magenta Mode 42 - Green limited by red Mode 43 - Green limited by blue Mode 44 - Green limited by average of red and blue Mode 45 - Blue limited by red Mode 46 - Blue limited by green Mode 47 - Blue limited by average of red and green Mode 48 - Red limited by green Mode 49 - Red limited by blue Mode 50 - Red limited by average of green and blue Mode 51 - Red only Mode 52 - Green only Mode 53 - Blue only Mode 54 - Discard red Mode 55 - Discard green Mode 56 - Discard blue Mode 57 - All red Mode 58 - All green Mode 59 - All blue Mode 60 - Hue mode Mode 61 - Saturation mode Mode 62 - Colour mode Mode 63 - Luminance mode Mode 64 - HSL Opacity - the amount of opacity, between 0 and 1 (floating-point number). An opacity of 0 means the result will be the base pixel. An opacity of 1 means the blend is fully applied. An opacity of 0.5 means the blended pixel is merged 50% with the original pixel. For more information and screen shots showing the effects of various modes, see: http://www.gammon.com.au/mushclient/mw_blending.htm Note: Available in version 4.36 onwards.
Lua example	`BlendPixel (0x123456, 0x445566, 1, 0.5) -- mode 1 (normal) at 50% opacity (gives 0x2b445e)`
Returns	`-1: The blend mode was not in the above list. -2: Opacity less than zero or greater than 1. Otherwise, the RGB code resulting from the blend operation.`
Introduced in version	4.36

See also ...

Function	Description
WindowBlendImage	Blends an image into a miniwindow, using a specified blending mode

Search for script function

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.

Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes

Function prototypes

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

View all functions

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.