Navigation:  thinBasic Modules > UI (User Interface) > Dedicated Control Functions > Canvas Control >

Canvas_Clear

Previous pageReturn to chapter overviewNext page

 

Description

 

Clear the entire selected canvas target, optionally using a specified color and fill style

 

Syntax

 

n = Canvas_Clear( [rgbColor] [, fillstyle])

 

Returns

 

Number

 

Parameters

 

Name

Type

Optional

Meaning

rgbColor

Number

Yes

RGB value representing the fill color.

fillstyle

Number

Yes

Fill style (pattern) to be used.

If fillstyle is omitted, the default fill style is solid (0).  If a hatch pattern is chosen (1 to 6), the foreground color is specified by the rgbColor, while the background is specified by the default background color for the selected canvas window.

The optional fillstyle can be:

 

%Canvas_FillStyle_Solid

%Canvas_FillStyle_HorizontalLines

%Canvas_FillStyle_VerticalLines

%Canvas_FillStyle_UpwardDiagonalLines

%Canvas_FillStyle_DownwardDiagonalLines

%Canvas_FillStyle_CrossedLines

%Canvas_FillStyle_DiagonalCrossedLines

 

 

Remarks

 

Restrictions

 

See also

 

Examples