You are here: Lua Scripting Resources eGuide > Lua Scripting API Reference Guide > Graphics Library > clipRect

9.1 clipRect

gc:clipRect(op[, x, [y, [width, [height]]]])

Sets the clipping rectangle for subsequent graphics operations.

Parameter op takes one of the strings “set,” “reset,” “intersect,” or “null”.

Operation

Description

reset

Sets the clipping rectangle to include the entire window. The remaining parameters are ignored and can be left out.

set

Sets the clipping rectangle to the x, y coordinates with the specified width and height. Unspecified parameters default to the system window location and size.

intersect

Removed in platform.apilevel = ‘2.0’.

null

Sets the clipping rectangle to empty. All subsequent graphics commands are ignored.


Typically the “set” operation is called before drawing, such as for a text string. It is important to call the “reset” operation after drawing the last clipped graphic so that you do not leave a lingering clipping rectangle as a side effect.

Introduced in platform.apiLevel = '1.0'