CImage:Subx

The Subx method subtracts a constant value from the image pixels.

Syntax

bResult = CImage:Subx( x )

bullet.gif    The value x may be passed as a number or a string.

bullet.gif    On success, this method returns true

bullet.gif    On failure, this method returns false.

Remarks

Subtracting a value can result in values below 0. If this is a possibility, be sure the pixel type supports negative values; if not, use SetPixelType to change to a real pixel type before calling Subx.

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 loads an image from the file sPath, adds the value 50.5, and saves the result back to the file:

I = new_image()

-- create a new CImage

I:Open(sPath)

-- load the image from a file named sPath

I:Subx( 50.5 )

-- perform the operation

I:Save()

 

Related Topics

CImage class


Mira Pro x64 Script User's Guide, Copyright Ⓒ 2023 Mirametrics, Inc. All Rights Reserved.