ncurses_getmouse

Reads mouse event

&reftitle.description; `bool` `ncurses_getmouse` `array` `mevent` &warn.experimental.func;

`ncurses_getmouse` reads mouse event out of queue.

&reftitle.parameters;

`mevent`

- Event options will be delivered in this parameter which has to be an array, passed by reference (see example below).

  On success an associative array with following keys will be delivered:

  - "id" : Id to distinguish multiple devices

  - "x" : screen relative x-position in character cells

  - "y" : screen relative y-position in character cells

  - "z" : currently not supported

  - "mmask" : Mouse action

&reftitle.returnvalues;

Returns &false; if a mouse event is actually visible in the given window, otherwise returns &true;.

&reftitle.examples;

### `ncurses_getmouse` example

    <?php
    switch (ncurses_getch()){
      case NCURSES_KEY_MOUSE:
        if (!ncurses_getmouse($mevent)){
          if ($mevent["mmask"] & NCURSES_MOUSE_BUTTON1_PRESSED){
            $mouse_x = $mevent["x"]; // Save mouse position
            $mouse_y = $mevent["y"];
          }
        }
      break;

      default:
        /* .... */
    }
    ?>

&reftitle.seealso;

- `ncurses_ungetmouse`