dCopyBlt (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Drawing functions

Functions for handling graphic strings

See also

dCopyBlt (Function)

In french: dCopieImage

Warning
From version 18, this function is kept for backward compatibility for most of the platforms. We recommend that you use dCopy. Indeed:

dCopy manages transparency,
the different copy modes of dCopyBlt are replaced by:
- functions applicable to the Image type (dEncrustColor, dInvertColor, etc.),
- access to pixels.

Copies an image:

from an Image control into another Image control.
in an Image variable.
This type of variable is not available.

Versions 16 and later

This function is now available for Android applications.

New in version 16

This function is now available for Android applications.

Versions 18 and later

This function is now available in Windows Store apps mode.

This function is now available for iPhone/iPad applications.

Only the first syntax can be used with the Image type.

New in version 18

This function is now available in Windows Store apps mode.

This function is now available for iPhone/iPad applications.

Only the first syntax can be used with the Image type.

This function is now available in Windows Store apps mode.

This function is now available for iPhone/iPad applications.

Only the first syntax can be used with the Image type.

Example

See additional examples

// Simple copy of content from the "IMG_ImageDrawing" control
// into the "IMG_ImageCopy" Image control
ResCopy = dCopyBlt(IMG_ImageDrawing, IMG_ImageCopy)

// Copy the image of the screen into an Image control
dCopyBlt(copyScreen, IMG_MyImage)

Syntax

Copying the images found in the Image controls Hide the details

<Result> = dCopyBlt(<Source image control> , <Destination Image control> [, <Copy mode> [, <X source image> [, <Y source image> [, <Height source image> [, <Width source image> [, <X destination image> [, <Y destination image> [, <Height destination image> [, <Width destination image>]]]]]]]]])

<Result>: Boolean

True if the copy was performed,
False otherwise.
Remark: dCopyBlt can return False if the screen driver does not support this function. In this case, a message is displayed in the copied image. We recommend that you update your screen driver in order to get the proper behavior.

<Source image control>: Control name

Name of source Image control to use.
To perform a screen shot, use the copyScreen constant: the entire screen content is copied.
The copyScreen constant is not available.
Versions 18 and later
This parameter can correspond to:
the name of an Image control,
the name of a Image variable.
New in version 18
This parameter can correspond to:
the name of an Image control,
the name of a Image variable.
This parameter can correspond to:
the name of an Image control,
the name of a Image variable.

<Destination Image control>: Control name

Name of destination Image control where the copy will be performed.
Versions 18 and later
This parameter can correspond to:
the name of an Image control,
the name of an Image variable.
New in version 18
This parameter can correspond to:
the name of an Image control,
the name of an Image variable.
This parameter can correspond to:
the name of an Image control,
the name of an Image variable.

<Copy mode>: Optional constant

Mode of copy to perform.
copyDstInvert Reverses the colors of destination Image control.
This constant is not available.
copyImage Combines the source image and the destination image by using the transparency information of destination image
Can be used to include a logo in the destination image for example.
Remark: The size and position in the source are ignored. No homothety and no zoom are allowed in this mode.
This constant is not available.
copyMergeCopy Merges the source Image control and the destination Image control.
This constant is not available.
copyMergePaint Combines, via the "Logical AND" method, the source Image control and the "pattern" of destination Image control.
This constant is not available.
copyPatCopy Copies the "pattern" of source Image control into the destination Image control.
This constant is not available.
copyPatInvert Combines, via the "Exclusive Or" method, the pattern of source Image control and the "pattern" of destination Image control. The current brush, defined by dBackground, is used.
This constant is not available.
copyPatPaint Combines, via the "Or" method, the inverted source Image control and the "pattern" of destination Image control.
This constant is not available.
copyNotSrcCopy Reverses the colors of source Image control.
This constant is not available.
copyNotSrcErase Reverses, via the "Or" method, the combination between the source Image control and the destination Image control.
This constant is not available.
copySrcCopy
(Default value) Copies the source Image control into the destination Image control (simple copy).
copySrcErase Reverses the destination Image control and combines the result with the copy of source Image control.
This constant is not available.
copySrcAnd Combines, via the "and" method, the pixels of the Image image control and the pixels of destination Image control.
This constant is not available.
copySrcInvert Combines, via the "Exclusive Or" method, the pixels of the source Image control and the pixels of the destination Image control.
This constant is not available.
copySrcPaint Combines, via the "Or" method, the pixels of source Image control and the pixels of destination Image control.
This constant is not available.
copyWhiteness Fills the destination Image control with white.
This constant is not available.
copyBlackness Fills the destination Image control with black.
This constant is not available.

<X source image>: Optional integer

X coordinate (in pixels) of top left corner of the area to copy (top left corner of source Image control by default).

<Y source image>: Optional integer

Y coordinate (in pixels) of top left corner of the area to copy (top left corner of source Image control by default).

<Height source image>: Optional integer

Height (in pixels) of the area to copy (height of source Image control by default).

<Width source image>: Optional integer

Width (in pixels) of the area to copy (width of source Image control by default).

<X destination image>: Optional integer

X coordinate (in pixels) of top left corner of the destination area for the copy (top left corner of destination Image control by default).

<Y destination image>: Optional integer

Y coordinate (in pixels) of top left corner of destination area for the copy (top left corner of destination Image control by default).

<Height destination image>: Optional integer

Height (in pixels) of the area where the image will be copied (height of destination Image control by default). If this height is greater than the height of source image, the image will be enlarged during the copy.

<Width destination image>: Optional integer

Width (in pixels) of the area where the image will be copied (width of destination Image control by default). If this width is greater than the width of source image, the image will be enlarged during the copy.

Versions 17 and later

Copying the images found in the Image variables Hide the details

<Result> = dCopyBlt(<Name of source image> , <Name of destination image> [, <X source image> [, <Y source image> [, <Height source image> [, <Width source image> [, <X destination image> [, <Y destination image> [, <Height destination image> [, <Width destination image>]]]]]]]])

<Result>: Boolean

True if the copy was performed,
False otherwise.
Remark: dCopyBlt can return False if the screen driver does not support this function. In this case, a message is displayed in the copied image. We recommend that you update your screen driver in order to get the proper behavior.

<Name of source image>: Image variable

Name of the Image variable to use. This image is the source image.

<Name of destination image>: Image variable

Name of the Image variable into which the copy will be performed.

<X source image>: Optional integer

X coordinate (in pixels) of top left corner of the area to copy (top left corner of source image by default).

<Y source image>: Optional integer

Y coordinate (in pixels) of top left corner of the area to copy (top left corner of source image by default).

<Height source image>: Optional integer

Height (in pixels) of the area to copy (height of source image by default).

<Width source image>: Optional integer

Width (in pixels) of the area to copy (width of source image by default).

<X destination image>: Optional integer

X coordinate (in pixels) of top left corner of the destination area for the copy (top left corner of destination image by default).

<Y destination image>: Optional integer

Y coordinate (in pixels) of the top left corner of destination area for the copy (top left corner of destination image by default).

<Height destination image>: Optional integer

Height (in pixels) of the area into which the image will be copied (height of destination image by default). If this height is greater than the height of source image, the image will be enlarged during the copy.

<Width destination image>: Optional integer

Width (in pixels) of the area into which the image will be copied (width of destination image by default). If this width is greater than the width of source image, the image will be enlarged during the copy.

New in version 17

Copying the images found in the Image variables Hide the details

<Result>: Boolean

True if the copy was performed,
False otherwise.
Remark: dCopyBlt can return False if the screen driver does not support this function. In this case, a message is displayed in the copied image. We recommend that you update your screen driver in order to get the proper behavior.

<Name of source image>: Image variable

Name of the Image variable to use. This image is the source image.

<Name of destination image>: Image variable

Name of the Image variable into which the copy will be performed.

<X source image>: Optional integer

X coordinate (in pixels) of top left corner of the area to copy (top left corner of source image by default).

<Y source image>: Optional integer

Y coordinate (in pixels) of top left corner of the area to copy (top left corner of source image by default).

<Height source image>: Optional integer

Height (in pixels) of the area to copy (height of source image by default).

<Width source image>: Optional integer

Width (in pixels) of the area to copy (width of source image by default).

<X destination image>: Optional integer

X coordinate (in pixels) of top left corner of the destination area for the copy (top left corner of destination image by default).

<Y destination image>: Optional integer

Y coordinate (in pixels) of the top left corner of destination area for the copy (top left corner of destination image by default).

<Height destination image>: Optional integer

Height (in pixels) of the area into which the image will be copied (height of destination image by default). If this height is greater than the height of source image, the image will be enlarged during the copy.

<Width destination image>: Optional integer

Width (in pixels) of the area into which the image will be copied (width of destination image by default). If this width is greater than the width of source image, the image will be enlarged during the copy.

Copying the images found in the Image variables Hide the details

<Result>: Boolean

True if the copy was performed,
False otherwise.
Remark: dCopyBlt can return False if the screen driver does not support this function. In this case, a message is displayed in the copied image. We recommend that you update your screen driver in order to get the proper behavior.

<Name of source image>: Image variable

Name of the Image variable to use. This image is the source image.

<Name of destination image>: Image variable

Name of the Image variable into which the copy will be performed.

<X source image>: Optional integer

X coordinate (in pixels) of top left corner of the area to copy (top left corner of source image by default).

<Y source image>: Optional integer

Y coordinate (in pixels) of top left corner of the area to copy (top left corner of source image by default).

<Height source image>: Optional integer

Height (in pixels) of the area to copy (height of source image by default).

<Width source image>: Optional integer

Width (in pixels) of the area to copy (width of source image by default).

<X destination image>: Optional integer

X coordinate (in pixels) of top left corner of the destination area for the copy (top left corner of destination image by default).

<Y destination image>: Optional integer

Y coordinate (in pixels) of the top left corner of destination area for the copy (top left corner of destination image by default).

<Height destination image>: Optional integer

Height (in pixels) of the area into which the image will be copied (height of destination image by default). If this height is greater than the height of source image, the image will be enlarged during the copy.

<Width destination image>: Optional integer

Width (in pixels) of the area into which the image will be copied (width of destination image by default). If this width is greater than the width of source image, the image will be enlarged during the copy.

Remarks

Zoom on an image

During a copy, you can enlarge or reduce a section of the source image when copying it to the destination image. To do so:

Define the area to enlarge (or reduce) in the source image (with the parameters <X source image>, <Y source image>, <Height source image> and <Width source image>),
Define the display area of the result image. This area must be larger to enlarge the image and smaller to reduce the image. By default, the entire destination image is taken into account. Use <X destination image>, <Y destination image>, <Height destination image> and <Width destination image> if necessary.

The zoom percentage depends on the multiplying coefficient between the dimensions of the two areas.

For example:


1. The area to zoom is included in a rectangle whose width is et to 30 pixels and whose height is set to 40 pixels.	2. To perform a 200% zoom, the destination area must be twice the size of the source area: rectangle whose width is set to 60 pixels and whose height is set to 80 pixels.

In this case, the following code line is used to perform the zoom operation during the copy:

dCopyBlt(IMG_SourceControl, IMG_DestinationControl, copySrcCopy, 10, 10, 30, 40, 10, 10, 60, 80)

Component : wd170obj.dll