Topic       : The ATARI Compendium
Author      : Scott Sanders / JAY Software
Version     : 1.25 (20/6/2003)
Subject     : Documentation
Nodes       : 1117
Index Size  : 32614
HCP-Version : 6
Compiled on : Atari
@charset    : UTF-8
@lang       : en
@default    : 
@help       : %About
@options    : +g -i -t4 +y +z
@width      : 100
View Ref-Filevrq_locator()
vsin_mode()
vsm_locator()                                                           VDI

Syntax

WORD vsm_locator( handle, mx, my, xout, yout, term )
WORD handle, mx, my;
WORD *xout, *yout, *term;

Function      vsm_locator() receives data from the 'locator' device in
              sample mode.

Opcode        28

Availability  This call is not guaranteed to be available with any driver
              and its use should therefore be restricted.

Parameters    handle specifies a valid workstation handle. The mouse
              pointer is initially drawn at location ( mx, my ). The call
              returns with the final position of the mouse in the WORDs
              pointed to by xout and yout. The WORD pointed to by term will
              be filled in with a value which specifies the ASCII value of
              the key pressed. term will be set to 0x20 if the left mouse
              button was pressed or 0x21 if the right mouse button was
              pressed.

Binding       contrl[0] = 28;
              contrl[1] = 1;
              contrl[3] = 0;
              contrl[6] = handle;

              ptsin[0] = mx;
              ptsin[1] = my;

              vdi();

              *xout = ptsout[0];
              *yout = ptsout[1];

              *term = intout[0];

              return ((contrl[4] << 1) | contrl[2]);

Return Value  vsm_locator() returns one of the following based on its
              result:

              Return               Meaning
              Value

                0     Mouse has not moved nor was any key pressed.

                1     Mouse has been moved (xout and yout are valid).

                2     Key or mouse button has been struck (term is valid).

                3     Mouse has moved and a key or mouse button has been
                      struck (xout, yout, and term are valid).

Caveats       Using this call will confuse the AES.

See Also      vrq_locator(), vsin_mode()

Group         VDI Input