Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter TenGraphic and Image Functions (continued)

ImageExportGIF Function

Overview

The ImageExportGIF function exports an image as a Graphics Interchange Format (GIF) file.

Syntax/Parameters

Syntax

int = ImageExportGIF ( handle hImage, string filename, [int flags], [dword transparent] );

Parameters

hImage

A handle to an Image Object.

filename

A string containing a fully qualified filename with path.

flags

An optional int specifying the palette creation method. The following flags are permissible:

  IMAGE_GIF_WEB   0x00000100   The Standard Web Palette option will use the standard 216-color web palette with 40 shades of gray added to the palette. This option is typically sufficient for charts, graphs, and other simple images.  
  IMAGE_GIF_332   0x00000200   The 3-3-2 Color Palette option will use a color palette that has less color detail for blue shades, as these shades are less perceptible to the human eye. An image with this palette contains more colors than the average human can perceive by color matching blue hues away from the blue spectrum.  
  IMAGE_GIF_BEST_GUESS   0x00000400   Using the Best Guess or the Adaptive Matching option will build a custom palette ordered by the frequency of color appearance within the image. This option can cause large images to save slowly but it is the recommended option for images that contain over 256 colors. When using this option, particularly on even moderately large images, the optimization operation is very processing intensive. Expect delays in the seconds or even a minute or more.   

transparent

An optional dword that specifies an RGB color that is used for transparency.

Return Value

Returns an int value as ERROR_NONE or a formatted error code.

Remarks

The GIF format supports up to 8 bits per pixel for each image, allowing a single image to reference its own palette of up to 256 different colors chosen from the 24-bit RGB color space. These palette limitations make the GIF format unsuitable for reproducing color photographs and other images with continuous color, but it is well-suited for simpler images such as graphics or logos with solid areas of color. The palette setting does not affect the Image object, only the exported data.

The Image object does not support animations and therefore will not export animated GIFs.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic