CImage:Addx

CImage:Addx

The Addx method adds a constant value to the image pixels.

Syntax

bResult = CImage:Addx( x )

The value x may be passed as a number or a string.
On success, this method returns true
On failure, this method returns false.

Remarks

For the byte, short, and ushort data types, Mira handles value overflow by truncating the output pixel value at the maximum for the data type. For example, adding 20000 to a "short" type image may produce a pixel value as high as 52767 but Mira caps the result at 32767.

The value x can be passed as a numeric value or a string. Using a string is the only way to pass an rgb color value but it may also be used for numeric type images.

Example

The following script fragment loads an image from the file sPath, adds the value 50.5, and saves the result back to the file:


I = CImage:new()	-- create a new CImage
I:Open(sPath)	-- load the image from a file named sPath
I:Addx( 50.5 )	-- perform the operation
I:Save()