dRoundedRectangle (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Drawing functions

Graphic strings management functions

Using the drawing functions

See also

dRoundedRectangle (Function)

In french: dRectangleArrondi

Draws a rounded rectangle:

in an Image control,
in an Image variable.
Versions 25 and later
in a WDPic variable (on the background layer),
New in version 25
in a WDPic variable (on the background layer),
in a WDPic variable (on the background layer),
Versions 25 and later
in a picLayer variable.
New in version 25
in a picLayer variable.
in a picLayer variable.

Remark: To draw custom rectangles, it is recommended to use the dBorder.

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

Example

// Initialise le dessin dans un champ Image
dStartDrawing(IMG_Dessin)

// Dessin d'un rectangle arrondi dont le fond est jaune clair
// et le bord bleu clair
dRoundedRectangle(10, 10, 50, 50, 3, LightYellow, LightBlue)

Versions 24 and later

// Dessin d'un rectangle arrondi dont le fond est jaune clair
// et le bord bleu clair
dRoundedRectangle(IMG_Dessin, 10, 10, 50, 50, 3, LightYellow, LightBlue)

New in version 24

// Dessin d'un rectangle arrondi dont le fond est jaune clair
// et le bord bleu clair
dRoundedRectangle(IMG_Dessin, 10, 10, 50, 50, 3, LightYellow, LightBlue)

Syntax

Drawing a rounded rectangle by specifying the coordinates of the rectangle and the diameter of corners Hide the details

dRoundedRectangle([<Image>, ] <X1> , <Y1> , <X2> , <Y2> , <Corner diameter> [, <Background> [, <Line>]])

<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 a variable of type Image.
Versions 25 and later
the name of a variable of type WDPic. Only the background layer will be handled.
New in version 25
the name of a variable of type WDPic. Only the background layer will be handled.
the name of a variable of type WDPic. Only the background layer will be handled.
Versions 25 and later
the name of a variable of type picLayer.
New in version 25
the name of a variable of type picLayer.
the name of a variable of type picLayer.
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 a variable of type Image.
Versions 25 and later
the name of a variable of type WDPic. Only the background layer will be handled.
New in version 25
the name of a variable of type WDPic. Only the background layer will be handled.
the name of a variable of type WDPic. Only the background layer will be handled.
Versions 25 and later
the name of a variable of type picLayer.
New in version 25
the name of a variable of type picLayer.
the name of a variable of type picLayer.
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 a variable of type Image.
Versions 25 and later
the name of a variable of type WDPic. Only the background layer will be handled.
New in version 25
the name of a variable of type WDPic. Only the background layer will be handled.
the name of a variable of type WDPic. Only the background layer will be handled.
Versions 25 and later
the name of a variable of type picLayer.
New in version 25
the name of a variable of type picLayer.
the name of a variable of type picLayer.
If this parameter is not specified, it is necessary to define the drawing destination with dStartDrawing.

<X1>: entier

X-coordinate (in pixels) of top left corner of rectangle.

<Y1>: entier

Y-coordinate (in pixels) of top left corner of rectangle.

<X2>: entier

X-coordinate (in pixels) of bottom right corner of rectangle.

<Y2>: entier

Y-coordinate (in pixels) of bottom right corner of rectangle.

<Corner diameter>: entier

Diameter of rectangle corners.

<Background>: Integer or Integer constant (optional)

Background color of rectangle. This color can be:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a WLanguage preset color,
Versions 22 and later
a Color variable,
New in version 22
a Color variable,
a Color variable,
transparent if this parameter is not specified and if dBackground has not been used beforehand.
Characteristics of background:
Background variable. In this case, the gradient defined in the variable is ignored.
characteristics specified in the last call to dBackground if this parameter is not specified.
To use a gradient background color, call dRectangleGradient.

<Line>: Integer, constant or Border variable (optional)

Color of rectangle line. This color can be:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a WLanguage preset color,
Versions 22 and later
a variable of type Color.
New in version 22
a variable of type Color.
a variable of type Color.
If this parameter is not specified:
color specified in the last call to dPen.
color identical to the color used for the background if dPen has not been used.

Drawing a rounded rectangle by specifying the coordinates of the rectangle and the border type Hide the details

dRoundedRectangle([<Image>, ] <X1> , <Y1> , <X2> , <Y2> , <Border> [, <Background>])

<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 a variable of type Image.
Versions 25 and later
the name of a variable of type WDPic. Only the background layer will be handled.
New in version 25
the name of a variable of type WDPic. Only the background layer will be handled.
the name of a variable of type WDPic. Only the background layer will be handled.
Versions 25 and later
the name of a variable of type picLayer.
New in version 25
the name of a variable of type picLayer.
the name of a variable of type picLayer.
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 a variable of type Image.
Versions 25 and later
the name of a variable of type WDPic. Only the background layer will be handled.
New in version 25
the name of a variable of type WDPic. Only the background layer will be handled.
the name of a variable of type WDPic. Only the background layer will be handled.
Versions 25 and later
the name of a variable of type picLayer.
New in version 25
the name of a variable of type picLayer.
the name of a variable of type picLayer.
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 a variable of type Image.
Versions 25 and later
the name of a variable of type WDPic. Only the background layer will be handled.
New in version 25
the name of a variable of type WDPic. Only the background layer will be handled.
the name of a variable of type WDPic. Only the background layer will be handled.
Versions 25 and later
the name of a variable of type picLayer.
New in version 25
the name of a variable of type picLayer.
the name of a variable of type picLayer.
If this parameter is not specified, it is necessary to define the drawing destination with dStartDrawing.

<X1>: entier

X-coordinate (in pixels) of top left corner of rectangle.

<Y1>: entier

Y-coordinate (in pixels) of top left corner of rectangle.

<X2>: entier

X-coordinate (in pixels) of bottom right corner of rectangle.

<Y2>: entier

Y-coordinate (in pixels) of bottom right corner of rectangle.

<Border>: Border variable

Name of Border variable defining the rectangle characteristics. Only the following properties are taken into account:
Arrondi: if the property corresponds to the RoundingUndefined constant, no rounding is performed.
Color: if the property corresponds to the ColorUndefined constant, the color defined during the last call to dPen is used. If this function has not been used, the background color of the rectangle will be used.
Thickness: if the property corresponds to the constant ThicknessUndefined, the thickness defined during the last call to the function dPen is used. If this function has not been used, the thickness will be set to 1.
Line: if the property is LineUndefined, the type of Line defined during the last call to the dPen function is used. If this function has not been used, the line will be solid.

<Background>: Integer, constant or Background variable (optional)

Background color of rectangle. This color can be:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a WLanguage preset color,
Versions 22 and later
a Color variable,
New in version 22
a Color variable,
a Color variable,
transparent if this parameter is not specified and if dBackground has not been used beforehand.
Characteristics of background:
Background variable. In this case, the gradient defined in the variable is ignored.
characteristics specified in the last call to dBackground if this parameter is not specified.
To use a gradient background color, call dRectangleGradient.

Drawing a rounded rectangle via a Rectangle variable by specifying the diameter of corners Hide the details

dRoundedRectangle([<Image>, ] <Rectangle> , <Corner diameter> [, <Background> [, <Line>]])

<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 a variable of type Image.
Versions 25 and later
the name of a variable of type WDPic. Only the background layer will be handled.
New in version 25
the name of a variable of type WDPic. Only the background layer will be handled.
the name of a variable of type WDPic. Only the background layer will be handled.
Versions 25 and later
the name of a variable of type picLayer.
New in version 25
the name of a variable of type picLayer.
the name of a variable of type picLayer.
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 a variable of type Image.
Versions 25 and later
the name of a variable of type WDPic. Only the background layer will be handled.
New in version 25
the name of a variable of type WDPic. Only the background layer will be handled.
the name of a variable of type WDPic. Only the background layer will be handled.
Versions 25 and later
the name of a variable of type picLayer.
New in version 25
the name of a variable of type picLayer.
the name of a variable of type picLayer.
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 a variable of type Image.
Versions 25 and later
the name of a variable of type WDPic. Only the background layer will be handled.
New in version 25
the name of a variable of type WDPic. Only the background layer will be handled.
the name of a variable of type WDPic. Only the background layer will be handled.
Versions 25 and later
the name of a variable of type picLayer.
New in version 25
the name of a variable of type picLayer.
the name of a variable of type picLayer.
If this parameter is not specified, it is necessary to define the drawing destination with dStartDrawing.

<Rectangle>: Rectangle variable

Name of the Rectangle variable that defines the coordinates of the rectangle to draw.

<Corner diameter>: entier

Diameter of rectangle corners.

<Background>: Integer, constant or Background variable (optional)

Background color of rectangle. This color can be:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a WLanguage preset color,
Versions 22 and later
a Color variable,
New in version 22
a Color variable,
a Color variable,
transparent if this parameter is not specified and if dBackground has not been used beforehand.
Characteristics of background:
Background variable. In this case, the gradient defined in the variable is ignored.
characteristics specified in the last call to dBackground if this parameter is not specified.
To use a gradient background color, call dRectangleGradient.

<Line>: Integer, constant or Border variable (optional)

Color of rectangle line. This color can be:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a WLanguage preset color,
Versions 22 and later
a variable of type Color.
New in version 22
a variable of type Color.
a variable of type Color.
If this parameter is not specified:
color specified in the last call to dPen.
color identical to the color used for the background if dPen has not been used.

Drawing a rounded rectangle via a Rectangle variable and a Border variable Hide the details

dRoundedRectangle([<Image>, ] <Rectangle> , <Border> [, <Background>])

<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 a variable of type Image.
Versions 25 and later
the name of a variable of type WDPic. Only the background layer will be handled.
New in version 25
the name of a variable of type WDPic. Only the background layer will be handled.
the name of a variable of type WDPic. Only the background layer will be handled.
Versions 25 and later
the name of a variable of type picLayer.
New in version 25
the name of a variable of type picLayer.
the name of a variable of type picLayer.
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 a variable of type Image.
Versions 25 and later
the name of a variable of type WDPic. Only the background layer will be handled.
New in version 25
the name of a variable of type WDPic. Only the background layer will be handled.
the name of a variable of type WDPic. Only the background layer will be handled.
Versions 25 and later
the name of a variable of type picLayer.
New in version 25
the name of a variable of type picLayer.
the name of a variable of type picLayer.
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 a variable of type Image.
Versions 25 and later
the name of a variable of type WDPic. Only the background layer will be handled.
New in version 25
the name of a variable of type WDPic. Only the background layer will be handled.
the name of a variable of type WDPic. Only the background layer will be handled.
Versions 25 and later
the name of a variable of type picLayer.
New in version 25
the name of a variable of type picLayer.
the name of a variable of type picLayer.
If this parameter is not specified, it is necessary to define the drawing destination with dStartDrawing.

<Rectangle>: Rectangle variable

Name of the Rectangle variable that defines the coordinates of the rectangle to draw.

<Border>: Border variable

Name of Border variable defining the rectangle characteristics. Only the following properties are taken into account:
Arrondi: if the property corresponds to the RoundingUndefined constant, no rounding is performed.
Color: if the property corresponds to the ColorUndefined constant, the color specified during the last call to dPen is used. If this function has not been used, the background color of the rectangle will be used.
Thickness: if the property corresponds to the ThicknessUndefined constant, the thickness specified during the last call to dPen is used. If this function has not been used, the thickness will be set to 1.
Line: if the property corresponds to the LineUndefined constant, the type of line specified during the last call to dPen is used. If this function has not been used, the line will be solid.

<Background>: Integer, constant or Background variable (optional)

Background color of rectangle. This color can be:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a WLanguage preset color,
Versions 22 and later
a Color variable,
New in version 22
a Color variable,
a Color variable,
transparent if this parameter is not specified and if dBackground has not been used beforehand.
Characteristics of background:
Background variable. In this case, the gradient defined in the variable is ignored.
characteristics specified in the last call to dBackground if this parameter is not specified.
To use a gradient background color, call dRectangleGradient.

Remarks

Coordinates

The coordinates are given in relation to the top left corner of the image or Image control ((0, 0) coordinates).

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. The dStartDrawing function becomes unnecessary. 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. The dStartDrawing function becomes unnecessary. 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. The dStartDrawing function becomes unnecessary. This function must be deleted.

Business / UI classification: Neutral code

Component: wd270pnt.dll