drawRect

drawRect (integer Image, integer Left, integer Top, integer Right, integer Bottom [, integer Fill =1,

floating R, integer G =R, integer B =R, integer Opacity =100, integer Width =1 ] )

Use this function to draw a rectangle on an image. Equivalent to using the Rectangle Tool.

Parameters

Image

An integer between 1 and 116 specifying the image frame number. Values in the range of 100-116 correspond to hidden frames.

Left, Top, Right, Bottom

Positive integers specifying the left position, top, right position and bottom of the rectangle in pixels.

Fill

An optional enumerated integer that defines the filling mode. Must be one of the following values:

FALSE – draws the exterior of the rectangle without filling out the interior.

TRUE – fills the interior of the rectangle

Default: TRUE

R

An optional floating variable or constant specifying the color or intensity of the rectangle. Depending on the type of the image, this parameter will be interpreted differently:

Grayscale (8, 16, 32 bpp) or floating image the intensity of the pixel Palettized or multiphase image the index in the image palette RGB (16, 24, 32, 48 bpp) image the red component of the pixel Complex image the first component of the pixel

Default value: established by setDrawColor.

G

An optional integer specifying the green component of the color of the rectangle for an image of an RGB type. For any other image type this parameter is disregarded.

Default value: same as R

B

An optional integer specifying the blue component of the color of the rectangle for an image of an RGB type. For any other image type this parameter is disregarded.

Default value: same as R

Opacity

An optional integer between 0 and 100 specifying the percentage of opacity at which the rectangle will be blended with the underlying pixels in the image.

Default value: 100 if R is present, otherwise defined by current brush settings

Width

An optional positive integer specifying the width of the exterior of the rectangle.

Default value: 1 if R is present, otherwise defined by current pencil width

Error flags

ERR_OK

The flag set if successful.

ERR_FAILED

The flag set if failed.

Example

The following set of statements creates a blank floating point image and draws a filled rectangle with the intensity 99.55

createIm (1, IM_FLOAT, 256, 256)

drawRect (1, 50, 50, 200, 200, TRUE, 99.55)