Difference between revisions of "gc:clipRect"

From Inspired-Lua Wiki
Jump to navigation Jump to search
Line 28: Line 28:
 
* '''reset'''        sets the clipping rectangle to include the entire window. The remaining parameters is ignored and can be left out.
 
* '''reset'''        sets the clipping rectangle to include the entire window. The remaining parameters is ignored and can be left out.
 
* '''set'''            sets the clipping rectangle to the x, y coordinates with the specified width and height. The remaining parameters default to the system window location and size.
 
* '''set'''            sets the clipping rectangle to the x, y coordinates with the specified width and height. The remaining parameters default to the system window location and size.
* '''intersect'''  sets the clipping rectangle to the intersection of the current clipping rectangle with the rectangle specified in the routine parameters.
+
* '''intersect'''  sets the clipping rectangle to the intersection of the current clipping rectangle with the rectangle specified in the routine parameters. <u>It has been Removed in platform.apilevel = 2.0 (OS 3.2)</u>
 
* '''null'''          sets the clipping rectangle to empty. All subsequent graphics commands will be ignored.
 
* '''null'''          sets the clipping rectangle to empty. All subsequent graphics commands will be ignored.
 
Typically the “set” operation is called before drawing, say, a text string. It is important to call the “reset” operation after drawing the last clipped graphic so that you don’t leave a lingering clipping rectangle as a side effect.
 
Typically the “set” operation is called before drawing, say, a text string. It is important to call the “reset” operation after drawing the last clipped graphic so that you don’t leave a lingering clipping rectangle as a side effect.

Revision as of 15:05, 10 June 2012

clipRect is a function that is part of gc.

Sets the clipping rectangle for subsequent graphics operations.


This has been introduced in TI-Nspire OS 3.0 (Changes).


Syntax

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

Parameter Type Description
op
string Can either be "set", "intersect", "reset", or "null"
x
number x coordinate
y
number y coordinate
width
number the width of the rectangle
height
number the height of the rectangle


Details about the "op" parameter : Parameter op takes one of the strings “set”, “reset”, “intersect”, or “null”.

  • reset sets the clipping rectangle to include the entire window. The remaining parameters is ignored and can be left out.
  • set sets the clipping rectangle to the x, y coordinates with the specified width and height. The remaining parameters default to the system window location and size.
  • intersect sets the clipping rectangle to the intersection of the current clipping rectangle with the rectangle specified in the routine parameters. It has been Removed in platform.apilevel = 2.0 (OS 3.2)
  • null sets the clipping rectangle to empty. All subsequent graphics commands will be ignored.

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

Example

gc:clipRect("set", 20, 20, 50, 10)