KCML_Image_Save

Purpose

Save an image to a buffer in the specified format

Definition

DEFSUB 'KCML_Image_Save(BYREF Jpeg$, BYREF image$()_KCML_RGBA), type, Quality) AS Bool

Parameters

Jpeg	Buffer to receive jpeg image. The buffer is resized to the exact size needed.
image	2 Dimensional string array representing the image.
type	** not documented
Quality	Integer giving the quality of output image - 100 for maximum quality (and largest size) down to 1 for lowest quality and maximum compression. This parameter only applies to Jpeg images.

Return

TRUE if the function succeeds

Description

This function takes a 2 dimensional string array of RGBA tuples and returns a string representing the image in the specified image format. This string may be saved to disk using an appropriate extension. If being used to generate images to display on the form then the extension does not matter as KClient always determines the image type by inspection of the file.

See also

Internal KCML Functions, Internally defined structures and Internally defined enumerations and constants.