initial commit
[fifth.git] / doc / modules / drvmouse.txt
1                         Mouse driver\r
2                         ------------\r
3 \r
4 mousex  var     Mouse x coordinate.\r
5 mousey  var     Mouse y coordinate.\r
6 mousekeyl var   Mouse left key.\r
7 mousekeym var   Mouse middle key.\r
8 mousekeyr var   Mouse right key.\r
9 mousec  var     Display current mouse coordinates in top left part of screen,\r
10                 if true. (good for debugging)\r
11 mousepointer var  Image buffer, holding current mouse pointer.\r
12 mouseadd        ( ModuleAddr x1 x2 y1 y2 -- ) Add specified area on screen,\r
13                 into mause click buffer. If any mouse button is clicked on\r
14                 that area, module at "ModuleAddr" will be executed.\r
15 mousebe var     Amount of buffer elements.\r
16 mousedo         ( -- ) Updates mouse coordinates and keys. Parse mouse\r
17                 click buffer, and draw mouse cursor to "screen".\r