CanvasGetClipRect
int CanvasGetClipRect (int panelHandle, int controlID, Rect *clipRect);
Purpose
Obtains the current clipping rectangle for the canvas control. Canvas drawing operations do not extend beyond the clipping rectangle. Any drawing outside the clipping rectangle is not shown. The exception is CanvasClear, which is not limited to the clipping rectangle.
Supported Controls
You can use CanvasGetClipRect with canvas controls.
Parameters
| Input | ||
| Name | Type | Description |
| panelHandle | int | Specifier for a particular panel that is currently in memory. You can obtain this handle from functions such as LoadPanel and NewPanel. |
| controlID | int | The defined constant, located in the .uir header file, that you assigned to the control in the User Interface Editor, or the ID returned by functions such as NewCtrl and DuplicateCtrl. |
| Output | ||
| Name | Type | Description |
| clipRect | Rect | Rect structure that contains the location and size of the current clipping area. If clipping is disabled (the default state), the function sets the height and width values in the structure to zero. The Rect structure is defined as follows: typedef struct { int top; int left; int height; int width; } Rect; |
Return Value
| Name | Type | Description |
| status | int | Return value indicating whether the function was successful. A negative number indicates that an error occurred. |
Additional Information
Library: User Interface Library
Include file: userint.h
LabWindows/CVI compatibility: LabWindows/CVI 4.0 and later