Image (Type of variable)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Properties specific to the description of Image variables
Accessing the pixels
Managing the Alpha layer
Image variable and Image control
Image variable and debugger
Creating an image with a specific size
Functions that handle the Image variables
Functions (object syntax) that handle Image variables

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Image (Type of variable)

In french: Image

The Image type is used to define the advanced characteristics of an image. The characteristics of this image can be defined and modified by several WLanguage properties.

Note: See Declaring a variable for more details.

Versions 18 and later

This type of variable is now available for the Java applications.

This type of variable is now available for the Android applications.

This type of variable is now available in Windows Store apps mode.

New in version 18

This type of variable is now available for the Java applications.

This type of variable is now available for the Android applications.

This type of variable is now available in Windows Store apps mode.

This type of variable is now available for the Java applications.

This type of variable is now available for the Android applications.

This type of variable is now available in Windows Store apps mode.

Versions 21 and later

This type of variable is now available in Universal Windows 10 App mode.

New in version 21

This type of variable is now available in Universal Windows 10 App mode.

Example

MyImage is Image
// Load from a file
MyImage = dLoadImage("image.png")
// Equivalent syntaxes
// MyImage = "image.png"
// MyImage..Image = "image.png"

// Draw in the image
dStartDrawing(MyImage)

// Write a text
dFont("Arial", 12, iNormal, 0)
dText(4, 0, "I am writing my text in an Image control!")

// Resize
dResize(MyImage, 100, 100)

// End of drawing
dEndDrawing(MyImage)

// Assign to an Image control
IMG_ImageControl = MyImage

Remarks

Properties specific to the description of Image variables

The following properties can be used to handle an Image variable:

Property name	Type used	Effect

WithAlpha	Boolean	Used to find out whether the image contains an alpha layer: True if the image contains an alpha layer, False otherwise. This property is available in read-only.
BitPerPixel	Integer	Number of bits per pixel. This property is available in read-only.
FillColor	Color variable	Fill color of the image. This color is used: when resizing the image (..Height and ..Width) when turning the image around (dRotation).
Versions 21 and later DrawingScale New in version 21 DrawingScale DrawingScale	Real	Scale that will be used for the drawing functions (dXXX functions): the coordinates used by these functions will be multiplied by this value. This property is not available.
EXIF[Exif tag]	Associative array	Used to find out the content of the specified Exif tag. ..Empty is used to find out whether the content of the Exif tag is empty or not. For example: IF not MyImage..EXIF[320]..Empty THEN IsTagValue = MyImage..EXIF[320] END The Exif Tags that can be used are the ones listed in the documentation of ImageInfoValue. This property is available in read-only. This property is not available.
Height	Integer	Height of image in pixels. If this property is modified, the image is not deformed: additional pixels are added. The color of these pixels is defined by ..FillColor.
Image	All types	Used to load an image from a buffer, a file or a memo. This property is equivalent to dLoadImage. Notes: In read mode, this property returns a buffer containing the image in PNG format. The images in SVG or PDF format are not supported. To manage these formats, you must use dLoadImage. The animated images are not supported. A single page of multi-page images (TIF, ICO) can be loaded. Only the first page is loaded. Versions 19 and later You have the ability to draw a chart in an Image variable via grDestinationImage. New in version 19 You have the ability to draw a chart in an Image variable via grDestinationImage. You have the ability to draw a chart in an Image variable via grDestinationImage. The ICO format is not supported by iOS.
Width	Integer	Width of image in pixels. If this property is modified, the image is not deformed: additional pixels are added. The color of these pixels is defined by ..FillColor.
Pixel[x,y]	Array of Color	Used to handle the pixels of the image.
Validate	Boolean	Returns the validity of the image: True if the image is valid: it was successfully loaded or created. False otherwise. This property is available in read-only.

Note: These properties can be used with one of the following syntaxes:

<Variable name>..<Property name>
<Variable name>.<Property name>

Accessing the pixels

To access the pixels of the image, you have the ability to use the following syntax:

<Name of Image Variable>[<Horizontal Coordinate>, <Vertical Coordinate>]

The origin of the coordinates is (0,0).

For example:

// Modify the pixel at coordinates 220,300
MyImage[220,300] = LightYellow

You also have the ability to use the Color properties. For example:

MyImage[220,300]..Lightness = MyImage[220,300]..Lightness + 10

Managing the Alpha layer

An image contains an Alpha layer in the following cases:

if it was created by default with an alpha layer, specified by ..FillColor.
if it was loaded from an image format containing an alpha layer (PNG format for example).

You also have the ability to handle the Alpha layer of the image by handling its pixels.

Image variable and Image control

You can:

assign an Image variable to an Image control.
assign an Image control to an Image variable.

These operations are available for the Image controls found in the window editor, page editor and report editor.

Image variable and debugger

The content of an Image variable can be viewed in the debugger.

Creating an image with a specific size

To create an image with a specific size, all you have to do is use ..Width and ..Height.

For example:

MyImage is Image
MyImage..Width = 10
MyImage..Height = 10

The unit used is the pixel.

The following code creates an image of 0 x 0.

MyImage is Image

Functions that handle the Image variables


Versions 09 and later dArc New in version 09 dArc dArc	Draws an arc of circle or an arc of ellipse: in an Image control, in an Image variable.
Versions 09 and later dBackground New in version 09 dBackground dBackground	Declares the default background color for the rectangles, circles, ... used: in an Image control, in an Image variable].
Versions 21 and later dBorder New in version 21 dBorder dBorder	Draws a border.
Versions 09 and later dChangeMode New in version 09 dChangeMode dChangeMode	Changes the drawing mode used by the drawing functions (dLine, dRectangle, ....).
Versions 09 and later dChord New in version 09 dChord dChord	Draws the chord of a circle (intersection between an ellipse and a straight line): in an Image control, in an Image variable].
Versions 09 and later dCircle New in version 09 dCircle dCircle	Draws a circle or an ellipse: in an Image control, in an Image variable.
Versions 18 and later dCopy New in version 18 dCopy dCopy	Copies an image into another image.
Versions 09 and later dCopyBlt New in version 09 dCopyBlt dCopyBlt	Copies an image: from an Image control into another Image control. from an Image variable into another Image variable.
Versions 17 and later dCopyScreenImage New in version 17 dCopyScreenImage dCopyScreenImage	Copies the screen content into an Image variable or into an Image control.
Versions 17 and later dCopyWindowImage New in version 17 dCopyWindowImage dCopyWindowImage	Copies the image from a WINDEV window into an Image variable or into an Image control.
Versions 17 and later dCrop New in version 17 dCrop dCrop	Returns the cropped part of an image. This image is found in an Image variable.
Versions 17 and later dEncrustColor New in version 17 dEncrustColor dEncrustColor	Encrusts a color in an image found in an Image variable].
Versions 09 and later dFill New in version 09 dFill dFill	Colors an area: in an Image control, in an Image variable].
Versions 09 and later dFont New in version 09 dFont dFont	Declares the font that will be used by dText: in an Image control, in an Image variable.
Versions 17 and later dHalo New in version 17 dHalo dHalo	Adds a halo effect on an image found in an Image variable].
Versions 09 and later dLine New in version 09 dLine dLine	Draws a line: in an Image control, in an Image variable].
Versions 17 and later dLoadImage New in version 17 dLoadImage dLoadImage	Loads an image in an Image variable from a memo, a file or a binary buffer.
Versions 09 and later dPen New in version 09 dPen dPen	Declares the default color and style for the lines, the rectangles, the circles, ... found: in an Image control, in an Image variable].
Versions 09 and later dPoint New in version 09 dPoint dPoint	Draws a point: in an Image control, in an Image variable].
Versions 09 and later dPolygon New in version 09 dPolygon dPolygon	Draws a polygon: in an Image control, in an Image variable.
Versions 24 and later dPolyline New in version 24 dPolyline dPolyline	Draws a line composed of several segments.
Versions 09 and later dRectangle New in version 09 dRectangle dRectangle	Draws a rectangle: in an Image control, in an Image variable].
Versions 12 and later dRectangleGradient New in version 12 dRectangleGradient dRectangleGradient	Draws a rectangle: in an Image control, in an Image variable].
Versions 21 and later dRoundedRectangle New in version 21 dRoundedRectangle dRoundedRectangle	Draws a rounded rectangle: in an Image control, in an Image variable.
Versions 17 and later dShadow New in version 17 dShadow dShadow	Adds a shadow effect on an image found in an Image variable].
Versions 09 and later dSlice New in version 09 dSlice dSlice	Draws a circle section or an ellipse section: in an Image control, in an Image variable].
Versions 09 and later dText New in version 09 dText dText	Draws a text: in an Image control, in an Image variable].
Versions 20 and later dTextRTF New in version 20 dTextRTF dTextRTF	Draws an RTF text: in an Image control, in an Image variable].
Versions 17 and later dTransferToImage New in version 17 dTransferToImage dTransferToImage	Creates an image from a buffer of pixels encoded in a specific format This function is an advanced function. This function is mainly used to handle the images returned by external APIs via Image variables
Versions 19 and later grDestinationImage New in version 19 grDestinationImage grDestinationImage	Defines an Image variable as destination of a chart.
Versions 09 and later iImageHeight New in version 09 iImageHeight iImageHeight	Calculates the height of the image to print (in millimeters).
Versions 09 and later iImageWidth New in version 09 iImageWidth iImageWidth	Calculates the width of the image to print (in millimeters).
Versions 09 and later iPrintImage New in version 09 iPrintImage iPrintImage	Sends the image file to print to the print buffer.

Functions (object syntax) that handle Image variables


Versions 24 and later <Image variable>.Background New in version 24 <Image variable>.Background <Image variable>.Background	Declares the default background color for the rectangles, circles, ... used in an Image variable.
Versions 24 and later <Image variable>.ChangeMode New in version 24 <Image variable>.ChangeMode <Image variable>.ChangeMode	Changes the drawing mode used by the drawing functions (dLine, dRectangle, ....).
Versions 24 and later <Image variable>.Copy New in version 24 <Image variable>.Copy <Image variable>.Copy	Copies an image into another image.
Versions 24 and later <Image variable>.Crop New in version 24 <Image variable>.Crop <Image variable>.Crop	Returns the cropped part of an image. This image is found in an Image variable.
Versions 24 and later <Image variable>.DominantImageColor New in version 24 <Image variable>.DominantImageColor <Image variable>.DominantImageColor	Returns the dominant color (i.e. most frequent color) of an image found in an Image variable.
Versions 24 and later <Image variable>.DrawArc New in version 24 <Image variable>.DrawArc <Image variable>.DrawArc	Draws a circle arc on an ellipse arc in an Image variable.
Versions 24 and later <Image variable>.DrawBorder New in version 24 <Image variable>.DrawBorder <Image variable>.DrawBorder	Draws a border in an Image variable.
Versions 24 and later <Image variable>.DrawChord New in version 24 <Image variable>.DrawChord <Image variable>.DrawChord	Draws the chord of a circle (intersection between an ellipse and a straight line) in an Image variable.
Versions 24 and later <Image variable>.DrawCircle New in version 24 <Image variable>.DrawCircle <Image variable>.DrawCircle	Draws a circle or an ellipse in an Image variable.
Versions 24 and later <Image variable>.DrawHalo New in version 24 <Image variable>.DrawHalo <Image variable>.DrawHalo	Adds a halo effect on an image found in an Image variable].
Versions 24 and later <Image variable>.DrawLine New in version 24 <Image variable>.DrawLine <Image variable>.DrawLine	Draws a line in an Image variable.
Versions 24 and later <Image variable>.DrawPoint New in version 24 <Image variable>.DrawPoint <Image variable>.DrawPoint	Draws a point in an Image variable.
Versions 24 and later <Image variable>.DrawPolygon New in version 24 <Image variable>.DrawPolygon <Image variable>.DrawPolygon	Draws a polygon in an Image variable.
Versions 24 and later <Image variable>.DrawPolyline New in version 24 <Image variable>.DrawPolyline <Image variable>.DrawPolyline	Draws a line composed of several segments in an Image variable.
Versions 24 and later <Image variable>.DrawRectangle New in version 24 <Image variable>.DrawRectangle <Image variable>.DrawRectangle	Draws a rectangle in an Image variable.
Versions 24 and later <Image variable>.DrawRectangleGradient New in version 24 <Image variable>.DrawRectangleGradient <Image variable>.DrawRectangleGradient	Draws a rectangle in an Image variable.
Versions 24 and later <Image variable>.DrawRoundedRectangle New in version 24 <Image variable>.DrawRoundedRectangle <Image variable>.DrawRoundedRectangle	Draws a rounded rectangle in an Image variable.
Versions 24 and later <Image variable>.DrawShadow New in version 24 <Image variable>.DrawShadow <Image variable>.DrawShadow	Adds a shadow effect on an image found in an Image variable].
Versions 24 and later <Image variable>.DrawSlice New in version 24 <Image variable>.DrawSlice <Image variable>.DrawSlice	Draws a slice of a circle or an ellipse in an Image variable.
Versions 24 and later <Image variable>.DrawText New in version 24 <Image variable>.DrawText <Image variable>.DrawText	Draw a text in an Image variable.
Versions 24 and later <Image variable>.DrawTextRTF New in version 24 <Image variable>.DrawTextRTF <Image variable>.DrawTextRTF	Draws an RTF text in an Image variable.
Versions 24 and later <Image variable>.EncrustColor New in version 24 <Image variable>.EncrustColor <Image variable>.EncrustColor	Encrusts a color in an image found in an Image variable].
Versions 24 and later <Image variable>.Fill New in version 24 <Image variable>.Fill <Image variable>.Fill	Colors an area in an Image variable.
Versions 24 and later <Image variable>.Font New in version 24 <Image variable>.Font <Image variable>.Font	Declares the font that will be used by dText in an Image variable Image.
Versions 24 and later <Image variable>.HorizontalSymmetry New in version 24 <Image variable>.HorizontalSymmetry <Image variable>.HorizontalSymmetry	Performs a horizontal symmetry of an image in an Image variable.
Versions 24 and later <Image variable>.InvertColor New in version 24 <Image variable>.InvertColor <Image variable>.InvertColor	Inverts the colors in an Image variable.
Versions 24 and later <Image variable>.ModifyHSL New in version 24 <Image variable>.ModifyHSL <Image variable>.ModifyHSL	Modifies the hue, saturation and lightness of an image in an Image variable.
Versions 24 and later <Image variable>.ModifyHue New in version 24 <Image variable>.ModifyHue <Image variable>.ModifyHue	Modifies the hue of an image found in an Image variable.
Versions 24 and later <Image variable>.ModifyLightness New in version 24 <Image variable>.ModifyLightness <Image variable>.ModifyLightness	Modifies the lightness of an image in an Image variable.
Versions 24 and later <Image variable>.ModifySaturation New in version 24 <Image variable>.ModifySaturation <Image variable>.ModifySaturation	Modifies the saturation of an image in an Image variable.
Versions 24 and later <Image variable>.Pen New in version 24 <Image variable>.Pen <Image variable>.Pen	Declares the default color and style for the lines, the rectangles, the circles, ... found in an Image variable.
Versions 24 and later <Image variable>.PixelColor New in version 24 <Image variable>.PixelColor <Image variable>.PixelColor	Identifies the color of a pixel contained in an Image variable.
Versions 24 and later <Image variable>.PixelOpacity New in version 24 <Image variable>.PixelOpacity <Image variable>.PixelOpacity	Identifies the opacity of a pixel in an image (in an Image variable) that manages the Alpha layer.
Versions 24 and later <Image variable>.Resize New in version 24 <Image variable>.Resize <Image variable>.Resize	Resizes an image in an Image variable.
Versions 24 and later <Image variable>.Rotation New in version 24 <Image variable>.Rotation <Image variable>.Rotation	Rotates an image in an Image variable.
Versions 24 and later <Image variable>.SaveImageBMP New in version 24 <Image variable>.SaveImageBMP <Image variable>.SaveImageBMP	Saves an image contained in an Image variable: in a file in BMP format. in memory.
Versions 24 and later <Image variable>.SaveImageGIF New in version 24 <Image variable>.SaveImageGIF <Image variable>.SaveImageGIF	Saves an image found in an Image variable: in a file in GIF format. in memory.
Versions 24 and later <Image variable>.SaveImageJPEG New in version 24 <Image variable>.SaveImageJPEG <Image variable>.SaveImageJPEG	Saves an image found in an Image variable: in a file in JPEG format. in memory.
Versions 24 and later <Image variable>.SavePNG New in version 24 <Image variable>.SavePNG <Image variable>.SavePNG	Saves an image found in an Image variable: in a file in PNG format. in memory.
Versions 24 and later <Image variable>.StartDrawing New in version 24 <Image variable>.StartDrawing <Image variable>.StartDrawing
Versions 24 and later <Image variable>.VerticalSymmetry New in version 24 <Image variable>.VerticalSymmetry <Image variable>.VerticalSymmetry	Performs a vertical symmetry of an image in an Image variable.