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

Canvas_BitmapRender

Previous pageReturn to chapter overviewNext page

 

Description

 

Render an image on the selected canvas target..

 

Syntax

 

n = Canvas_BitmapRender(BitmapFileName [, X1, Y1 [, X2, Y2]])

 

Returns

 

Number.

Zero = no errors

 

Parameters

 

Name

Type

Optional

Meaning

BitmapFileName

String

No

Full path of a bitmap file

X1

Number

Yes

X coordinate of the upper left corner of the destination rectangle

Y1

Number

Yes

Y coordinate of the upper left corner of the destination rectangle

X2

Number

Yes

X coordinate of the lower right corner of the destination rectangle

Y2

Number

Yes

Y coordinate of the lower right corner of the destination rectangle

 

Remarks

 

If the destination rectangle is larger or smaller than the original image size, the image is stretched or shrunk to the requested size.

 

Restrictions

 

If X1-Y1 pairs are missed, current canvas location will be assumed.

If X2-Y2 pairs are missed, current image width-height will be assumed.

 

See also

 

Examples