dBackground (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

Using the drawing functions

Related examples

See also

dBackground (Function)

In french: dFond

Declares the default background color for the rectangles, circles, ... used:

in an Image control,
in an Image variable.

Example

See additional examples

// Initialize the drawing in an Image control
dStartDrawing(IMG_Drawing)

// Declare the background color of different drawings
// made in the Image control
dBackground(LightGreen)

Versions 24 and later

// Declare the background color of different drawings
// made in the Image control IMG_Drawing
dBackground(IMG_Drawing, LightGreen)

New in version 24

// Declare the background color of different drawings
// made in the Image control IMG_Drawing
dBackground(IMG_Drawing, LightGreen)

Syntax

dBackground([<Image>, ] <Color> [, <Fill style> [, <Type of hatching> [, <Opacity>]]])

<Image>: Optional control name or optional Image, WDPic or picLayer variable

Versions 24 and later
Image to use. This image can correspond to:
the name of an Image control.
the name of an Image variable.
If this parameter is not specified, it is necessary to define the drawing destination with dStartDrawing.
New in version 24
Image to use. This image can correspond to:
the name of an Image control.
the name of an Image variable.
If this parameter is not specified, it is necessary to define the drawing destination with dStartDrawing.
Image to use. This image can correspond to:
the name of an Image control.
the name of an Image variable.
If this parameter is not specified, it is necessary to define the drawing destination with dStartDrawing.

<Color>: Integer or constant

Default background color of different drawings. This color can correspond to:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a preset color of WLanguage.
a Color variable. In this case, the opacity specified in the variable is taken into account.

<Fill style>: Optional integer or Integer constant

Default background fill of different drawings:
BackgroundHatched Background filled with hatching.
Corresponds to value 2 for compatibility.
BackgroundSolid
(Default value) Solid background.
Corresponds to value 0 for compatibility.
BackgroundTransparent Transparent background (<Color> is ignored).
Corresponds to value 1 for compatibility.

<Type of hatching>: Optional integer

Type of background hatching used by default in the different drawings. To use this parameter, the value of <Fill style> must be equal to 2. If the value of <Fill style> is different from 2, <Type of hatching> is ignored. The different types of hatching are:
0: Horizontal hatching
1: Vertical hatching
2: Diagonal hatching at 60%
3: Diagonal hatching at 120%
4 (by default): Criss-crossed hatching
5: Diagonal crossed hatching

<Opacity>: Optional integer

Opacity of color, included between 0 (transparent) and 255 (opaque). An opacity set to 128 is used to blend 50% of the color with the existing color found in the control.
Remarks:
This opacity will be taken into account if the drawing was initialized with the dWithOpacity constant (dStartDrawing).
Versions 23 and later
If the <Color> parameter corresponds to a Color variable, this parameter must not be specified: the opacity specified in the variable will be taken into account.
New in version 23
If the <Color> parameter corresponds to a Color variable, this parameter must not be specified: the opacity specified in the variable will be taken into account.
If the <Color> parameter corresponds to a Color variable, this parameter must not be specified: the opacity specified in the variable will be taken into account.

Remarks

Using the drawing functions

The drawing functions can be used according to 2 methods:

Method 1: Using dStartDrawing
- dStartDrawing must be called before any other drawing function. dStartDrawing is used to define the element (Image control or variable) to which the drawing functions will be applied.
- When drawing on an Image control:
  - The drawing functions operate on a copy ("bitmap") of the image. You can use the drawing functions of Windows (via API or CallDLL32) but these functions must use the DC (Device Context) returned by dStartDrawing.
  - dEndDrawing and dStartDrawing must not be called in the same process.
    The drawing will not be displayed if dEndDrawing and dStartDrawing are called in the same process: it will be automatically erased.
Versions 24 and later
Method 2: indicating the drawing target directly in the syntax (via a parameter)
The <Image> parameter is used to specify directly the target of the drawing. dStartDrawing becomes useless. This function must be deleted.

New in version 24
Method 2: indicating the drawing target directly in the syntax (via a parameter)
The <Image> parameter is used to specify directly the target of the drawing. dStartDrawing becomes useless. This function must be deleted.

Method 2: indicating the drawing target directly in the syntax (via a parameter)
The <Image> parameter is used to specify directly the target of the drawing. dStartDrawing becomes useless. This function must be deleted.

Related Examples:

Unit examples (WINDEV): The drawing functions

[ + ] Using the main drawing functions of WINDEV to:
- Initialize an Image control for drawing
- Draw simple shapes
- Write a text into a drawing
- Change the color in a drawing

Business / UI classification : Neutral code

Component : wd250pnt.dll