combine_canvases
Combines two canvases together using an arithmetic operator. If the types of the lhs and rhs do not match then the rhs will be converted to the type of the lhs before the operator is applied. Canvases with integral types such as Rgb and Rgba can be processed much more quickly than other types such as Float32 or Color. Unsigned types and Rgbe based canvases are the slowest to operate on as they require slower access methods. The dimensions of the lhs and rhs canvases must match.
Web Services Notes:
- This command accepts Canvas types as input and return values which cannot be serialized by Web Services. This command should only be used as a utility command by other commands and cannot be called directly from Web Services.
References:
arguments
- "lhs" : Canvas
The canvas representing the left hand side value of the operator to use when combining the canvases.
- "operator" : String (default: "multiply")
The operation to perform when combining the canvases.
Possible Values:
- multiply
- add
- "rhs" : Canvas
The canvas representing the right hand side value of the operator to use when combining the canvases.
- "window" : Window_data (default: null)
Sub-window of the canvas in which to perform the operation. Outside this window the lhs pixels will be used directly.
return value
CanvasA Canvas containing the results of combining the lhs and rhs using the operator.