<Image variable>.SavePNG (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Drawing functions

Prefix syntax

Drawing functions on Image variables

SavePNG

Presentation

Example

Displaying a PNG image

Transparent image in PNG format

See also

<Image variable>.SavePNG (Function)

In french: <Variable Image>.SauvePNG

Saves an image:

in a PNG file.
in memory.

This image corresponds to the image contained in a Image control.

Remarks:

Only the visible part of the Image control is saved.
The border of the Image control (if it exists) is also saved.
Reminder: The border of the Image control is defined in the "Style" tab of the description window of control.
This function can only be used to save the images for screen resolutions up to 32 bits.
This function cannot be used with the Image controls found in the reports.

Caution: A specific configuration is required to use this function in Linux. For more details, see The drawings.

Example

// Saves the image found in "IMG_ImageDrawing" in "C:\Documents\Image.PNG"
ResSave = IMG_ImageDrawing.SavePNG("C:\Documents\Image.PNG")

// Saves in memory the image found in "IMG_ImageDrawing"
ResSave = IMG_ImageDrawing.SavePNG(inMemory)

Syntax

Saving an image in a PNG file Hide the details

<Result> = <Image variable>.SavePNG(<File name> [, <Transparency color>])

<Result>: Boolean

True if the image was saved,
False otherwise. To get more details on the error, use ErrorInfo with the errMessage constant.

<Image variable>: Image variable

Name of the Image, Bar Code or Web Camera control to be saved. Image controls in a report cannot be used.
Name of the Image or Web Camera control to be used.
Name of the Image control to be used.

<File name>: Character string

Name and full (or relative) path of PNG file. A UNC path can be used. The file extension is optional.
Caution:
The destination directory must exist in order for the image to be saved.
The existence of the PNG file is not checked. This file is automatically overwritten if it already exists.

<Transparency color>: Optional integer

Color that will be considered as being transparent in the image. This color can correspond to:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a WLanguage preset color.
If this parameter is not specified, the generated image is not transparent.

Syntax not available

Saving an image in memory Hide the details

<Result> = <Image variable>.SavePNG(<inMemory> [, <Transparency color>])

<Result>: Buffer

Byte string containing the image in PNG format.
Then, this byte string can be assigned to an Image control, saved in a file (fSaveText), sent via a network (with the Socket functions), ...

<Image variable>: Image variable

Name of the Image, Bar Code or Web Camera control to be saved. Image controls in a report cannot be used.
Name of the Image or Web Camera control to be used.
Name of the Image control to be used.

<inMemory>: Constant

inMemory: Constant used to save an image in memory.

<Transparency color>: Optional integer

Color that will be considered as being transparent in the image. This color can correspond to:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a WLanguage preset color.
If this parameter is not specified, the generated image is not transparent.
This parameter is ignored.

Remarks

Displaying a PNG image

Caution: If the image in PNG format is semi-transparent, the display of the image is slower.

Transparent image in PNG format

To save a transparent image in PNG format, the Image control must be filled with the transparent color beforehand.

Example used to draw a transparent line and to save it in PNG format:

IMG_Image1.StartDrawing(dWithOpacity)
IMG_Image1.ChangeMode(drawDefault)
FOR nI = 0 _TO_ IMG_Image1..Width
FOR nJ = 0 _TO_ IMG_Image1..Height
IMG_Image1.DrawPoint(nI, nJ, RGB(255,255,255), 0)
END
END
IMG_Image1.Pen(RGB(100, 020, 200), 0,10, 100)
IMG_Image1.DrawLine(10, 10, 100, 10)
IMG_Image1.SavePNG(CompleteDir(fExeDir()) + "img.png")

Component: wd280pnt.dll