get_clip_cursor


bool get_clip_cursor(rectangle* bounds)

This function obtains the rectangle to which the cursor is clipped.

Parameters

rectangle* bounds

A pointer to a rectangle that is updated to contain the screen coordinates of the cursor's clipping rectangle. If no clipping rectangle exists, the dimensions of the screen are returned.

Return

bool

true The function succeeded.
false The function failed.

Notes

Because the cursor is a resource that is shared amongst applications, the cursor clipping rectangle should be released using the function clip_cursor prior to the application relinquishing control.